EMA C++ Edition
List of all members
refinitiv::ema::rdm::DictionaryEntry Class Reference

Public Member Functions

Accessors
const refinitiv::ema::access::EmaStringgetAcronym () const
  More...
 
const refinitiv::ema::access::EmaStringgetDDEAcronym () const
  More...
 
refinitiv::ema::access::Int16 getFid () const
  More...
 
refinitiv::ema::access::Int16 getRippleToField () const
  More...
 
refinitiv::ema::access::Int8 getFieldType () const
  More...
 
refinitiv::ema::access::UInt16 getLength () const
  More...
 
refinitiv::ema::access::UInt8 getRwfType () const
  More...
 
refinitiv::ema::access::UInt8 getEnumLength () const
  More...
 
refinitiv::ema::access::UInt32 getRwfLength () const
  More...
 
Operations
bool hasEnumType (refinitiv::ema::access::UInt16 value) const
  More...
 
const EnumTypegetEnumType (refinitiv::ema::access::UInt16 value) const
  More...
 
bool hasEnumTypeTable () const
  More...
 
const EnumTypeTablegetEnumTypeTable () const
  More...
 
const refinitiv::ema::access::EmaStringtoString () const
  More...
 
 operator const char * () const
  More...
 
Constructor
 DictionaryEntry ()
  More...
 

Destructor

class DictionaryEntryImpl
 
class DataDictionaryImpl
 
template<class T >
class refinitiv::ema::access::EmaVector
 
virtual ~DictionaryEntry ()
  More...
 

Detailed Description

Definition at line 33 of file DictionaryEntry.h.

Constructor & Destructor Documentation

◆ DictionaryEntry()

refinitiv::ema::rdm::DictionaryEntry::DictionaryEntry ( )

default constructor.

◆ ~DictionaryEntry()

virtual refinitiv::ema::rdm::DictionaryEntry::~DictionaryEntry ( )
virtual

destructor.

Member Function Documentation

◆ getAcronym()

const refinitiv::ema::access::EmaString& refinitiv::ema::rdm::DictionaryEntry::getAcronym ( ) const

Acronym.

Returns
the acronym

◆ getDDEAcronym()

const refinitiv::ema::access::EmaString& refinitiv::ema::rdm::DictionaryEntry::getDDEAcronym ( ) const

DDE Acronym.

Returns
the ddeAcronym

◆ getEnumLength()

refinitiv::ema::access::UInt8 refinitiv::ema::rdm::DictionaryEntry::getEnumLength ( ) const

Marketfeed enum length.

Returns
the enumLength

◆ getEnumType()

const EnumType& refinitiv::ema::rdm::DictionaryEntry::getEnumType ( refinitiv::ema::access::UInt16  value) const

Returns the corresponding enumerated type in the dictionary entry's table, if the type exists.

Parameters
valuethe value of the enumerated type to get
Exceptions
OmmInvalidUsageExceptionif the entry does not exist.
Returns
the enumerated type if it exists

◆ getEnumTypeTable()

const EnumTypeTable& refinitiv::ema::rdm::DictionaryEntry::getEnumTypeTable ( ) const

Returns the list of EnumTypeTable that is used by this DictionaryEntry, if the type exists.

Exceptions
OmmInvalidUsageExceptionif the entry does not exist.
Returns
the array of EnumTypeTable if it exists

◆ getFid()

refinitiv::ema::access::Int16 refinitiv::ema::rdm::DictionaryEntry::getFid ( ) const

The fieldId the entry corresponds to.

Returns
the fid

◆ getFieldType()

refinitiv::ema::access::Int8 refinitiv::ema::rdm::DictionaryEntry::getFieldType ( ) const

Marketfeed Field Type.

Returns
the fieldType

◆ getLength()

refinitiv::ema::access::UInt16 refinitiv::ema::rdm::DictionaryEntry::getLength ( ) const

Marketfeed length.

Returns
the length

◆ getRippleToField()

refinitiv::ema::access::Int16 refinitiv::ema::rdm::DictionaryEntry::getRippleToField ( ) const

The field to ripple data to.

Returns
the rippleToField

◆ getRwfLength()

refinitiv::ema::access::UInt32 refinitiv::ema::rdm::DictionaryEntry::getRwfLength ( ) const

RWF Length.

Returns
the rwfLength

◆ getRwfType()

refinitiv::ema::access::UInt8 refinitiv::ema::rdm::DictionaryEntry::getRwfType ( ) const

RWF type.

Returns
data types defined in DataType::DataTypeEnum

◆ hasEnumType()

bool refinitiv::ema::rdm::DictionaryEntry::hasEnumType ( refinitiv::ema::access::UInt16  value) const

Check whether the EnumType exists

Parameters
[in]valuethe value of the enumerated type to check
Returns
the enumerated type if it exists

◆ hasEnumTypeTable()

bool refinitiv::ema::rdm::DictionaryEntry::hasEnumTypeTable ( ) const

Check whether the EnumTypeTable exists

Returns
true if EnumTypeTable exists, otherwise false

◆ operator const char *()

refinitiv::ema::rdm::DictionaryEntry::operator const char * ( ) const

Operator const char* overload.

Exceptions
OmmMemoryExhaustionExceptionif app runs out of memory

◆ toString()

const refinitiv::ema::access::EmaString& refinitiv::ema::rdm::DictionaryEntry::toString ( ) const

Returns a string representation of the class instance.

Exceptions
OmmMemoryExhaustionExceptionif app runs out of memory
Returns
string representation of the class instance