KIM API V2
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--2018, 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-v2.0.0-beta.1 package.
31 //
32 
33 
34 #ifndef KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_HPP_
35 #define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_HPP_
36 
37 #include <string>
38 #include <sstream>
39 
40 #ifndef KIM_FUNC_HPP_
41 #include "KIM_func.hpp"
42 #endif
43 
44 
45 namespace KIM
46 {
47 // Forward declarations
48 class LogVerbosity;
49 class SupportStatus;
50 class ComputeArgumentName;
51 class ComputeCallbackName;
52 class ModelComputeArgumentsCreateImplementation;
53 
54 
56 {
57  public:
58  int SetArgumentSupportStatus(ComputeArgumentName const clomputeArgumentName,
59  SupportStatus const supportStatus);
60 
61  int SetCallbackSupportStatus(ComputeCallbackName const computeCallbackName,
62  SupportStatus const supportStatus);
63 
64  void SetModelBufferPointer(void * const ptr);
65 
66  void LogEntry(LogVerbosity const logVerbosity, std::string const & message,
67  int const lineNumber, std::string const & fileName) const;
68  void LogEntry(LogVerbosity const logVerbosity,
69  std::stringstream const & message,
70  int const lineNumber, std::string const & fileName) const;
71 
72  std::string const & String() const;
73 
74  private:
75  // do not allow copy constructor or operator=
77  void operator=(ModelComputeArgumentsCreate const &);
78 
81 
82  ModelComputeArgumentsCreateImplementation * pimpl;
83 }; // class ModelComputeArgumentsCreate
84 } // namespace KIM
85 #endif // KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_HPP_
std::string const & String() const
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
void SetModelBufferPointer(void *const ptr)
int SetArgumentSupportStatus(ComputeArgumentName const clomputeArgumentName, SupportStatus const supportStatus)
int SetCallbackSupportStatus(ComputeCallbackName const computeCallbackName, SupportStatus const supportStatus)