KIM API V2
KIM_ComputeArguments.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_COMPUTE_ARGUMENTS_HPP_
35 #define KIM_COMPUTE_ARGUMENTS_HPP_
36 
37 #include <string>
38 
39 #ifndef KIM_FUNC_HPP_
40 #include "KIM_func.hpp"
41 #endif
42 
43 namespace KIM
44 {
45 // Forward declarations
46 class LogVerbosity;
47 class LanguageName;
48 class ComputeArgumentName;
49 class ComputeCallbackName;
50 class SupportStatus;
51 class ModelImplementation;
52 class ComputeArgumentsImplementation;
53 
54 
56 {
57  public:
58  int GetArgumentSupportStatus(ComputeArgumentName const computeArgumentName,
59  SupportStatus * const supportStatus) const;
60  int GetCallbackSupportStatus(ComputeCallbackName const computeCallbackName,
61  SupportStatus * const supportStatus) const;
62 
63 
64  int SetArgumentPointer(ComputeArgumentName const computeArgumentName,
65  int const * const ptr);
66  int SetArgumentPointer(ComputeArgumentName const computeArgumentName,
67  int * const ptr);
68  int SetArgumentPointer(ComputeArgumentName const computeArgumentName,
69  double const * const ptr);
70  int SetArgumentPointer(ComputeArgumentName const computeArgumentName,
71  double * const ptr);
72 
73  int SetCallbackPointer(ComputeCallbackName const computeCallbackName,
74  LanguageName const languageName,
75  func * const fptr,
76  void const * const dataObject);
77 
78  void AreAllRequiredArgumentsAndCallbacksPresent(int * const result) const;
79 
80  void SetSimulatorBufferPointer(void * const ptr);
81  void GetSimulatorBufferPointer(void ** const ptr) const;
82 
83  std::string const & String() const;
84 
85  void SetLogID(std::string const & logID);
86  void PushLogVerbosity(LogVerbosity const logVerbosity);
87  void PopLogVerbosity();
88 
89  friend class ModelImplementation;
90  private:
91  // do not allow copy constructor or operator=
93  void operator=(ComputeArguments const &);
94 
97 
98  ComputeArgumentsImplementation * pimpl;
99 }; // class ComputeArguments
100 } // namespace KIM
101 #endif // KIM_COMPUTE_ARGUMENTS_HPP_
int SetArgumentPointer(ComputeArgumentName const computeArgumentName, int const *const ptr)
void SetSimulatorBufferPointer(void *const ptr)
std::string const & String() const
void AreAllRequiredArgumentsAndCallbacksPresent(int *const result) const
void PushLogVerbosity(LogVerbosity const logVerbosity)
int GetCallbackSupportStatus(ComputeCallbackName const computeCallbackName, SupportStatus *const supportStatus) const
int GetArgumentSupportStatus(ComputeArgumentName const computeArgumentName, SupportStatus *const supportStatus) const
int SetCallbackPointer(ComputeCallbackName const computeCallbackName, LanguageName const languageName, func *const fptr, void const *const dataObject)
void GetSimulatorBufferPointer(void **const ptr) const
void SetLogID(std::string const &logID)
void() func()
Definition: KIM_func.hpp:40