EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Friends
thomsonreuters::ema::rdm::DictionaryEntry Class Reference

Public Member Functions

Accessors
const
thomsonreuters::ema::access::EmaString
getAcronym () const
 
const
thomsonreuters::ema::access::EmaString
getDDEAcronym () const
 
thomsonreuters::ema::access::Int16 getFid () const
 
thomsonreuters::ema::access::Int16 getRippleToField () const
 
thomsonreuters::ema::access::Int8 getFieldType () const
 
thomsonreuters::ema::access::UInt16 getLength () const
 
thomsonreuters::ema::access::UInt8 getRwfType () const
 
thomsonreuters::ema::access::UInt8 getEnumLength () const
 
thomsonreuters::ema::access::UInt32 getRwfLength () const
 
Operations
bool hasEnumType (thomsonreuters::ema::access::UInt16 value) const
 
const EnumTypegetEnumType (thomsonreuters::ema::access::UInt16 value) const
 
bool hasEnumTypeTable () const
 
const EnumTypeTablegetEnumTypeTable () const
 
const
thomsonreuters::ema::access::EmaString
toString () const
 
 operator const char * () const
 
Constructor
 DictionaryEntry ()
 
Destructor
virtual ~DictionaryEntry ()
 

Friends

class DataDictionaryImpl
 
class DictionaryEntryImpl
 
template<class T >
class thomsonreuters::ema::access::EmaVector
 

Detailed Description

Definition at line 33 of file DictionaryEntry.h.

Constructor & Destructor Documentation

thomsonreuters::ema::rdm::DictionaryEntry::DictionaryEntry ( )

default constructor.

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

destructor.

Member Function Documentation

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

Acronym.

Returns
the acronym
const thomsonreuters::ema::access::EmaString& thomsonreuters::ema::rdm::DictionaryEntry::getDDEAcronym ( ) const

DDE Acronym.

Returns
the ddeAcronym
thomsonreuters::ema::access::UInt8 thomsonreuters::ema::rdm::DictionaryEntry::getEnumLength ( ) const

Marketfeed enum length.

Returns
the enumLength
const EnumType& thomsonreuters::ema::rdm::DictionaryEntry::getEnumType ( thomsonreuters::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
const EnumTypeTable& thomsonreuters::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
thomsonreuters::ema::access::Int16 thomsonreuters::ema::rdm::DictionaryEntry::getFid ( ) const

The fieldId the entry corresponds to.

Returns
the fid
thomsonreuters::ema::access::Int8 thomsonreuters::ema::rdm::DictionaryEntry::getFieldType ( ) const

Marketfeed Field Type.

Returns
the fieldType
thomsonreuters::ema::access::UInt16 thomsonreuters::ema::rdm::DictionaryEntry::getLength ( ) const

Marketfeed length.

Returns
the length
thomsonreuters::ema::access::Int16 thomsonreuters::ema::rdm::DictionaryEntry::getRippleToField ( ) const

The field to ripple data to.

Returns
the rippleToField
thomsonreuters::ema::access::UInt32 thomsonreuters::ema::rdm::DictionaryEntry::getRwfLength ( ) const

RWF Length.

Returns
the rwfLength
thomsonreuters::ema::access::UInt8 thomsonreuters::ema::rdm::DictionaryEntry::getRwfType ( ) const

RWF type.

Returns
data types defined in DataType::DataTypeEnum
bool thomsonreuters::ema::rdm::DictionaryEntry::hasEnumType ( thomsonreuters::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
bool thomsonreuters::ema::rdm::DictionaryEntry::hasEnumTypeTable ( ) const

Check whether the EnumTypeTable exists

Returns
true if EnumTypeTable exists, otherwise false
thomsonreuters::ema::rdm::DictionaryEntry::operator const char * ( ) const
Operator const char* overload.
Exceptions
OmmMemoryExhaustionExceptionif app runs out of memory
const thomsonreuters::ema::access::EmaString& thomsonreuters::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

Friends And Related Function Documentation

friend class DataDictionaryImpl
friend

Definition at line 168 of file DictionaryEntry.h.

friend class DictionaryEntryImpl
friend

Definition at line 167 of file DictionaryEntry.h.

template<class T >
friend class thomsonreuters::ema::access::EmaVector
friend

Definition at line 171 of file DictionaryEntry.h.