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

#include <KIM_Numbering.hpp>

Public Member Functions
	Numbering ()
	Create an uninitialized Numbering object.

	Numbering (int const id)
	Create a Numbering object with the specified id.

	Numbering (std::string const &str)
	Create a Numbering 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.

bool	Known () const
	Determines if the object is a quantity known to the KIM API.

bool	operator== (Numbering const &rhs) const
	Compares Numbering objects for equality.

bool	operator!= (Numbering const &rhs) const
	Compares Numbering objects for inequality.

std::string const &	ToString () const
	Converts the object to a string.

Public Attributes
int	numberingID
	Integer identifying the specific Numbering represented.

Detailed Description

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

The enumeration constants are contained in the NUMBERING namespace.

See also: KIM_Numbering, kim_numbering_module::kim_numbering_type

Since: 2.0

Definition at line 46 of file KIM_Numbering.hpp.

Constructor & Destructor Documentation

◆ Numbering() [1/3]

KIM::Numbering::Numbering ( )

Create an uninitialized Numbering object.

Since: 2.0

◆ Numbering() [2/3]

KIM::Numbering::Numbering ( int const id )

Create a Numbering object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ Numbering() [3/3]

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

Create a Numbering 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_Numbering_FromString, kim_numbering_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::Numbering::Known ( ) const

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

Numbering's known to the KIM API are found in the NUMBERING namespace.

See also: KIM_Numbering_Known, kim_numbering_module::kim_known

Since: 2.0

◆ operator!=()

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

Compares Numbering objects for inequality.

Note: It is possible for two "unknown" objects to be not equal.

See also: KIM_Numbering_NotEqual, kim_numbering_module::operator(.ne.)

Since: 2.0

◆ operator==()

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

Compares Numbering objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_Numbering_Equal, kim_numbering_module::operator(.eq.)

Since: 2.0

◆ ToString()

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

Converts the object to a string.

Returns: A string object representing the Numbering object.

Note: If the Numbering object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.

See also: KIM_Numbering_ToString, kim_numbering_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ numberingID

int KIM::Numbering::numberingID

Integer identifying the specific Numbering represented.

Note: This should not be directly accessed and is only public for cross-language reasons.

See also: KIM_Numbering::numberingID, kim_numbering_module::kim_numbering_type::numbering_id

Since: 2.0

Definition at line 58 of file KIM_Numbering.hpp.

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

latest/cpp/include/KIM_Numbering.hpp

Public Member Functions

Public Attributes