KIM::DATA_TYPE Namespace Reference

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

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

Functions
void	GetNumberOfDataTypes (int *const numberOfDataTypes)
	Get the number of standard DataType's defined by the KIM API. More...
int	GetDataType (int const index, DataType *const dataType)
	Get the identity of each defined standard DataType. More...

Variables
DataType const	Integer
	The standard Integer data type. More...
DataType const	Double
	The standard Double data type. More...

Detailed Description

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

Function Documentation

GetDataType()

int KIM::DATA_TYPE::GetDataType	(	int const	index,
		DataType *const	dataType
	)

Get the identity of each defined standard DataType.

Parameters

[in]	index	Zero-based index uniquely labeling each defined standard DataType. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]	dataType	The DataType object associated with index.

Returns

true if index < 0 or index >= numberOfDataTypes.

false otherwise.

See also

KIM_DATA_TYPE_GetDataType, kim_data_type_module::kim_get_data_type

Since

2.0

GetNumberOfDataTypes()

void KIM::DATA_TYPE::GetNumberOfDataTypes

(

int *const

numberOfDataTypes

)

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

Parameters

[out]

numberOfDataTypes

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

Variable Documentation

Double

DataType const KIM::DATA_TYPE::Double

The standard Double data type.

Todo:

Add more detailed description of data type.

See also

KIM_DATA_TYPE_Double, kim_data_type_module::kim_data_type_double

Since

2.0

Integer

DataType const KIM::DATA_TYPE::Integer

The standard Integer data type.

Todo:

Add more detailed description of data type.

See also

KIM_DATA_TYPE_Integer, kim_data_type_module::kim_data_type_integer

Since

2.0