31#ifndef KIM_COMPUTE_ARGUMENTS_HPP_
32#define KIM_COMPUTE_ARGUMENTS_HPP_
36#ifndef KIM_FUNCTION_TYPES_HPP_
45class ComputeArgumentName;
46class ComputeCallbackName;
48class ComputeArgumentsImplementation;
110 int const *
const ptr);
118 double const *
const ptr);
146 void *
const dataObject);
251 ComputeArgumentsImplementation * pimpl;
An Extensible Enumeration for the ComputeArgumentName's supported by the KIM API.
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simula...
int SetArgumentPointer(ComputeArgumentName const computeArgumentName, int const *const ptr)
Set the data pointer for a ComputeArgumentName.
void PushLogVerbosity(LogVerbosity const logVerbosity)
Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack.
int SetArgumentPointer(ComputeArgumentName const computeArgumentName, double const *const ptr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
int SetArgumentPointer(ComputeArgumentName const computeArgumentName, double *const ptr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
void PopLogVerbosity()
Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack.
int GetCallbackSupportStatus(ComputeCallbackName const computeCallbackName, SupportStatus *const supportStatus) const
Get the SupportStatus of a ComputeCallbackName.
void AreAllRequiredArgumentsAndCallbacksPresent(int *const result) const
Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's ...
friend class ModelImplementation
Allows Model objects to directly access private member data of a ComputeArguments object.
int SetArgumentPointer(ComputeArgumentName const computeArgumentName, int *const ptr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
void GetSimulatorBufferPointer(void **const ptr) const
Get the Simulator's buffer pointer from the ComputeArguments object.
int SetCallbackPointer(ComputeCallbackName const computeCallbackName, LanguageName const languageName, Function *const fptr, void *const dataObject)
Set the function pointer for a ComputeCallbackName.
std::string const & ToString() const
Get a string representing the internal state of the ComputeArguments object.
void SetSimulatorBufferPointer(void *const ptr)
Set the Simulator's buffer pointer within the ComputeArguments object.
void SetLogID(std::string const &logID)
Set the identity of the Log object associated with the ComputeArguments object.
int GetArgumentSupportStatus(ComputeArgumentName const computeArgumentName, SupportStatus *const supportStatus) const
Get the SupportStatus of a ComputeArgumentName.
An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API.
An Extensible Enumeration for the LanguageName's supported by the KIM API.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
An Extensible Enumeration for the SupportStatus's supported by the KIM API.
void() Function(void)
Generic function type.