OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement Class Reference

Represents OTX Enumeration DataType. More...

#include <EnumerationElement.h>

Inheritance diagram for OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement:

Public Member Functions
	EnumerationElement (const std::string &signature, const std::string &elementName, const long &value, const std::string &specification)
	Initializes a new instance of the EnumerationElement class. More...
	EnumerationElement (const std::string &signature, const std::string &elementName, const long &value, const std::string &specification, std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::DataTypes::TranslationKey > translationKey)
	Initializes a new instance of the EnumerationElement class. More...
std::string	GetElementName () const
	Gets element name. More...
std::shared_ptr< Otx::Signature::IEnumerationSignature >	GetEnumeration () const
	Gets Enumeration More...
std::string	GetSignature () const
	Gets Full name of enumeration signature. More...
std::string	GetSpecification () const
	Gets enumeration signature specification More...
std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::DataTypes::TranslationKey >	GetTranslationKey ()
	The TranslationKey will be returned. More...
long	GetValue () const
	Gets element value. More...
std::string	ToLiteralString () const
	Gets literal string. More...

Detailed Description

Represents OTX Enumeration DataType.

Constructor & Destructor Documentation

EnumerationElement() [1/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::EnumerationElement	(	const std::string &	signature,
		const std::string &	elementName,
		const long &	value,
		const std::string &	specification
	)

Initializes a new instance of the EnumerationElement class.

Parameters

signature	Full name of enumeration signature.
elementName	Element name.
value	Element value.
specification	Enumeration signature specification.

EnumerationElement() [2/2]

OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::EnumerationElement	(	const std::string &	signature,
		const std::string &	elementName,
		const long &	value,
		const std::string &	specification,
		std::shared_ptr< OpenTestSystem::Otx::Runtime::Api::DataTypes::TranslationKey >	translationKey
	)

Initializes a new instance of the EnumerationElement class.

Parameters

signature	Full name of enumeration signature.
elementName	Element name.
value	Element value.
specification	Enumeration signature specification.
textId	The Text-Id of the TranslationKey.

Member Function Documentation

GetElementName()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetElementName

(

)

const

Gets element name.

Returns

Element name.

GetEnumeration()

std::shared_ptr<Otx::Signature::IEnumerationSignature> OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetEnumeration

(

)

const

Gets Enumeration

Returns

Enumeration

GetSignature()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetSignature

(

)

const

Gets Full name of enumeration signature.

Returns

Full name of enumeration signature.

Deprecated:

EnumerationElement::GetSignature is deprecated.

GetSpecification()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetSpecification

(

)

const

Gets enumeration signature specification

Returns

empty string

Deprecated:

EnumerationElement::GetSignature is deprecated.

GetTranslationKey()

std::shared_ptr<OpenTestSystem::Otx::Runtime::Api::DataTypes::TranslationKey> OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetTranslationKey

(

)

The TranslationKey will be returned.

Returns

TranslationKey

GetValue()

long OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::GetValue

(

)

const

Gets element value.

Returns

Element value.

ToLiteralString()

std::string OpenTestSystem::Otx::Runtime::Api::DataTypes::EnumerationElement::ToLiteralString ( ) const

virtual

Gets literal string.

Returns

Literal string.

Reimplemented from OpenTestSystem::Otx::Runtime::Api::DataTypes::Object.

---

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

• EnumerationElement.h