kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelDestroy.hpp
Go to the documentation of this file.
1 //
2 // CDDL HEADER START
3 //
4 // The contents of this file are subject to the terms of the Common Development
5 // and Distribution License Version 1.0 (the "License").
6 //
7 // You can obtain a copy of the license at
8 // http://www.opensource.org/licenses/CDDL-1.0. See the License for the
9 // specific language governing permissions and limitations under the License.
10 //
11 // When distributing Covered Code, include this CDDL HEADER in each file and
12 // include the License file in a prominent location with the name LICENSE.CDDL.
13 // If applicable, add the following below this CDDL HEADER, with the fields
14 // enclosed by brackets "[]" replaced with your own identifying information:
15 //
16 // Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 //
18 // CDDL HEADER END
19 //
20 
21 //
22 // Copyright (c) 2016--2019, Regents of the University of Minnesota.
23 // All rights reserved.
24 //
25 // Contributors:
26 // Ryan S. Elliott
27 //
28 
29 //
30 // Release: This file is part of the kim-api.git repository.
31 //
32 
33 
34 #ifndef KIM_MODEL_DESTROY_HPP_
35 #define KIM_MODEL_DESTROY_HPP_
36 
37 #include <sstream>
38 #include <string>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class ModelDestroyImplementation;
45 
46 
55 {
56  public:
73  void GetModelBufferPointer(void ** const ptr) const;
74 
89  void LogEntry(LogVerbosity const logVerbosity,
90  std::string const & message,
91  int const lineNumber,
92  std::string const & fileName) const;
93 
95  void LogEntry(LogVerbosity const logVerbosity,
96  std::stringstream const & message,
97  int const lineNumber,
98  std::string const & fileName) const;
99 
109  std::string const & ToString() const;
110 
111  private:
112  // do not allow copy constructor or operator=
113  ModelDestroy(ModelDestroy const &);
114  void operator=(ModelDestroy const &);
115 
116  ModelDestroy();
117  ~ModelDestroy();
118 
119  ModelDestroyImplementation * pimpl;
120 }; // class ModelDestroy
121 } // namespace KIM
122 
123 #endif // KIM_MODEL_DESTROY_HPP_
void GetModelBufferPointer(void **const ptr) const
Get the Model&#39;s buffer pointer within the Model object.
std::string const & ToString() const
Get a string representing the internal state of the Model object.
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::D...
An Extensible Enumeration for the LogVerbosity&#39;s supported by the KIM API.
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
Write a log entry into the log file.