kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Go to the source code of this file.
Classes | |
struct | KIM_TimeUnit |
An Extensible Enumeration for the TimeUnit's supported by the KIM API. More... | |
Typedefs | |
typedef struct KIM_TimeUnit | KIM_TimeUnit |
Convenience typedef. More... | |
Functions | |
KIM_TimeUnit | KIM_TimeUnit_FromString (char const *const str) |
Create a TimeUnit 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_TimeUnit_Known (KIM_TimeUnit const timeUnit) |
Determines if the object is a quantity known to the KIM API. More... | |
int | KIM_TimeUnit_Equal (KIM_TimeUnit const lhs, KIM_TimeUnit const rhs) |
Compares TimeUnit objects for equality. More... | |
int | KIM_TimeUnit_NotEqual (KIM_TimeUnit const lhs, KIM_TimeUnit const rhs) |
Compares TimeUnit objects for inequality. More... | |
char const * | KIM_TimeUnit_ToString (KIM_TimeUnit const timeUnit) |
Converts the object to a string. More... | |
void | KIM_TIME_UNIT_GetNumberOfTimeUnits (int *const numberOfTimeUnits) |
Get the number of standard TimeUnit's defined by the KIM API. More... | |
int | KIM_TIME_UNIT_GetTimeUnit (int const index, KIM_TimeUnit *const timeUnit) |
Get the identity of each defined standard TimeUnit. More... | |
Variables | |
KIM_TimeUnit const | KIM_TIME_UNIT_unused |
Indicates that a TimeUnit is not used. More... | |
KIM_TimeUnit const | KIM_TIME_UNIT_fs |
The standard femtosecond unit of time. More... | |
KIM_TimeUnit const | KIM_TIME_UNIT_ps |
The standard picosecond unit of time. More... | |
KIM_TimeUnit const | KIM_TIME_UNIT_ns |
The standard nanosecond unit of time. More... | |
KIM_TimeUnit const | KIM_TIME_UNIT_s |
The standard second unit of time. More... | |
typedef struct KIM_TimeUnit KIM_TimeUnit |
void KIM_TIME_UNIT_GetNumberOfTimeUnits | ( | int *const | numberOfTimeUnits | ) |
Get the number of standard TimeUnit's defined by the KIM API.
int KIM_TIME_UNIT_GetTimeUnit | ( | int const | index, |
KIM_TimeUnit *const | timeUnit | ||
) |
Get the identity of each defined standard TimeUnit.
int KIM_TimeUnit_Equal | ( | KIM_TimeUnit const | lhs, |
KIM_TimeUnit const | rhs | ||
) |
Compares TimeUnit objects for equality.
KIM_TimeUnit KIM_TimeUnit_FromString | ( | char const *const | str | ) |
Create a TimeUnit 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.
int KIM_TimeUnit_Known | ( | KIM_TimeUnit const | timeUnit | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_TimeUnit_NotEqual | ( | KIM_TimeUnit const | lhs, |
KIM_TimeUnit const | rhs | ||
) |
Compares TimeUnit objects for inequality.
char const* KIM_TimeUnit_ToString | ( | KIM_TimeUnit const | timeUnit | ) |
Converts the object to a string.
KIM_TimeUnit const KIM_TIME_UNIT_fs |
The standard femtosecond unit of time.
KIM_TimeUnit const KIM_TIME_UNIT_ns |
The standard nanosecond unit of time.
KIM_TimeUnit const KIM_TIME_UNIT_ps |
The standard picosecond unit of time.
KIM_TimeUnit const KIM_TIME_UNIT_s |
The standard second unit of time.
KIM_TimeUnit const KIM_TIME_UNIT_unused |
Indicates that a TimeUnit is not used.