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::CollectionItemType Class Reference

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

#include <KIM_CollectionItemType.hpp>

Public Member Functions

 CollectionItemType ()
 Create an uninitialized CollectionItemType object. More...
 
 CollectionItemType (int const id)
 Create a CollectionItemType object with the specified id. More...
 
 CollectionItemType (std::string const &str)
 Create a CollectionItemType 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== (CollectionItemType const &rhs) const
 Compares CollectionItemType objects for equality. More...
 
bool operator!= (CollectionItemType const &rhs) const
 Compares CollectionItemType objects for inequality. More...
 
std::string const & ToString () const
 Converts the object to a string. More...
 

Public Attributes

int collectionItemTypeID
 Integer identifying the specific CollectionItemType represented. More...
 

Detailed Description

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

The enumeration constants are contained in the COLLECTION_ITEM_TUPE namespace.

See also
KIM_CollectionItemType, kim_collection_item_type_module::kim_collection_item_type_type
Since
2.1

Definition at line 51 of file KIM_CollectionItemType.hpp.

Constructor & Destructor Documentation

◆ CollectionItemType() [1/3]

KIM::CollectionItemType::CollectionItemType ( )

Create an uninitialized CollectionItemType object.

Since
2.1

◆ CollectionItemType() [2/3]

KIM::CollectionItemType::CollectionItemType ( int const  id)

Create a CollectionItemType object with the specified id.

Note
This should not be used directly.
Since
2.1

◆ CollectionItemType() [3/3]

KIM::CollectionItemType::CollectionItemType ( std::string const &  str)

Create a CollectionItemType 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_CollectionItemType_FromString, kim_collection_item_type_module::kim_from_string
Since
2.1

Member Function Documentation

◆ Known()

bool KIM::CollectionItemType::Known ( ) const

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

CollectionItemType's known to the KIM API are found in the COLLECTION_TIME_TYPE namespace.

See also
KIM_CollectionItemType_Known, kim_collection_item_type_module::kim_known
Since
2.1

◆ operator!=()

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

Compares CollectionItemType objects for inequality.

Note
It is possible for two "unknown" objects to be not equal.
See also
KIM_CollectionItemType_NotEqual, kim_collection_item_type_module::operator(.ne.)
Since
2.1

◆ operator==()

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

Compares CollectionItemType objects for equality.

Note
Not all "unknown" objects are equal.
See also
KIM_CollectionItemType_Equal, kim_collection_item_type_module::operator(.eq.)
Since
2.1

◆ ToString()

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

Converts the object to a string.

Returns
A string object representing the CollectionItemType object.
Note
If the CollectionItemType object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.
See also
KIM_CollectionItemType_ToString, kim_collection_item_type_module::kim_to_string
Since
2.1

Member Data Documentation

◆ collectionItemTypeID

int KIM::CollectionItemType::collectionItemTypeID

Integer identifying the specific CollectionItemType represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_CollectionItemType::collectionItemTypeID, kim_collection_item_type_module::kim_collection_item_type_type::collection_item_type_id
Since
2.1

Definition at line 63 of file KIM_CollectionItemType.hpp.


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