kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Public Member Functions | Public Attributes | List of all members
KIM::DataType Class Reference

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

#include <KIM_DataType.hpp>

Public Member Functions

 DataType ()
 Create an uninitialized DataType object. More...
 
 DataType (int const id)
 Create a DataType object with the specified id. More...
 
 DataType (std::string 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...
 
bool Known () const
 Determines if the object is a quantity known to the KIM API. More...
 
bool operator== (DataType const &rhs) const
 Compares DataType objects for equality. More...
 
bool operator!= (DataType const &rhs) const
 Compares DataType objects for inequality. More...
 
std::string const & ToString () const
 Converts the object to a string. More...
 

Public Attributes

int dataTypeID
 Integer identifying the specific DataType represented. More...
 

Detailed Description

An Extensible Enumeration for the DataType's supported by the KIM API.

The enumeration constants are contained in the DATA_TYPE namespace.

See also
KIM_DataType, kim_data_type_module::kim_data_type_type
Since
2.0

Definition at line 49 of file KIM_DataType.hpp.

Constructor & Destructor Documentation

◆ DataType() [1/3]

KIM::DataType::DataType ( )

Create an uninitialized DataType object.

Since
2.0

◆ DataType() [2/3]

KIM::DataType::DataType ( int const  id)

Create a DataType object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ DataType() [3/3]

KIM::DataType::DataType ( std::string 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_FromString, kim_data_type_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::DataType::Known ( ) const

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

DataType's known to the KIM API are found in the DATA_TYPE namespace.

See also
KIM_DataType_Known, kim_data_type_module::kim_known
Since
2.0

◆ operator!=()

bool KIM::DataType::operator!= ( DataType const &  rhs) const

Compares DataType objects for inequality.

Note
It is possible for two "unknown" objects to be not equal.
See also
KIM_DataType_NotEqual, kim_data_type_module::operator(.ne.)
Since
2.0

◆ operator==()

bool KIM::DataType::operator== ( DataType const &  rhs) const

Compares DataType objects for equality.

Note
Not all "unknown" objects are equal.
See also
KIM_DataType_Equal, kim_data_type_module::operator(.eq.)
Since
2.0

◆ ToString()

std::string const& KIM::DataType::ToString ( ) const

Converts the object to a string.

Returns
A string object representing the DataType object.
Note
If the DataType object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.
See also
KIM_DataType_ToString, kim_data_type_module::kim_to_string()
Since
2.0

Member Data Documentation

◆ dataTypeID

int KIM::DataType::dataTypeID

Integer identifying the specific DataType represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_DataType::dataTypeID, kim_data_type_module::kim_data_type_type::data_type_id
Since
2.0

Definition at line 61 of file KIM_DataType.hpp.


The documentation for this class was generated from the following file: