kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
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... | |
Contains the enumeration constants and the discovery routines for the SupportStatus Extensible Enumeration.
void KIM::SUPPORT_STATUS::GetNumberOfSupportStatuses | ( | int *const | numberOfSupportStatuses | ) |
Get the number of standard SupportStatus's defined by the KIM API.
[out] | numberOfSupportStatuses | The number of standard SupportStatus's defined by the KIM API. |
int KIM::SUPPORT_STATUS::GetSupportStatus | ( | int const | index, |
SupportStatus *const | supportStatus | ||
) |
Get the identity of each defined standard SupportStatus.
[in] | index | Zero-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] | supportStatus | The SupportStatus object associated with index . |
true
if index < 0
or index >= numberOfSupportStatuses
. false
otherwise.SupportStatus const KIM::SUPPORT_STATUS::notSupported |
The standard notSupported
status.
SupportStatus const KIM::SUPPORT_STATUS::optional |
SupportStatus const KIM::SUPPORT_STATUS::required |
SupportStatus const KIM::SUPPORT_STATUS::requiredByAPI |
The standard requiredByAPI
status.