|
class | refinitiv::ema::access::DictionaryCallbackClient |
|
class | refinitiv::ema::access::FieldListDecoder |
|
class | refinitiv::ema::access::OmmConsumerImpl |
|
class | refinitiv::ema::access::OmmConsumerConfigImpl |
|
class | refinitiv::ema::access::PostMsg |
|
class | refinitiv::ema::access::AckMsg |
|
class | refinitiv::ema::access::GenericMsg |
|
class | refinitiv::ema::access::RefreshMsg |
|
class | refinitiv::ema::access::ReqMsg |
|
class | refinitiv::ema::access::StatusMsg |
|
class | refinitiv::ema::access::UpdateMsg |
|
class | refinitiv::ema::access::FilterList |
|
class | refinitiv::ema::access::Map |
|
class | refinitiv::ema::access::Series |
|
class | refinitiv::ema::access::Vector |
|
class | refinitiv::ema::access::ElementList |
|
class | refinitiv::ema::access::FieldList |
|
class | refinitiv::ema::access::OmmArray |
|
void | clear () |
| More...
|
|
void | loadFieldDictionary (const refinitiv::ema::access::EmaString &filename) |
| More...
|
|
void | loadEnumTypeDictionary (const refinitiv::ema::access::EmaString &filename) |
| More...
|
|
void | encodeFieldDictionary (refinitiv::ema::access::Series &series, refinitiv::ema::access::UInt32 verbosity) |
| More...
|
|
bool | encodeFieldDictionary (refinitiv::ema::access::Series &series, refinitiv::ema::access::Int32 ¤tFid, refinitiv::ema::access::UInt32 verbosity, refinitiv::ema::access::UInt32 fragmentationSize) |
| More...
|
|
void | decodeFieldDictionary (const refinitiv::ema::access::Series &series, refinitiv::ema::access::UInt32 verbosity) |
| More...
|
|
void | encodeEnumTypeDictionary (refinitiv::ema::access::Series &series, refinitiv::ema::access::UInt32 verbosity) |
| More...
|
|
bool | encodeEnumTypeDictionary (refinitiv::ema::access::Series &series, refinitiv::ema::access::Int32 &enumTableCount, refinitiv::ema::access::UInt32 verbosity, refinitiv::ema::access::UInt32 fragmentationSize) |
| More...
|
|
void | decodeEnumTypeDictionary (const refinitiv::ema::access::Series &series, refinitiv::ema::access::UInt32 verbosity) |
| More...
|
|
refinitiv::ema::access::UInt32 | extractDictionaryType (const refinitiv::ema::access::Series &series) |
| More...
|
|
bool | isFieldDictionaryLoaded () const |
| More...
|
|
bool | isEnumTypeDefLoaded () const |
| More...
|
|
const refinitiv::ema::access::EmaString & | toString () const |
| More...
|
|
| operator const char * () const |
| More...
|
|
Definition at line 68 of file DataDictionary.h.
◆ DataDictionary() [1/2]
refinitiv::ema::rdm::DataDictionary::DataDictionary |
( |
| ) |
|
◆ DataDictionary() [2/2]
refinitiv::ema::rdm::DataDictionary::DataDictionary |
( |
const DataDictionary & |
| ) |
|
◆ ~DataDictionary()
virtual refinitiv::ema::rdm::DataDictionary::~DataDictionary |
( |
| ) |
|
|
virtual |
◆ clear()
void refinitiv::ema::rdm::DataDictionary::clear |
( |
| ) |
|
Clears DataDictionary.
This method is used to clear the existing dictionary information.
◆ decodeEnumTypeDictionary()
Decode the enumerated types information contained in an encoded enum types dictionary according to the domain model. This method may be called multiple times on the same dictionary, to load information from dictionaries that have been encoded in multiple parts.
- Parameters
-
[in] | series | specifies Series to be used for decoding enumerated types information from. |
[in] | verbosity | specifies the desired verbosity to decode. |
- Exceptions
-
OmmInvalidUsageException | if fails to decode enumerated types dictionary. |
◆ decodeFieldDictionary()
Decode the field dictionary information contained in a data payload according to the domain model. This method may be called multiple times on the same dictionary, to load information from dictionaries that have been encoded in multiple parts.
- Parameters
-
[in] | series | specifies Series to be used for decoding dictionary information from. |
[in] | verbosity | specifies the desired verbosity to decode. |
- Exceptions
-
OmmInvalidUsageException | if fails to decode field dictionary information. |
◆ encodeEnumTypeDictionary() [1/2]
Encode the enumerated types dictionary according the domain model, using the information from the tables and referencing fields present in this dictionary. Note: This method will use the type Ascii for the DISPLAY array. This method supports building the encoded data in multiple parts according to the fragmentation size.
- Parameters
-
[in] | series | specifies Series to be used for encoding enumerated types dictionary into. |
[in] | enumTableCount | tracks how many Enum table have been encoded in case of multi-part encoding. Must be initialized to 0 on the first call and is updated with each successfully encoded part |
[in] | verbosity | specifies the desired verbosity to encode. |
[in] | fragmentationSize | specifies the fragmentation size in number of bytes. |
- Returns
- true to indicate final part or single complete payload otherwise false
- Exceptions
-
OmmInvalidUsageException | if fails to encode enumerated types dictionary. |
◆ encodeEnumTypeDictionary() [2/2]
Encode the enumerated types dictionary according the domain model, using the information from the tables and referencing fields present in this dictionary. Note: This method will use the type Ascii for the DISPLAY array.
- Parameters
-
[in] | series | specifies Series to be used for encoding enumerated types dictionary into. |
[in] | verbosity | specifies the desired verbosity to encode. |
- Exceptions
-
OmmInvalidUsageException | if fails to encode enumerated types dictionary. |
◆ encodeFieldDictionary() [1/2]
Encode the field dictionary information into a data payload according the domain model, using the field information from the entries present in this dictionary. This method supports building the encoded data in multiple parts according to the fragmentation size.
- Parameters
-
[in] | series | specifies Series to be used for encoding dictionary information into. |
[in] | currentFid | tracks which fields have been encoded in case of multi-part encoding. Must be initialized to getMinFid() on the first call and is updated with each successfully encoded part |
[in] | verbosity | specifies the desired verbosity to encode. |
[in] | fragmentationSize | specifies the fragmentation size in number of bytes. |
- Returns
- true to indicate final part or single complete payload otherwise false
- Exceptions
-
OmmInvalidUsageException | if fails to encode field dictionary information. |
◆ encodeFieldDictionary() [2/2]
Encode the field dictionary information into a data payload according the domain model, using the field information from the entries present in this dictionary. This method supports building the encoded data in one full part.
- Parameters
-
[in] | series | specifies Series to be used for encoding dictionary information into. |
[in] | verbosity | specifies the desired verbosity to encode. |
- Exceptions
-
OmmInvalidUsageException | if fails to encode field dictionary information. |
◆ extractDictionaryType()
Extract dictionary type from the encoded payload of a EMA message where the domain type is DICTIONARY.
- Parameters
-
[in] | series | Series to be used for extracting dictionary type. |
- Returns
- The dictionary type defined in EmaRdm.
- Exceptions
-
OmmInvalidUsageException | If dictionary type is not available. |
◆ getDictionaryId()
DictionaryId Tag. All dictionaries loaded using this object will have this tag matched if found.
- Returns
- the DictionaryId
◆ getEntries()
◆ getEntry() [1/4]
Returns the entry in the dictionary corresponding to the given fieldName, if the entry exists.
- Parameters
-
[in] | fieldName | specifies the fieldId to get the dictionary entry for |
- Exceptions
-
OmmInvalidUsageException | if the entry does not exist |
- Returns
- the dictionary entry if it exists
◆ getEntry() [2/4]
Returns the entry in the dictionary corresponding to the given fieldName, if the entry exists.
- Parameters
-
[in] | fieldName | specifies the fieldId to get the dictionary entry for @entry[out] the entry in the dictionary corresponding to the given fieldName, if the entry exists |
- Exceptions
-
◆ getEntry() [3/4]
Returns the entry in the dictionary corresponding to the given fieldId, if the entry exists.
- Parameters
-
[in] | fieldId | specifies the fieldId to get the dictionary entry for |
- Exceptions
-
OmmInvalidUsageException | if the entry does not exist |
- Returns
- the dictionary entry if it exists
◆ getEntry() [4/4]
Returns the entry in the dictionary corresponding to the given fieldId, if the entry exists.
- Parameters
-
[in] | fieldId | specifies the fieldId to get the dictionary entry for @entry[out] the entry in the dictionary corresponding to the given fieldId, if the entry exists |
- Exceptions
-
◆ getEnumDate()
Enum Date Tag.
- Returns
- the EnumDate
◆ getEnumDescription()
Enum Description Tag.
- Returns
- the EnumDescription
◆ getEnumDisplayTemplateVersion()
Enum DT_Version Tag.
- Returns
- the EnumDisplayTemplateVersion
◆ getEnumFilename()
Enum Filename Tag.
- Returns
- the EnumFilename
◆ getEnumRecordTemplateVersion()
Enum RT_Version Tag.
- Returns
- the EnumRecordTemplateVersion
◆ getEnumTables()
◆ getEnumType()
Returns the corresponding enumerated type in the dictionary entry's table, if the type exists.
- Parameters
-
[in] | fieldId | specifies the fieldId to get the enumerated type from |
[in] | value | specifies the value of the enumerated type to get |
- Exceptions
-
OmmInvalidUsageException | if the entry does not exist |
- Returns
- the enumerated type if it exists
◆ getFieldBuild()
Field Build Tag.
- Returns
- the FieldBuild
◆ getFieldDate()
Field Date Tag.
- Returns
- the FieldDate
◆ getFieldDescription()
Field Description Tag.
- Returns
- the FieldDescription
◆ getFieldFilename()
Field Filename Tag.
- Returns
- the FieldFilename
◆ getFieldVersion()
Field Version Tag.
- Returns
- the FieldVersion
◆ getMaxFid()
The highest fieldId present in the dictionary.
- Returns
- the maxFid
◆ getMinFid()
The lowest fieldId present in the dictionary.
- Returns
- the minFid
◆ hasEntry() [1/2]
Check whether the DictionaryEntry exists
- Parameters
-
[in] | fieldName | the field name to check the dictionary entry |
- Returns
- true if the DictionaryEntry exists otherwise false
◆ hasEntry() [2/2]
Check whether the DictionaryEntry exists
- Parameters
-
[in] | fieldId | the fieldId to check the dictionary entry |
- Returns
- true if the DictionaryEntry exists otherwise false
◆ hasEnumType()
Check whether the EnumType exists
- Parameters
-
[in] | fieldId | the fieldId to check the enumerated type |
[in] | value | the value of the enumerated type to check |
- Returns
- the enumerated type if it exists
◆ isEnumTypeDefLoaded()
bool refinitiv::ema::rdm::DataDictionary::isEnumTypeDefLoaded |
( |
| ) |
const |
Check whether the EnumTypeDef has been loaded or not.
- Returns
- true if EnumTypeDef has been loaded, otherwise false.
◆ isFieldDictionaryLoaded()
bool refinitiv::ema::rdm::DataDictionary::isFieldDictionaryLoaded |
( |
| ) |
const |
Check whether the Field Dictionary has been loaded or not.
- Returns
- true if Field Dictionary has been loaded, otherwise false.
◆ loadEnumTypeDictionary()
Adds information from an enumerated types dictionary file to the data dictionary object. Subsequent calls to this method may be made to the same DataDictionary to load additional dictionaries (provided that there are no duplicate table references for any field).
- Parameters
-
[in] | filename | specifies an enumerated types dictionary file |
- Exceptions
-
OmmInvalidUsageException | if fails to load from the specified file name from filename . |
◆ loadFieldDictionary()
Adds information from a field dictionary file to the data dictionary object. Subsequent calls to this method may be made to the same DataDictionary to load additional dictionaries (provided the fields do not conflict).
- Parameters
-
[in] | filename | specifies a field dictionary file |
- Exceptions
-
OmmInvalidUsageException | if fails to load from the specified file name from filename . |
◆ operator const char *()
refinitiv::ema::rdm::DataDictionary::operator const char * |
( |
| ) |
const |
Operator const char* overload.
- Exceptions
-
OmmMemoryExhaustionException | if app runs out of memory |
◆ toString()
Returns a string representation of the class instance.
- Exceptions
-
OmmMemoryExhaustionException | if app runs out of memory |
- Returns
- string representation of the class instance