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

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

#include <KIM_ComputeCallbackName.hpp>

Public Member Functions

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

Public Attributes

int computeCallbackNameID
 Integer identifying the specific ComputeCallbackName represented. More...
 

Detailed Description

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

The enumeration constants are contained in the COMPUTE_CALLBACK_NAME namespace.

See also
KIM_ComputeCallbackName, kim_compute_callback_name_module::kim_compute_callback_name_type
Since
2.0

Definition at line 51 of file KIM_ComputeCallbackName.hpp.

Constructor & Destructor Documentation

◆ ComputeCallbackName() [1/3]

KIM::ComputeCallbackName::ComputeCallbackName ( )

Create an uninitialized ComputeCallbackName object.

Since
2.0

◆ ComputeCallbackName() [2/3]

KIM::ComputeCallbackName::ComputeCallbackName ( int const  id)

Create a ComputeCallbackName object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ ComputeCallbackName() [3/3]

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

Create a ComputeCallbackName 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_ComputeCallbackName_FromString, kim_compute_callback_name_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::ComputeCallbackName::Known ( ) const

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

ComputeCallbackName's known to the KIM API are found in the COMPUTE_CALLBACK_NAME namespace.

See also
KIM_ComputeCallbackName_Known, kim_compute_callback_name_module::kim_known
Since
2.0

◆ operator!=()

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

Compares ComputeCallbackName objects for inequality.

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

◆ operator==()

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

Compares ComputeCallbackName objects for equality.

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

◆ ToString()

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

Converts the object to a string.

Returns
A string object representing the ComputeCallbackName object.
Note
If the ComputeCallbackName object does not correspond to a value defined by the KIM API, then the string "unknown" is returned.
See also
KIM_ComputeCallbackName_ToString, kim_compute_callback_name_module::kim_to_string
Since
2.0

Member Data Documentation

◆ computeCallbackNameID

int KIM::ComputeCallbackName::computeCallbackNameID

Integer identifying the specific ComputeCallbackName represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_ComputeCallbackName::computeCallbackNameID, kim_compute_callback_name_module::kim_compute_callback_name_type::compute_callback_name_id
Since
2.0

Definition at line 64 of file KIM_ComputeCallbackName.hpp.


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