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 | Functions | Variables
KIM::SUPPORT_STATUS Namespace Reference

Contains the enumeration constants and the discovery routines for the SupportStatus Extensible Enumeration. More...

Classes

struct  Comparator
 Structure provided for use with std::map. More...
 

Functions

void GetNumberOfSupportStatuses (int *const numberOfSupportStatuses)
 Get the number of standard SupportStatus's defined by the KIM API. More...
 
int GetSupportStatus (int const index, SupportStatus *const supportStatus)
 Get the identity of each defined standard SupportStatus. More...
 

Variables

SupportStatus const requiredByAPI
 The standard requiredByAPI status. More...
 
SupportStatus const notSupported
 The standard notSupported status. More...
 
SupportStatus const required
 The standard required status. More...
 
SupportStatus const optional
 The standard optional status. More...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the SupportStatus Extensible Enumeration.

Function Documentation

◆ GetNumberOfSupportStatuses()

void KIM::SUPPORT_STATUS::GetNumberOfSupportStatuses ( int *const  numberOfSupportStatuses)

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

Parameters
[out]numberOfSupportStatusesThe number of standard SupportStatus's defined by the KIM API.
See also
KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses, kim_support_status_module::kim_get_number_of_support_statuses
Since
2.0

◆ GetSupportStatus()

int KIM::SUPPORT_STATUS::GetSupportStatus ( int const  index,
SupportStatus *const  supportStatus 
)

Get the identity of each defined standard SupportStatus.

Parameters
[in]indexZero-based index uniquely labeling each defined standard SupportStatus. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]supportStatusThe SupportStatus object associated with index.
Returns
true if index < 0 or index >= numberOfSupportStatuses.
false otherwise.
See also
KIM_SUPPORT_STATUS_GetSupportStatus, kim_support_status_module::kim_get_support_status
Since
2.0

Variable Documentation

◆ notSupported

SupportStatus const KIM::SUPPORT_STATUS::notSupported

The standard notSupported status.

Todo:
Add more detailed description of status.
See also
KIM_SUPPORT_STATUS_notSupported, kim_support_status_module::kim_support_status_not_supported
Since
2.0

◆ optional

SupportStatus const KIM::SUPPORT_STATUS::optional

The standard optional status.

Todo:
Add more detailed description of status.
See also
KIM_SUPPORT_STATUS_optional, kim_support_status_module::kim_support_status_optional
Since
2.0

◆ required

SupportStatus const KIM::SUPPORT_STATUS::required

The standard required status.

Todo:
Add more detailed description of status.
See also
KIM_SUPPORT_STATUS_required, kim_support_status_module::kim_support_status_required
Since
2.0

◆ requiredByAPI

SupportStatus const KIM::SUPPORT_STATUS::requiredByAPI

The standard requiredByAPI status.

Todo:
Add more detailed description of status.
See also
KIM_SUPPORT_STATUS_requiredByAPI, kim_support_status_module::kim_support_status_required_by_api
Since
2.0