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

#include <KIM_SupportStatus.hpp>

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

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

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

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

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

Public Attributes
int	supportStatusID
	Integer identifying the specific SupportStatus represented. More...

Detailed Description

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

The enumeration constants are contained in the SUPPORT_STATUS namespace.

See also: KIM_SupportStatus, kim_support_status_module::kim_support_status_type

Since: 2.0

Definition at line 46 of file KIM_SupportStatus.hpp.

Constructor & Destructor Documentation

◆ SupportStatus() [1/3]

KIM::SupportStatus::SupportStatus ( )

Create an uninitialized SupportStatus object.

Since: 2.0

◆ SupportStatus() [2/3]

KIM::SupportStatus::SupportStatus ( int const id )

Create a SupportStatus object with the specified id.

Note: This should not be used directly.

Since: 2.0

◆ SupportStatus() [3/3]

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

Create a SupportStatus 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_SupportStatus_FromString, kim_support_status_module::kim_from_string

Since: 2.0

Member Function Documentation

◆ Known()

bool KIM::SupportStatus::Known ( ) const

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

SupportStatus's known to the KIM API are found in the SUPPORT_STATUS namespace.

See also: KIM_SupportStatus_Known, kim_support_status_module::kim_known

Since: 2.0

◆ operator!=()

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

Compares SupportStatus objects for inequality.

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

See also: KIM_SupportStatus_NotEqual, kim_support_status_module::operator(.ne.)

Since: 2.0

◆ operator==()

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

Compares SupportStatus objects for equality.

Note: Not all "unknown" objects are equal.

See also: KIM_SupportStatus_Equal, kim_support_status_module::operator(.eq.)

Since: 2.0

◆ ToString()

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

Converts the object to a string.

Returns: A string object representing the SupportStatus object.

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

See also: KIM_SupportStatus_ToString, kim_support_status_module::kim_to_string

Since: 2.0

Member Data Documentation

◆ supportStatusID

int KIM::SupportStatus::supportStatusID

Integer identifying the specific SupportStatus represented.

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

See also: KIM_SupportStatus::supportStatusID, kim_support_status_module::kim_support_status_type::support_status_id

Since: 2.0

Definition at line 58 of file KIM_SupportStatus.hpp.

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

latest/cpp/include/KIM_SupportStatus.hpp

Public Member Functions

Public Attributes