KIM_TimeUnit.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_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 Documentation

KIM_TimeUnit

typedef struct KIM_TimeUnit KIM_TimeUnit

Convenience typedef.

Since

2.0

Definition at line 60 of file KIM_TimeUnit.h.

Function Documentation

KIM_TIME_UNIT_GetNumberOfTimeUnits()

void KIM_TIME_UNIT_GetNumberOfTimeUnits

(

int *const

numberOfTimeUnits

)

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

See also

KIM::TIME_UNIT::GetNumberOfTimeUnits, kim_time_unit_module::kim_get_number_of_time_units

Since

2.0

KIM_TIME_UNIT_GetTimeUnit()

int KIM_TIME_UNIT_GetTimeUnit	(	int const	index,
		KIM_TimeUnit *const	timeUnit
	)

Get the identity of each defined standard TimeUnit.

See also

KIM::TIME_UNIT::GetTimeUnit, kim_time_unit_module::kim_get_time_unit

Since

2.0

KIM_TimeUnit_Equal()

int KIM_TimeUnit_Equal	(	KIM_TimeUnit const	lhs,
		KIM_TimeUnit const	rhs
	)

Compares TimeUnit objects for equality.

See also

KIM::TimeUnit::operator==(), kim_time_unit_module::operator(.eq.)

Since

2.0

KIM_TimeUnit_FromString()

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.

See also

KIM::TimeUnit::TimeUnit(std::string const &), kim_time_unit_module::kim_from_string

Since

2.0

KIM_TimeUnit_Known()

int KIM_TimeUnit_Known

(

KIM_TimeUnit const

timeUnit

)

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

See also

KIM::TimeUnit::Known, kim_time_unit_module::kim_known

Since

2.0

KIM_TimeUnit_NotEqual()

int KIM_TimeUnit_NotEqual	(	KIM_TimeUnit const	lhs,
		KIM_TimeUnit const	rhs
	)

Compares TimeUnit objects for inequality.

See also

KIM::TimeUnit::operator!=(), kim_time_unit_module::operator(.ne.)

Since

2.0

KIM_TimeUnit_ToString()

char const* KIM_TimeUnit_ToString

(

KIM_TimeUnit const

timeUnit

)

Converts the object to a string.

See also

KIM::TimeUnit::ToString, kim_time_unit_module::kim_to_string

Since

2.0

Variable Documentation

KIM_TIME_UNIT_fs

KIM_TimeUnit const KIM_TIME_UNIT_fs

The standard femtosecond unit of time.

See also

KIM::TIME_UNIT::fs, kim_time_unit_module::kim_time_unit_fs

Since

2.0

KIM_TIME_UNIT_ns

KIM_TimeUnit const KIM_TIME_UNIT_ns

The standard nanosecond unit of time.

See also

KIM::TIME_UNIT::ns, kim_time_unit_module::kim_time_unit_ns

Since

2.0

KIM_TIME_UNIT_ps

KIM_TimeUnit const KIM_TIME_UNIT_ps

The standard picosecond unit of time.

See also

KIM::TIME_UNIT::ps, kim_time_unit_module::kim_time_unit_ps

Since

2.0

KIM_TIME_UNIT_s

KIM_TimeUnit const KIM_TIME_UNIT_s

The standard second unit of time.

See also

KIM::TIME_UNIT::s, kim_time_unit_module::kim_time_unit_s

Since

2.0

KIM_TIME_UNIT_unused

KIM_TimeUnit const KIM_TIME_UNIT_unused

Indicates that a TimeUnit is not used.

See also

KIM::TIME_UNIT::unused, kim_time_unit_module::kim_time_unit_unused

Since

2.0