Map is a homogeneous container of complex data type entries. More...
Public Member Functions | |
Constructor | |
Map () | |
More... | |
Destructor | |
virtual | ~Map () |
More... | |
Accessors | |
DataType::DataTypeEnum | getDataType () const |
More... | |
Data::DataCode | getCode () const |
More... | |
const EmaBuffer & | getAsHex () const |
More... | |
const EmaString & | toString () const |
More... | |
const EmaString & | toString (const refinitiv::ema::rdm::DataDictionary &dictionary) const |
More... | |
bool | forth () const |
More... | |
void | reset () const |
More... | |
const MapEntry & | getEntry () const |
More... | |
bool | hasKeyFieldId () const |
More... | |
bool | hasTotalCountHint () const |
More... | |
Int16 | getKeyFieldId () const |
More... | |
UInt32 | getTotalCountHint () const |
More... | |
const SummaryData & | getSummaryData () const |
More... | |
![]() | |
virtual | ~ComplexType () |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
Map entries are identified by a map key. All entries must have key of the same primitive data type. All entries must have same complex data type (except for delete action).
The following code snippet shows addition of entry and summaryData to Map.
The following code snippet shows extracting of Map and its content.
refinitiv::ema::access::Map::Map | ( | ) |
Constructs Map
|
virtual |
Destructor.
Map& refinitiv::ema::access::Map::addKeyAscii | ( | const EmaString & | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaString containing Ascii key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyAscii | ( | const EmaString & | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaString containing Ascii key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyBuffer | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Buffer key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyBuffer | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Buffer key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDate | ( | UInt16 | year, |
UInt8 | month, | ||
UInt8 | day, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[in] | year | specifies OmmDate::year part of key information (0 - 4095) |
[in] | month | specifies OmmDate::month part of key information (0 - 12) |
[in] | day | specifies OmmDate::day part of key information (0 - 31) |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDate | ( | UInt16 | year, |
UInt8 | month, | ||
UInt8 | day, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[in] | year | specifies OmmDate::year part of key information (0 - 4095) |
[in] | month | specifies OmmDate::month part of key information (0 - 12) |
[in] | day | specifies OmmDate::day part of key information (0 - 31) |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDateTime | ( | UInt16 | year, |
UInt8 | month, | ||
UInt8 | day, | ||
UInt8 | hour, | ||
UInt8 | minute, | ||
UInt8 | second, | ||
UInt16 | millisecond, | ||
UInt16 | microsecond, | ||
UInt16 | nanosecond, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDateTime is invalid |
[in] | year | specifies OmmDateTime::year part of key information (0 - 4095) |
[in] | month | specifies OmmDateTime::month part of key information (0 - 12) |
[in] | day | specifies OmmDateTime::day part of key information (0 - 31) |
[in] | hour | specifies OmmDateTime::hour part of key information (0 - 23) |
[in] | minute | specifies OmmDateTime::minute part of key information (0 - 59) |
[in] | second | specifies OmmDateTime::second part of key information (0 - 60) |
[in] | millisecond | specifies OmmDateTime::millisecond part of key information (0 - 999) |
[in] | microsecond | specifies OmmDateTime::microsecond part of key information (0 - 999) |
[in] | nanosecond | specifies OmmDateTime::nanosecond part of key information (0 - 999) |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDateTime | ( | UInt16 | year, |
UInt8 | month, | ||
UInt8 | day, | ||
UInt8 | hour, | ||
UInt8 | minute, | ||
UInt8 | second, | ||
UInt16 | millisecond, | ||
UInt16 | microsecond, | ||
UInt16 | nanosecond, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDateTime is invalid |
[in] | year | specifies OmmDateTime::year part of key information (0 - 4095) |
[in] | month | specifies OmmDateTime::month part of key information (0 - 12) |
[in] | day | specifies OmmDateTime::day part of key information (0 - 31) |
[in] | hour | specifies OmmDateTime::hour part of key information (0 - 23) |
[in] | minute | specifies OmmDateTime::minute part of key information (0 - 59) |
[in] | second | specifies OmmDateTime::second part of key information (0 - 60) |
[in] | millisecond | specifies OmmDateTime::millisecond part of key information (0 - 999) |
[in] | microsecond | specifies OmmDateTime::microsecond part of key information (0 - 999) |
[in] | nanosecond | specifies OmmDateTime::nanosecond part of key information (0 - 999) |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDouble | ( | double | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing double key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyDouble | ( | double | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing double key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyEnum | ( | UInt16 | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | UInt16 containing Enum key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyEnum | ( | UInt16 | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | UInt16 containing Enum key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyFloat | ( | float | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing float key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyFloat | ( | float | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing float key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyInt | ( | Int64 | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing Int64 key information |
[in] | action | specifies action to be applied to the entry |
[in] | value | specifies complex type associated with this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyInt | ( | Int64 | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing Int64 key information |
[in] | action | specifies action to be applied to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyQos | ( | UInt32 | timeliness, |
UInt32 | rate, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | timeliness | specifies OmmQos::timeliness part of key information |
[in] | rate | specifies OmmQos::rate part of key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyQos | ( | UInt32 | timeliness, |
UInt32 | rate, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | timeliness | specifies OmmQos::timeliness part of key information |
[in] | rate | specifies OmmQos::rate part of key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyReal | ( | Int64 | mantissa, |
OmmReal::MagnitudeType | magnitudeType, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | mantissa | specifies OmmReal::mantissa part of key information |
[in] | magnitudeType | specifies OmmReal::magnitudeType part of key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyReal | ( | Int64 | mantissa, |
OmmReal::MagnitudeType | magnitudeType, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | mantissa | specifies OmmReal::mantissa part of key information |
[in] | magnitudeType | specifies OmmReal::magnitudeType part of key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyRealFromDouble | ( | double | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
OmmReal::MagnitudeType | magnitudeType = OmmReal::Exponent0Enum , |
||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | specifies double to be converted to OmmReal |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | magnitudeType | OmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum) |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyRealFromDouble | ( | double | key, |
MapEntry::MapAction | action, | ||
OmmReal::MagnitudeType | magnitudeType = OmmReal::Exponent0Enum , |
||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | specifies double to be converted to OmmReal |
[in] | action | specifies action to apply to the entry |
[in] | magnitudeType | OmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum) |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyRmtes | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Rmtes key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyRmtes | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Rmtes key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyState | ( | OmmState::StreamState | streamState, |
OmmState::DataState | dataState, | ||
UInt8 | statusCode, | ||
const EmaString & | statusText, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | streamState | specifies OmmState::streamState part of key information |
[in] | dataState | specifies OmmState::dataState part of key information |
[in] | statusCode | specifies OmmState::statusCode part of key information |
[in] | statusText | specifies OmmState::text part of key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyState | ( | OmmState::StreamState | streamState, |
OmmState::DataState | dataState, | ||
UInt8 | statusCode, | ||
const EmaString & | statusText, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | streamState | specifies OmmState::streamState part of key information |
[in] | dataState | specifies OmmState::dataState part of key information |
[in] | statusCode | specifies OmmState::statusCode part of key information |
[in] | statusText | specifies OmmState::text part of key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyTime | ( | UInt8 | hour, |
UInt8 | minute, | ||
UInt8 | second, | ||
UInt16 | millisecond, | ||
UInt16 | microsecond, | ||
UInt16 | nanosecond, | ||
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmTime is invalid |
[in] | hour | specifies OmmTime::hour part of key information (0 - 23) |
[in] | minute | specifies OmmTime::minute part of key information (0 - 59) |
[in] | second | specifies OmmTime::second part of key information (0 - 60) |
[in] | millisecond | specifies OmmTime::millisecond part of key information (0 - 999) |
[in] | microsecond | specifies OmmTime::microsecond part of key information (0 - 999) |
[in] | nanosecond | specifies OmmTime::nanosecond part of key information (0 - 999) |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyTime | ( | UInt8 | hour, |
UInt8 | minute, | ||
UInt8 | second, | ||
UInt16 | millisecond, | ||
UInt16 | microsecond, | ||
UInt16 | nanosecond, | ||
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmTime is invalid |
[in] | hour | specifies OmmTime::hour part of key information (0 - 23) |
[in] | minute | specifies OmmTime::minute part of key information (0 - 59) |
[in] | second | specifies OmmTime::second part of key information (0 - 60) |
[in] | millisecond | specifies OmmTime::millisecond part of key information (0 - 999) |
[in] | microsecond | specifies OmmTime::microsecond part of key information (0 - 999) |
[in] | nanosecond | specifies OmmTime::nanosecond part of key information (0 - 999) |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyUInt | ( | UInt64 | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing UInt64 key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyUInt | ( | UInt64 | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | containing UInt64 key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyUtf8 | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Utf8 key information |
[in] | action | specifies action to apply to the entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::addKeyUtf8 | ( | const EmaBuffer & | key, |
MapEntry::MapAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a specific simple type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | key | EmaBuffer containing Utf8 key information |
[in] | action | specifies action to apply to the entry |
[in] | permissionData | EmaBuffer containing permission data related to this entry |
Map& refinitiv::ema::access::Map::clear | ( | ) |
const Map& refinitiv::ema::access::Map::complete | ( | ) |
Completes encoding of Map.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::ema::access::Map::forth | ( | ) | const |
Iterates through a list of Data of any DataType. Typical usage is to extract the entry during each iteration via getEntry().
|
virtual |
Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the Code, which indicates a special state of a DataType.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type.
Implements refinitiv::ema::access::Data.
const MapEntry& refinitiv::ema::access::Map::getEntry | ( | ) | const |
Int16 refinitiv::ema::access::Map::getKeyFieldId | ( | ) | const |
Returns KeyFieldId.
OmmInvalidUsageException | if hasKeyFieldId() returns false |
const SummaryData& refinitiv::ema::access::Map::getSummaryData | ( | ) | const |
Returns the contained summaryData Data based on the summaryData DataType.
UInt32 refinitiv::ema::access::Map::getTotalCountHint | ( | ) | const |
Returns TotalCountHint.
OmmInvalidUsageException | if hasTotalCountHint() returns false |
bool refinitiv::ema::access::Map::hasKeyFieldId | ( | ) | const |
Indicates presence of KeyFieldId.
bool refinitiv::ema::access::Map::hasTotalCountHint | ( | ) | const |
Indicates presence of TotalCountHint.
Specifies KeyFieldId.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) @pram[in] fieldId specifies key field id |
Map& refinitiv::ema::access::Map::keyType | ( | DataType::DataTypeEnum | keyPrimitiveType | ) |
Specifies a primitive type for Map entry key.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) @pram[in] keyPrimitiveType specifies a primitive type for the Key |
void refinitiv::ema::access::Map::reset | ( | ) | const |
Resets iteration to start of container.
Map& refinitiv::ema::access::Map::summaryData | ( | const ComplexType & | summaryData | ) |
Specifies the SummaryData OMM Data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | summaryData | specifies complex type as summaryData |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::Map::toString | ( | const refinitiv::ema::rdm::DataDictionary & | dictionary | ) | const |
Returns a string representation of the class instance for just encoded object.
[in] | dictionary | use for toString() conversion |
Specifies TotalCountHint.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | totalCountHint | specifies total count hint |
![]() |
![]() |
|