kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelWriteParameterizedModel.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_WRITE_PARAMETERIZED_MODEL_HPP_
35 #define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_HPP_
36 
37 #include <sstream>
38 #include <string>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class ModelWriteParameterizedModelImplementation;
45 
46 
56 {
57  public:
67  void GetPath(std::string const ** const path) const;
68 
80  void GetModelName(std::string const ** const modelName) const;
81 
94  void SetParameterFileName(std::string const & fileName) const;
95 
112  void GetModelBufferPointer(void ** const ptr) const;
113 
129  void LogEntry(LogVerbosity const logVerbosity,
130  std::string const & message,
131  int const lineNumber,
132  std::string const & fileName) const;
133 
135  void LogEntry(LogVerbosity const logVerbosity,
136  std::stringstream const & message,
137  int const lineNumber,
138  std::string const & fileName) const;
139 
150  std::string const & ToString() const;
151 
152  private:
153  // do not allow copy constructor or operator=
155  void operator=(ModelWriteParameterizedModel const &);
156 
159 
160  ModelWriteParameterizedModelImplementation * pimpl;
161 }; // class ModelWriteParameterizedModel
162 } // namespace KIM
163 
164 #endif // KIM_MODEL_WRITE_PARAMETERIZED_MODEL_HPP_
void GetPath(std::string const **const path) const
Get the directory path where the parameterized model files should be written.
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.
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::W...
void GetModelBufferPointer(void **const ptr) const
Get the Model&#39;s buffer pointer within the Model object.
An Extensible Enumeration for the LogVerbosity&#39;s supported by the KIM API.
std::string const & ToString() const
Get a string representing the internal state of the Model object.
void GetModelName(std::string const **const modelName) const
Get the name of the new parameterized model.
void SetParameterFileName(std::string const &fileName) const
Set the file name for the next parameter file.