kim-api  2.3.0+v2.3.0.GNU.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 // KIM-API: An API for interatomic models
3 // Copyright (c) 2013--2022, Regents of the University of Minnesota.
4 // All rights reserved.
5 //
6 // Contributors:
7 // Ryan S. Elliott
8 //
9 // SPDX-License-Identifier: LGPL-2.1-or-later
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public License
22 // along with this library; if not, write to the Free Software Foundation,
23 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 //
25 
26 //
27 // Release: This file is part of the kim-api-2.3.0 package.
28 //
29 
30 
31 #ifndef KIM_MODEL_WRITE_PARAMETERIZED_MODEL_HPP_
32 #define KIM_MODEL_WRITE_PARAMETERIZED_MODEL_HPP_
33 
34 #include <sstream>
35 #include <string>
36 
37 namespace KIM
38 {
39 // Forward declarations
40 class LogVerbosity;
41 class ModelWriteParameterizedModelImplementation;
42 
43 
53 {
54  public:
64  void GetPath(std::string const ** const path) const;
65 
77  void GetModelName(std::string const ** const modelName) const;
78 
91  void SetParameterFileName(std::string const & fileName) const;
92 
109  void GetModelBufferPointer(void ** const ptr) const;
110 
126  void LogEntry(LogVerbosity const logVerbosity,
127  std::string const & message,
128  int const lineNumber,
129  std::string const & fileName) const;
130 
132  void LogEntry(LogVerbosity const logVerbosity,
133  std::stringstream const & message,
134  int const lineNumber,
135  std::string const & fileName) const;
136 
147  std::string const & ToString() const;
148 
149  private:
150  // do not allow copy constructor or operator=
152  void operator=(ModelWriteParameterizedModel const &);
153 
156 
157  ModelWriteParameterizedModelImplementation * pimpl;
158 }; // class ModelWriteParameterizedModel
159 } // namespace KIM
160 
161 #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.