kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Typedefs | Functions | Variables
KIM_ModelRoutineName.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  KIM_ModelRoutineName
 An Extensible Enumeration for the ModelRoutineName's supported by the KIM API. More...
 

Typedefs

typedef struct KIM_ModelRoutineName KIM_ModelRoutineName
 Convenience typedef. More...
 

Functions

KIM_ModelRoutineName KIM_ModelRoutineName_FromString (char const *const str)
 Create a ModelRoutineName object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...
 
int KIM_ModelRoutineName_Known (KIM_ModelRoutineName const modelRoutineName)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_ModelRoutineName_Equal (KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
 Compares ModelRoutineName objects for equality. More...
 
int KIM_ModelRoutineName_NotEqual (KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
 Compares ModelRoutineName objects for inequality. More...
 
char const * KIM_ModelRoutineName_ToString (KIM_ModelRoutineName const modelRoutineName)
 Converts the object to a string. More...
 
void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames (int *const numberOfModelRoutineNames)
 Get the number of standard ModelRoutineName's defined by the KIM API. More...
 
int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName (int const index, KIM_ModelRoutineName *const modelRoutineName)
 Get the identity of each defined standard ModelRoutineName. More...
 

Variables

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create
 The standard Create routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate
 The standard ComputeArgumentsCreate routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute
 The standard Compute routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension
 The standard Extension routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh
 The standard Refresh routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel
 The standard WriteParameterizedModel routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy
 The standard ComputeArgumentsDestroy routine. More...
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy
 The standard Destroy routine. More...
 

Typedef Documentation

◆ KIM_ModelRoutineName

Convenience typedef.

Since
2.0

Definition at line 67 of file KIM_ModelRoutineName.h.

Function Documentation

◆ KIM_MODEL_ROUTINE_NAME_GetModelRoutineName()

int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName ( int const  index,
KIM_ModelRoutineName *const  modelRoutineName 
)

Get the identity of each defined standard ModelRoutineName.

See also
KIM::MODEL_ROUTINE_NAME::GetModelRoutineName, kim_model_routine_name_module::kim_get_model_routine_name
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames()

void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames ( int *const  numberOfModelRoutineNames)

Get the number of standard ModelRoutineName's defined by the KIM API.

See also
KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames, kim_model_routine_name_module::kim_get_number_of_model_routine_names
Since
2.0

◆ KIM_ModelRoutineName_Equal()

int KIM_ModelRoutineName_Equal ( KIM_ModelRoutineName const  lhs,
KIM_ModelRoutineName const  rhs 
)

Compares ModelRoutineName objects for equality.

See also
KIM::ModelRoutineName::operator==(), kim_model_routine_name_module::operator(.eq.)
Since
2.0

◆ KIM_ModelRoutineName_FromString()

KIM_ModelRoutineName KIM_ModelRoutineName_FromString ( char const *const  str)

Create a ModelRoutineName object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also
KIM::ModelRoutineName::ModelRoutineName(std::string const &), kim_model_routine_name_module::kim_from_string
Since
2.0

◆ KIM_ModelRoutineName_Known()

int KIM_ModelRoutineName_Known ( KIM_ModelRoutineName const  modelRoutineName)

Determines if the object is a quantity known to the KIM API.

See also
KIM::ModelRoutineName::Known, kim_model_routine_name_module::kim_known
Since
2.0

◆ KIM_ModelRoutineName_NotEqual()

int KIM_ModelRoutineName_NotEqual ( KIM_ModelRoutineName const  lhs,
KIM_ModelRoutineName const  rhs 
)

Compares ModelRoutineName objects for inequality.

See also
KIM::ModelRoutineName::operator!=(), kim_model_routine_name_module::operator(.ne.)
Since
2.0

◆ KIM_ModelRoutineName_ToString()

char const* KIM_ModelRoutineName_ToString ( KIM_ModelRoutineName const  modelRoutineName)

Converts the object to a string.

See also
KIM::ModelRoutineName::ToString, kim_model_routine_name_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_MODEL_ROUTINE_NAME_Compute

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute

◆ KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate

◆ KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy

◆ KIM_MODEL_ROUTINE_NAME_Create

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create

◆ KIM_MODEL_ROUTINE_NAME_Destroy

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy

◆ KIM_MODEL_ROUTINE_NAME_Extension

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension

◆ KIM_MODEL_ROUTINE_NAME_Refresh

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh

◆ KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel