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_ModelComputeArgumentsCreate.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_COMPUTE_ARGUMENTS_CREATE_HPP_
35 #define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_HPP_
36 
37 #include <sstream>
38 #include <string>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class SupportStatus;
45 class ComputeArgumentName;
46 class ComputeCallbackName;
47 class ModelComputeArgumentsCreateImplementation;
48 
49 
59 {
60  public:
75  int SetArgumentSupportStatus(ComputeArgumentName const computeArgumentName,
76  SupportStatus const supportStatus);
77 
92  int SetCallbackSupportStatus(ComputeCallbackName const computeCallbackName,
93  SupportStatus const supportStatus);
94 
107  void SetModelBufferPointer(void * const ptr);
108 
124  void LogEntry(LogVerbosity const logVerbosity,
125  std::string const & message,
126  int const lineNumber,
127  std::string const & fileName) const;
128 
130  void LogEntry(LogVerbosity const logVerbosity,
131  std::stringstream const & message,
132  int const lineNumber,
133  std::string const & fileName) const;
134 
146  std::string const & ToString() const;
147 
148  private:
149  // do not allow copy constructor or operator=
151  void operator=(ModelComputeArgumentsCreate const &);
152 
155 
156  ModelComputeArgumentsCreateImplementation * pimpl;
157 }; // class ModelComputeArgumentsCreate
158 } // namespace KIM
159 
160 #endif // KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_HPP_
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.
int SetArgumentSupportStatus(ComputeArgumentName const computeArgumentName, SupportStatus const supportStatus)
Set the SupportStatus of a ComputeArgumentName.
An Extensible Enumeration for the ComputeCallbackName&#39;s supported by the KIM API. ...
An Extensible Enumeration for the SupportStatus&#39;s supported by the KIM API.
void SetModelBufferPointer(void *const ptr)
Set the Model&#39;s buffer pointer within the ComputeArguments 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 ComputeArguments object.
An Extensible Enumeration for the ComputeArgumentName&#39;s supported by the KIM API. ...
Provides the interface to a KIM API ComputeArguments object for use by models within their MODEL_ROUT...
int SetCallbackSupportStatus(ComputeCallbackName const computeCallbackName, SupportStatus const supportStatus)
Set the SupportStatus of a ComputeCallbackName.