Safir::Dob::Typesystem::ToolSupport::EnumDescription Class Reference

Description of an enumeration type. More...

#include <Safir/Dob/Typesystem/ToolSupport/TypeRepository.h>

Public Member Functions
virtual	~EnumDescription ()=default
	Destructor.
virtual const char *	FileName () const =0
	Get dou file path as a string.
virtual const char *	Summary () const =0
	Get a summary about this enumeration.
virtual DotsC_TypeId	GetTypeId () const =0
	Get the typeId of this enumeration.
virtual const char *	GetName () const =0
	Get qualified name of the enumeration type.
virtual DotsC_TypeId	GetChecksum () const =0
	Get checksum of this enum type.
virtual int	GetNumberOfValues () const =0
	Get number of enumeration values.
virtual const char *	GetValueName (DotsC_EnumerationValue val) const =0
	Get name of a enumeration value.
virtual int	GetIndexOfValue (const std::string &valueName) const =0
	Get index (ordinal) for a named enumeration value.

Detailed Description

Description of an enumeration type.

Constructor & Destructor Documentation

~EnumDescription()

virtual Safir::Dob::Typesystem::ToolSupport::EnumDescription::~EnumDescription ( )

virtualdefault

Destructor.

Member Function Documentation

FileName()

virtual const char * Safir::Dob::Typesystem::ToolSupport::EnumDescription::FileName ( ) const

pure virtual

Get dou file path as a string.

Returns

Path to file.

GetChecksum()

virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetChecksum ( ) const

pure virtual

Get checksum of this enum type.

Returns

Checksum.

GetIndexOfValue()

virtual int Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetIndexOfValue ( const std::string & valueName ) const

pure virtual

Get index (ordinal) for a named enumeration value.

Supports short name and fully qualified name. Ex: 'Monday' and 'MyEnumType.Monday'

Parameters

valueName

[in] - An enumeration value name.

Returns

Index (ordinal).

GetName()

virtual const char * Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetName ( ) const

pure virtual

Get qualified name of the enumeration type.

Returns

Type name.

GetNumberOfValues()

virtual int Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetNumberOfValues ( ) const

pure virtual

Get number of enumeration values.

Returns

Number of enumeration values.

GetTypeId()

virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetTypeId ( ) const

pure virtual

Get the typeId of this enumeration.

Returns

TypeId.

GetValueName()

virtual const char * Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetValueName ( DotsC_EnumerationValue val ) const

pure virtual

Get name of a enumeration value.

Parameters

val	[in] - The ordinal of the requested value. Valid is 0 to GetArraySize()-1.

Returns

Name of enumeration value.

Summary()

virtual const char * Safir::Dob::Typesystem::ToolSupport::EnumDescription::Summary ( ) const

pure virtual

Get a summary about this enumeration.

Returns

Summary.