This graph shows which files directly or indirectly include this file:

Classes
struct	KIM_DataType
	An Extensible Enumeration for the DataType's supported by the KIM API. More...

Typedefs
typedef struct KIM_DataType	KIM_DataType
	Convenience typedef. More...

Functions
KIM_DataType	KIM_DataType_FromString (char const *const str)
	Create a DataType 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_DataType_Known (KIM_DataType const dataType)
	Determines if the object is a quantity known to the KIM API. More...

int	KIM_DataType_Equal (KIM_DataType const lhs, KIM_DataType const rhs)
	Compares DataType objects for equality. More...

int	KIM_DataType_NotEqual (KIM_DataType const lhs, KIM_DataType const rhs)
	Compares DataType objects for inequality. More...

char const *	KIM_DataType_ToString (KIM_DataType const dataType)
	Converts the object to a string. More...

void	KIM_DATA_TYPE_GetNumberOfDataTypes (int *const numberOfDataTypes)
	Get the number of standard DataType's defined by the KIM API. More...

int	KIM_DATA_TYPE_GetDataType (int const index, KIM_DataType *const dataType)
	Get the identity of each defined standard DataType. More...

Variables
KIM_DataType const	KIM_DATA_TYPE_Integer
	The standard `Integer` data type. More...

KIM_DataType const	KIM_DATA_TYPE_Double
	The standard `Double` data type. More...

Typedef Documentation

◆ KIM_DataType

typedef struct KIM_DataType KIM_DataType

Convenience typedef.

Since: 2.0

Definition at line 60 of file KIM_DataType.h.

Function Documentation

◆ KIM_DATA_TYPE_GetDataType()

int KIM_DATA_TYPE_GetDataType	(	int const	index,
		KIM_DataType *const	dataType
	)

Get the identity of each defined standard DataType.

See also: KIM::DATA_TYPE::GetDataType, kim_data_type_module::kim_get_data_type

Since: 2.0

◆ KIM_DATA_TYPE_GetNumberOfDataTypes()

void KIM_DATA_TYPE_GetNumberOfDataTypes ( int *const numberOfDataTypes )

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

See also: KIM::DATA_TYPE::GetNumberOfDataTypes, kim_data_type_module::kim_get_number_of_data_types

Since: 2.0

◆ KIM_DataType_Equal()

int KIM_DataType_Equal	(	KIM_DataType const	lhs,
		KIM_DataType const	rhs
	)

Compares DataType objects for equality.

See also: KIM::DataType::operator==(), kim_data_type_module::operator(.eq.)

Since: 2.0

◆ KIM_DataType_FromString()

KIM_DataType KIM_DataType_FromString ( char const *const str )

Create a DataType 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::DataType::DataType(std::string const &), kim_data_type_module::kim_from_string

Since: 2.0

◆ KIM_DataType_Known()

int KIM_DataType_Known ( KIM_DataType const dataType )

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

See also: KIM::DataType::Known, kim_data_type_module::kim_known

Since: 2.0

◆ KIM_DataType_NotEqual()

int KIM_DataType_NotEqual	(	KIM_DataType const	lhs,
		KIM_DataType const	rhs
	)

Compares DataType objects for inequality.

See also: KIM::DataType::operator!=(), kim_data_type_module::operator(.ne.)

Since: 2.0

◆ KIM_DataType_ToString()

char const* KIM_DataType_ToString ( KIM_DataType const dataType )

Converts the object to a string.

See also: KIM::DataType::ToString, kim_data_type_module::kim_to_string

Since: 2.0

Variable Documentation

◆ KIM_DATA_TYPE_Double

KIM_DataType const KIM_DATA_TYPE_Double

The standard Double data type.

See also: KIM::DATA_TYPE::Double, kim_data_type_module::kim_data_type_double

Since: 2.0

◆ KIM_DATA_TYPE_Integer

KIM_DataType const KIM_DATA_TYPE_Integer

The standard Integer data type.

See also: KIM::DATA_TYPE::Integer, kim_data_type_module::kim_data_type_integer

Since: 2.0

Classes

Typedefs

Functions

Variables