Description of an enumeration type.
More...
#include <Safir/Dob/Typesystem/ToolSupport/TypeRepository.h>
|
virtual const char * | FileName () const =0 |
| Get dou file path as a string. More...
|
|
virtual const char * | Summary () const =0 |
| Get a summary about this enumeration. More...
|
|
virtual DotsC_TypeId | GetTypeId () const =0 |
| Get the typeId of this enumeration. More...
|
|
virtual const char * | GetName () const =0 |
| Get qualified name of the enumeration type. More...
|
|
virtual DotsC_TypeId | GetCheckSum () const =0 |
| Get checksum of this enum type. More...
|
|
virtual int | GetNumberOfValues () const =0 |
| Get number of enumeration values. More...
|
|
virtual const char * | GetValueName (DotsC_EnumerationValue val) const =0 |
| Get name of a enumeration value. More...
|
|
virtual int | GetIndexOfValue (const std::string &valueName) const =0 |
| Get index (ordinal) for a named enumeration value. More...
|
|
Description of an enumeration type.
virtual const char* Safir::Dob::Typesystem::ToolSupport::EnumDescription::FileName |
( |
| ) |
const |
|
pure virtual |
Get dou file path as a string.
- Returns
- Path to file.
virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetCheckSum |
( |
| ) |
const |
|
pure virtual |
Get checksum of this enum type.
- Returns
- Checksum.
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).
virtual const char* Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetName |
( |
| ) |
const |
|
pure virtual |
Get qualified name of the enumeration type.
- Returns
- Type name.
virtual int Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetNumberOfValues |
( |
| ) |
const |
|
pure virtual |
Get number of enumeration values.
- Returns
- Number of enumeration values.
virtual DotsC_TypeId Safir::Dob::Typesystem::ToolSupport::EnumDescription::GetTypeId |
( |
| ) |
const |
|
pure virtual |
Get the typeId of this enumeration.
- Returns
- TypeId.
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.
virtual const char* Safir::Dob::Typesystem::ToolSupport::EnumDescription::Summary |
( |
| ) |
const |
|
pure virtual |
Get a summary about this enumeration.
- Returns
- Summary.