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

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

#include <KIM_ComputeArgumentName.hpp>

Public Member Functions

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

Public Attributes

int computeArgumentNameID
 Integer identifying the specific ComputeArgumentName represented. More...
 

Detailed Description

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

The enumeration constants are contained in the COMPUTE_ARGUMENT_NAME namespace.

See also
KIM_ComputeArgumentName, kim_compute_argument_name_module::kim_compute_argument_name_type
Since
2.0

Definition at line 54 of file KIM_ComputeArgumentName.hpp.

Constructor & Destructor Documentation

◆ ComputeArgumentName() [1/3]

KIM::ComputeArgumentName::ComputeArgumentName ( )

Create an uninitialized ComputeArgumentName object.

Since
2.0

◆ ComputeArgumentName() [2/3]

KIM::ComputeArgumentName::ComputeArgumentName ( int const  id)

Create a ComputeArgumentName object with the specified id.

Note
This should not be used directly.
Since
2.0

◆ ComputeArgumentName() [3/3]

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

Create a ComputeArgumentName 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_ComputeArgumentName_FromString, kim_compute_argument_name_module::kim_from_string
Since
2.0

Member Function Documentation

◆ Known()

bool KIM::ComputeArgumentName::Known ( ) const

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

ComputeArgumentName's known to the KIM API are found in the COMPUTE_ARGUMENT_NAME namespace.

See also
KIM_ComputeArgumentName_Known, kim_compute_argument_name_module::kim_known
Since
2.0

◆ operator!=()

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

Compares ComputeArgumentName objects for inequality.

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

◆ operator==()

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

Compares ComputeArgumentName objects for equality.

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

◆ ToString()

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

Converts the object to a string.

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

Member Data Documentation

◆ computeArgumentNameID

int KIM::ComputeArgumentName::computeArgumentNameID

Integer identifying the specific ComputeArgumentName represented.

Note
This should not be directly accessed and is only public for cross-language reasons.
See also
KIM_ComputeArgumentName::computeArgumentNameID, kim_compute_argument_name_module::kim_compute_argument_name_type::compute_argument_name_id
Since
2.0

Definition at line 67 of file KIM_ComputeArgumentName.hpp.


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