kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Provides the interface to a KIM API ComputeArguments object for use by models within their MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine. More...
#include <KIM_ModelComputeArgumentsCreate.hpp>
Public Member Functions | |
int | SetArgumentSupportStatus (ComputeArgumentName const computeArgumentName, SupportStatus const supportStatus) |
Set the SupportStatus of a ComputeArgumentName. More... | |
int | SetCallbackSupportStatus (ComputeCallbackName const computeCallbackName, SupportStatus const supportStatus) |
Set the SupportStatus of a ComputeCallbackName. More... | |
void | SetModelBufferPointer (void *const ptr) |
Set the Model's buffer pointer within the ComputeArguments object. More... | |
void | LogEntry (LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const |
Write a log entry into the log file. More... | |
void | LogEntry (LogVerbosity const logVerbosity, std::stringstream const &message, int const lineNumber, std::string const &fileName) const |
std::string const & | ToString () const |
Get a string representing the internal state of the ComputeArguments object. More... | |
Provides the interface to a KIM API ComputeArguments object for use by models within their MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine.
Definition at line 55 of file KIM_ModelComputeArgumentsCreate.hpp.
void KIM::ModelComputeArgumentsCreate::LogEntry | ( | LogVerbosity const | logVerbosity, |
std::string const & | message, | ||
int const | lineNumber, | ||
std::string const & | fileName | ||
) | const |
Write a log entry into the log file.
This results in a no-op if logVerbosity
is LOG_VERBOSITY::silent or if logVerbosity
is greater-than the Log object's top LogVerbosity on its stack.
[in] | logVerbosity | The LogVerbosity level for the entry. |
[in] | message | The body text of the log entry. |
[in] | lineNumber | The source code file line number. |
[in] | fileName | The source code file name. |
void KIM::ModelComputeArgumentsCreate::LogEntry | ( | LogVerbosity const | logVerbosity, |
std::stringstream const & | message, | ||
int const | lineNumber, | ||
std::string const & | fileName | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int KIM::ModelComputeArgumentsCreate::SetArgumentSupportStatus | ( | ComputeArgumentName const | computeArgumentName, |
SupportStatus const | supportStatus | ||
) |
Set the SupportStatus of a ComputeArgumentName.
[in] | computeArgumentName | The ComputeArgumentName of interest. |
[in] | supportStatus | The corresponding SupportStatus. |
true
if computeArgumentName
is unknown. true
if computeArgumentName
is SUPPORT_STATUS::requiredByAPI and supportStatus
is not SUPPORT_STATUS::requiredByAPI. false
otherwise.int KIM::ModelComputeArgumentsCreate::SetCallbackSupportStatus | ( | ComputeCallbackName const | computeCallbackName, |
SupportStatus const | supportStatus | ||
) |
Set the SupportStatus of a ComputeCallbackName.
[in] | computeCallbackName | The ComputeCallbackName of interest. |
[in] | supportStatus | The corresponding SupportStatus. |
true
if computeCallbackName
is unknown. true
if computeCallbackName
is SUPPORT_STATUS::requiredByAPI and supportStatus
is not SUPPORT_STATUS::requiredByAPI. false
otherwise.void KIM::ModelComputeArgumentsCreate::SetModelBufferPointer | ( | void *const | ptr | ) |
Set the Model's buffer pointer within the ComputeArguments object.
The model buffer pointer may be used by the model to associate a memory buffer with the ComputeArguments object.
[in] | ptr | The model buffer data pointer. |
std::string const& KIM::ModelComputeArgumentsCreate::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
.