KIM API V2
KIM_ComputeArguments.h
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 */
5 /* Development 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 */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2018, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api-v2.0.0-beta.1 package. */
33 /* */
34 
35 
36 #ifndef KIM_COMPUTE_ARGUMENTS_H_
37 #define KIM_COMPUTE_ARGUMENTS_H_
38 
39 #ifndef KIM_FUNC_H_
40 #include "KIM_func.h"
41 #endif
42 
43 /* Forward declarations */
44 #ifndef KIM_LOG_VERBOSITY_DEFINED_
45 #define KIM_LOG_VERBOSITY_DEFINED_
47 #endif
48 
49 #ifndef KIM_LANGUAGE_NAME_DEFINED_
50 #define KIM_LANGUAGE_NAME_DEFINED_
52 #endif
53 
54 #ifndef KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
55 #define KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
57 #endif
58 
59 #ifndef KIM_COMPUTE_CALLBACK_NAME_DEFINED_
60 #define KIM_COMPUTE_CALLBACK_NAME_DEFINED_
62 #endif
63 
64 #ifndef KIM_SUPPORT_STATUS_DEFINED_
65 #define KIM_SUPPORT_STATUS_DEFINED_
67 #endif
68 
69 
71 
72 #ifndef KIM_COMPUTE_ARGUMENTS_DEFINED_
73 #define KIM_COMPUTE_ARGUMENTS_DEFINED_
75 #endif
76 
78  KIM_ComputeArguments const * const computeArguments,
79  KIM_ComputeArgumentName const computeArgumentName,
80  KIM_SupportStatus * const supportStatus);
82  KIM_ComputeArguments const * const computeArguments,
83  KIM_ComputeCallbackName const computeCallbackName,
84  KIM_SupportStatus * const supportStatus);
85 
87  KIM_ComputeArguments * const computeArguments,
88  KIM_ComputeArgumentName const computeArgumentName,
89  int const * const ptr);
91  KIM_ComputeArguments * const computeArguments,
92  KIM_ComputeArgumentName const computeArgumentName,
93  double const * const ptr);
94 
96  KIM_ComputeArguments * const computeArguments,
97  KIM_ComputeCallbackName const computeCallbackName,
98  KIM_LanguageName const languageName,
99  func * const fptr,
100  void const * const dataObject);
101 
103  KIM_ComputeArguments const * const computeArguments,
104  int * const result);
105 
107  KIM_ComputeArguments * const computeArguments,
108  void * const ptr);
110  KIM_ComputeArguments const * const computeArguments,
111  void ** const ptr);
112 
113 char const * const KIM_ComputeArguments_String(
114  KIM_ComputeArguments const * const computeArguments);
115 
117  KIM_ComputeArguments * const computeArguments,
118  char const * const logID);
120  KIM_ComputeArguments * const computeArguments,
121  KIM_LogVerbosity const logVerbosity);
123  KIM_ComputeArguments * const computeArguments);
124 
125 #endif /* KIM_COMPUTE_ARGUMENTS_H_ */
struct KIM_ComputeArguments KIM_ComputeArguments
void KIM_ComputeArguments_PopLogVerbosity(KIM_ComputeArguments *const computeArguments)
void KIM_ComputeArguments_PushLogVerbosity(KIM_ComputeArguments *const computeArguments, KIM_LogVerbosity const logVerbosity)
int KIM_ComputeArguments_GetCallbackSupportStatus(KIM_ComputeArguments const *const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus *const supportStatus)
void KIM_ComputeArguments_GetSimulatorBufferPointer(KIM_ComputeArguments const *const computeArguments, void **const ptr)
int KIM_ComputeArguments_SetCallbackPointer(KIM_ComputeArguments *const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_LanguageName const languageName, func *const fptr, void const *const dataObject)
char const *const KIM_ComputeArguments_String(KIM_ComputeArguments const *const computeArguments)
int KIM_ComputeArguments_SetArgumentPointerInteger(KIM_ComputeArguments *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, int const *const ptr)
void KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent(KIM_ComputeArguments const *const computeArguments, int *const result)
void KIM_ComputeArguments_SetLogID(KIM_ComputeArguments *const computeArguments, char const *const logID)
void() func()
Definition: KIM_func.h:39
int KIM_ComputeArguments_SetArgumentPointerDouble(KIM_ComputeArguments *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, double const *const ptr)
void KIM_ComputeArguments_SetSimulatorBufferPointer(KIM_ComputeArguments *const computeArguments, void *const ptr)
int KIM_ComputeArguments_GetArgumentSupportStatus(KIM_ComputeArguments const *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus *const supportStatus)