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

#include <KIM_ModelRoutineName.hpp>

Public Member Functions
	ModelRoutineName ()
	Create an uninitialized ModelRoutineName object. More...

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

	ModelRoutineName (std::string const &str)
	Create a ModelRoutineName 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== (ModelRoutineName const &rhs) const
	Compares ModelRoutineName objects for equality. More...

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

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

Public Attributes
int	modelRoutineNameID
	Integer identifying the specific ModelRoutineName represented. More...

Detailed Description

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

The enumeration constants are contained in the MODEL_ROUTINE_NAME namespace.

See also: KIM_ModelRoutineName, kim_model_routine_name_module::kim_model_routine_name_type

Since: 2.0

Definition at line 48 of file KIM_ModelRoutineName.hpp.

Constructor & Destructor Documentation

◆ ModelRoutineName() [1/3]

KIM::ModelRoutineName::ModelRoutineName ( )

Create an uninitialized ModelRoutineName object.

Since: 2.0

◆ ModelRoutineName() [2/3]

KIM::ModelRoutineName::ModelRoutineName ( int const id )

Create a ModelRoutineName object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ ModelRoutineName() [3/3]

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

Create a ModelRoutineName 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_ModelRoutineName_FromString, kim_model_routine_name_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::ModelRoutineName::Known ( ) const

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

ModelRoutineName's known to the KIM API are found in the MODEL_ROUTINE_NAME namespace.

See also: KIM_ModelRoutineName_Known, kim_model_routine_name_module::kim_known

Since: 2.0

◆ operator!=()

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

Compares ModelRoutineName objects for inequality.

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

See also: KIM_ModelRoutineName_NotEqual, kim_model_routine_name_module::operator(.ne.)

Since: 2.0

◆ operator==()

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

Compares ModelRoutineName objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_ModelRoutineName_Equal, kim_model_routine_name_module::operator(.eq.)

Since: 2.0

◆ ToString()

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

Converts the object to a string.

Returns: A string object representing the ModelRoutineName object.

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

See also: KIM_ModelRoutineName_ToString, kim_model_routine_name_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ modelRoutineNameID

int KIM::ModelRoutineName::modelRoutineNameID

Integer identifying the specific ModelRoutineName represented.

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

See also: KIM_ModelRoutineName::modelRoutineNameID, kim_model_routine_name_module::kim_model_routine_name_type::model_routine_name_id

Since: 2.0

Definition at line 61 of file KIM_ModelRoutineName.hpp.

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

latest/cpp/include/KIM_ModelRoutineName.hpp

Public Member Functions

Public Attributes