kim-api
2.1.1+v2.1.1.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators. More...
#include <KIM_ComputeArguments.hpp>
Public Member Functions | |
int | GetArgumentSupportStatus (ComputeArgumentName const computeArgumentName, SupportStatus *const supportStatus) const |
Get the SupportStatus of a ComputeArgumentName. More... | |
int | GetCallbackSupportStatus (ComputeCallbackName const computeCallbackName, SupportStatus *const supportStatus) const |
Get the SupportStatus of a ComputeCallbackName. More... | |
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, int const *const ptr) |
Set the data pointer for a ComputeArgumentName. More... | |
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, int *const ptr) |
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, double const *const ptr) |
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, double *const ptr) |
int | SetCallbackPointer (ComputeCallbackName const computeCallbackName, LanguageName const languageName, Function *const fptr, void *const dataObject) |
Set the function pointer for a ComputeCallbackName. More... | |
void | AreAllRequiredArgumentsAndCallbacksPresent (int *const result) const |
Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required. More... | |
void | SetSimulatorBufferPointer (void *const ptr) |
Set the Simulator's buffer pointer within the ComputeArguments object. More... | |
void | GetSimulatorBufferPointer (void **const ptr) const |
Get the Simulator's buffer pointer from the ComputeArguments object. More... | |
std::string const & | ToString () const |
Get a string representing the internal state of the ComputeArguments object. More... | |
void | SetLogID (std::string const &logID) |
Set the identity of the Log object associated with the ComputeArguments object. More... | |
void | PushLogVerbosity (LogVerbosity const logVerbosity) |
Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack. More... | |
void | PopLogVerbosity () |
Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack. More... | |
Friends | |
class | ModelImplementation |
Allows Model objects to directly access private member data of a ComputeArguments object. More... | |
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators.
Definition at line 62 of file KIM_ComputeArguments.hpp.
void KIM::ComputeArguments::AreAllRequiredArgumentsAndCallbacksPresent | ( | int *const | result | ) | const |
Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required.
[out] | result | Is true if all such arguments and callbacks have non-NULL pointers, and is false otherwise. |
int KIM::ComputeArguments::GetArgumentSupportStatus | ( | ComputeArgumentName const | computeArgumentName, |
SupportStatus *const | supportStatus | ||
) | const |
Get the SupportStatus of a ComputeArgumentName.
[in] | computeArgumentName | The ComputeArgumentName of interest. |
[out] | supportStatus | The Model's corresponding SupportStatus. |
true
if computeArgumentName
is unknown. false
otherwise.int KIM::ComputeArguments::GetCallbackSupportStatus | ( | ComputeCallbackName const | computeCallbackName, |
SupportStatus *const | supportStatus | ||
) | const |
Get the SupportStatus of a ComputeCallbackName.
[in] | computeCallbackName | The ComputeCallbackName of interest. |
[out] | supportStatus | The Model's corresponding SupportStatus. |
true
if computeCallbackName
is unknown. false
otherwise.void KIM::ComputeArguments::GetSimulatorBufferPointer | ( | void **const | ptr | ) | const |
Get the Simulator's buffer pointer from the ComputeArguments object.
[out] | ptr | The simulator buffer data pointer. |
ptr == NULL
if the simulator has not previously called ComputeArguments::SetSimulatorBufferPointer.void KIM::ComputeArguments::PopLogVerbosity | ( | ) |
Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack.
void KIM::ComputeArguments::PushLogVerbosity | ( | LogVerbosity const | logVerbosity | ) |
Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack.
[in] | logVerbosity | A LogVerbosity value. |
int KIM::ComputeArguments::SetArgumentPointer | ( | ComputeArgumentName const | computeArgumentName, |
int const *const | ptr | ||
) |
Set the data pointer for a ComputeArgumentName.
[in] | computeArgumentName | The ComputeArgumentName of interest. |
[in] | ptr | The data pointer. |
true
if computeArgumentName
is unknown. true
if ptr != NULL
and computeArgumentName == SUPPORT_STATUS::notSupported
. false
otherwise.int KIM::ComputeArguments::SetArgumentPointer | ( | ComputeArgumentName const | computeArgumentName, |
int *const | ptr | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int KIM::ComputeArguments::SetArgumentPointer | ( | ComputeArgumentName const | computeArgumentName, |
double const *const | ptr | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int KIM::ComputeArguments::SetArgumentPointer | ( | ComputeArgumentName const | computeArgumentName, |
double *const | ptr | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int KIM::ComputeArguments::SetCallbackPointer | ( | ComputeCallbackName const | computeCallbackName, |
LanguageName const | languageName, | ||
Function *const | fptr, | ||
void *const | dataObject | ||
) |
Set the function pointer for a ComputeCallbackName.
[in] | computeCallbackName | The ComputeCallbackName of interest. |
[in] | languageName | The LanguageName of the callback. |
[in] | fptr | The function pointer. |
[in] | dataObject | The data pointer associated with the callback. |
true
if computeCallbackName
is unknown. true
if fptr != NULL
and computeCallbackName == SUPPORT_STATUS::notSupported
. false
otherwise.void KIM::ComputeArguments::SetLogID | ( | std::string const & | logID | ) |
Set the identity of the Log object associated with the ComputeArguments object.
[in] | logID | String identifying the ComputeArguments object's Log object. |
void KIM::ComputeArguments::SetSimulatorBufferPointer | ( | void *const | ptr | ) |
Set the Simulator's buffer pointer within the ComputeArguments object.
The simulator buffer pointer may be used by the simulator to associate a memory buffer with the ComputeArguments object.
[in] | ptr | The simulator buffer data pointer. |
std::string const& KIM::ComputeArguments::ToString | ( | ) | const |
Get a string representing the internal state of the ComputeArguments object.
This string is primarily meant for use as a debugging tool. The string may be quite long. It begins and ends with lines consisting only of ='s
.
|
friend |
Allows Model objects to directly access private member data of a ComputeArguments object.
Definition at line 245 of file KIM_ComputeArguments.hpp.