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

Map is a homogeneous container of complex data type entries. More...

Inheritance diagram for thomsonreuters::ema::access::Map:
thomsonreuters::ema::access::ComplexType thomsonreuters::ema::access::Data

Public Member Functions

Constructor
 Map ()
 
Destructor
virtual ~Map ()
 
Accessors
DataType::DataTypeEnum getDataType () const
 
Data::DataCode getCode () const
 
const EmaBuffergetAsHex () const
 
const EmaStringtoString () const
 
bool forth () const
 
void reset () const
 
const MapEntrygetEntry () const
 
bool hasKeyFieldId () const
 
bool hasTotalCountHint () const
 
Int16 getKeyFieldId () const
 
UInt32 getTotalCountHint () const
 
const SummaryDatagetSummaryData () const
 
Operations
Mapclear ()
 
MapkeyFieldId (Int16 fieldId)
 
MaptotalCountHint (UInt32 totalCountHint)
 
MapsummaryData (const ComplexType &summaryData)
 
MapkeyType (DataType::DataTypeEnum keyPrimitiveType)
 
MapaddKeyInt (Int64 key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyInt (Int64 key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyUInt (UInt64 key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyUInt (UInt64 key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyReal (Int64 mantissa, OmmReal::MagnitudeType magnitudeType, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyReal (Int64 mantissa, OmmReal::MagnitudeType magnitudeType, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyRealFromDouble (double key, MapEntry::MapAction action, const ComplexType &value, OmmReal::MagnitudeType magnitudeType=OmmReal::Exponent0Enum, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyRealFromDouble (double key, MapEntry::MapAction action, OmmReal::MagnitudeType magnitudeType=OmmReal::Exponent0Enum, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyFloat (float key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyFloat (float key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyDouble (double key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyDouble (double key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyDate (UInt16 year, UInt8 month, UInt8 day, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyDate (UInt16 year, UInt8 month, UInt8 day, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyTime (UInt8 hour, UInt8 minute, UInt8 second, UInt16 millisecond, UInt16 microsecond, UInt16 nanosecond, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyTime (UInt8 hour, UInt8 minute, UInt8 second, UInt16 millisecond, UInt16 microsecond, UInt16 nanosecond, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyDateTime (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())
 
MapaddKeyDateTime (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())
 
MapaddKeyQos (UInt32 timeliness, UInt32 rate, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyQos (UInt32 timeliness, UInt32 rate, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyState (OmmState::StreamState streamState, OmmState::DataState dataState, UInt8 statusCode, const EmaString &statusText, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyState (OmmState::StreamState streamState, OmmState::DataState dataState, UInt8 statusCode, const EmaString &statusText, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyEnum (UInt16 key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyEnum (UInt16 key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyBuffer (const EmaBuffer &key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyBuffer (const EmaBuffer &key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyAscii (const EmaString &key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyAscii (const EmaString &key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyUtf8 (const EmaBuffer &key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyUtf8 (const EmaBuffer &key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyRmtes (const EmaBuffer &key, MapEntry::MapAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer())
 
MapaddKeyRmtes (const EmaBuffer &key, MapEntry::MapAction action, const EmaBuffer &permissionData=EmaBuffer())
 
const Mapcomplete ()
 
- Public Member Functions inherited from thomsonreuters::ema::access::ComplexType
virtual ~ComplexType ()
 
- Public Member Functions inherited from thomsonreuters::ema::access::Data
const EmaStringgetCodeAsString () const
 
 operator const char * () const
 
virtual ~Data ()
 

Additional Inherited Members

- Public Types inherited from thomsonreuters::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0,
  BlankEnum = 1
}
 
- Protected Member Functions inherited from thomsonreuters::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from thomsonreuters::ema::access::Data
 Data ()
 

Detailed Description

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.

FieldList fList;
fList.addInt( 1, 1 ).
addUInt( 100, 2 ).
addArray( 2000, Array().addInt( 1 ).addInt( 2 ).complete() ).
Map map;
map.totalCountHint( 1 ).
summaryData( fList ).
addKeyBuffer( EmaBuffer( "1234567" ), MapEntry::AddEnum, fList ).

The following code snippet shows extracting of Map and its content.

void decodeMap( const Map& map )
{
switch ( map.getSummaryData().getDataType() )
{
decodeFieldList( map.getSummaryData().getFieldList() );
break;
break;
}
while ( map.forth() )
{
const MapEntry& mEntry = map.getEntry();
const Key& key = mEntry.getKey();
switch ( key.getDataType() )
{
const EmaBuffer& keyBuffer = key.getBuffer();
break;
}
cout << "action = " << mEntry.getMapActionAsString() << "\n";
switch ( mEntry.getLoad().getDataType() )
{
decodeFieldList( mEntry.getLoad().getFieldList() );
break;
break;
}
}
}
Remarks
These two methods apply to containers only: ElementList, FieldList, FilterList, Map, Series, and Vector.
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform setting and extracting of Map and its content.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See Also
Data, MapEntry, SummaryData, ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaString, EmaBuffer

Definition at line 124 of file Map.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::Map::Map ( )

Constructs Map

virtual thomsonreuters::ema::access::Map::~Map ( )
virtual

Destructor.

Member Function Documentation

Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaString containing Ascii key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaString containing Ascii key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Buffer key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Buffer key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDate is invalid
Parameters
[in]yearspecifies OmmDate::year part of key information (0 - 4095)
[in]monthspecifies OmmDate::month part of key information (0 - 12)
[in]dayspecifies OmmDate::day part of key information (0 - 31)
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDate is invalid
Parameters
[in]yearspecifies OmmDate::year part of key information (0 - 4095)
[in]monthspecifies OmmDate::month part of key information (0 - 12)
[in]dayspecifies OmmDate::day part of key information (0 - 31)
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDateTime is invalid
Parameters
[in]yearspecifies OmmDateTime::year part of key information (0 - 4095)
[in]monthspecifies OmmDateTime::month part of key information (0 - 12)
[in]dayspecifies OmmDateTime::day part of key information (0 - 31)
[in]hourspecifies OmmDateTime::hour part of key information (0 - 23)
[in]minutespecifies OmmDateTime::minute part of key information (0 - 59)
[in]secondspecifies OmmDateTime::second part of key information (0 - 60)
[in]millisecondspecifies OmmDateTime::millisecond part of key information (0 - 999)
[in]microsecondspecifies OmmDateTime::microsecond part of key information (0 - 999)
[in]nanosecondspecifies OmmDateTime::nanosecond part of key information (0 - 999)
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDateTime is invalid
Parameters
[in]yearspecifies OmmDateTime::year part of key information (0 - 4095)
[in]monthspecifies OmmDateTime::month part of key information (0 - 12)
[in]dayspecifies OmmDateTime::day part of key information (0 - 31)
[in]hourspecifies OmmDateTime::hour part of key information (0 - 23)
[in]minutespecifies OmmDateTime::minute part of key information (0 - 59)
[in]secondspecifies OmmDateTime::second part of key information (0 - 60)
[in]millisecondspecifies OmmDateTime::millisecond part of key information (0 - 999)
[in]microsecondspecifies OmmDateTime::microsecond part of key information (0 - 999)
[in]nanosecondspecifies OmmDateTime::nanosecond part of key information (0 - 999)
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining double key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining double key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyUInt16 containing Enum key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyUInt16 containing Enum key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining float key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining float key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining Int64 key information
[in]actionspecifies action to be applied to the entry
[in]valuespecifies complex type associated with this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining Int64 key information
[in]actionspecifies action to be applied to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]timelinessspecifies OmmQos::timeliness part of key information
[in]ratespecifies OmmQos::rate part of key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]timelinessspecifies OmmQos::timeliness part of key information
[in]ratespecifies OmmQos::rate part of key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]mantissaspecifies OmmReal::mantissa part of key information
[in]magnitudeTypespecifies OmmReal::magnitudeType part of key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]mantissaspecifies OmmReal::mantissa part of key information
[in]magnitudeTypespecifies OmmReal::magnitudeType part of key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyspecifies double to be converted to OmmReal
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]magnitudeTypeOmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum)
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyspecifies double to be converted to OmmReal
[in]actionspecifies action to apply to the entry
[in]magnitudeTypeOmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum)
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Rmtes key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Rmtes key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]streamStatespecifies OmmState::streamState part of key information
[in]dataStatespecifies OmmState::dataState part of key information
[in]statusCodespecifies OmmState::statusCode part of key information
[in]statusTextspecifies OmmState::text part of key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]streamStatespecifies OmmState::streamState part of key information
[in]dataStatespecifies OmmState::dataState part of key information
[in]statusCodespecifies OmmState::statusCode part of key information
[in]statusTextspecifies OmmState::text part of key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmTime is invalid
Parameters
[in]hourspecifies OmmTime::hour part of key information (0 - 23)
[in]minutespecifies OmmTime::minute part of key information (0 - 59)
[in]secondspecifies OmmTime::second part of key information (0 - 60)
[in]millisecondspecifies OmmTime::millisecond part of key information (0 - 999)
[in]microsecondspecifies OmmTime::microsecond part of key information (0 - 999)
[in]nanosecondspecifies OmmTime::nanosecond part of key information (0 - 999)
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmTime is invalid
Parameters
[in]hourspecifies OmmTime::hour part of key information (0 - 23)
[in]minutespecifies OmmTime::minute part of key information (0 - 59)
[in]secondspecifies OmmTime::second part of key information (0 - 60)
[in]millisecondspecifies OmmTime::millisecond part of key information (0 - 999)
[in]microsecondspecifies OmmTime::microsecond part of key information (0 - 999)
[in]nanosecondspecifies OmmTime::nanosecond part of key information (0 - 999)
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining UInt64 key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keycontaining UInt64 key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Utf8 key information
[in]actionspecifies action to apply to the entry
[in]valuecomplex type contained in this entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::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.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]keyEmaBuffer containing Utf8 key information
[in]actionspecifies action to apply to the entry
[in]permissionDataEmaBuffer containing permission data related to this entry
Returns
reference to this object
Map& thomsonreuters::ema::access::Map::clear ( )

Clears the Map.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object
const Map& thomsonreuters::ema::access::Map::complete ( )

Completes encoding of Map.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
const reference to this object
bool thomsonreuters::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().

Returns
false at the end of Map; true otherwise
const EmaBuffer& thomsonreuters::ema::access::Map::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
EmaBuffer with the message hex information

Implements thomsonreuters::ema::access::Data.

Data::DataCode thomsonreuters::ema::access::Map::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::NoCodeEnum

Implements thomsonreuters::ema::access::Data.

DataType::DataTypeEnum thomsonreuters::ema::access::Map::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type.

Returns
DataType::MapEnum

Implements thomsonreuters::ema::access::Data.

const MapEntry& thomsonreuters::ema::access::Map::getEntry ( ) const

Returns Entry.

Exceptions
OmmInvalidUsageExceptionif forth() was not called first
Returns
MapEntry
Int16 thomsonreuters::ema::access::Map::getKeyFieldId ( ) const

Returns KeyFieldId.

Exceptions
OmmInvalidUsageExceptionif hasKeyFieldId() returns false
Returns
key field id
const SummaryData& thomsonreuters::ema::access::Map::getSummaryData ( ) const

Returns the contained summaryData Data based on the summaryData DataType.

Remarks
SummaryData contains no data if SummaryData::getDataType() returns DataType::NoDataEnum
Returns
SummaryData
UInt32 thomsonreuters::ema::access::Map::getTotalCountHint ( ) const

Returns TotalCountHint.

Exceptions
OmmInvalidUsageExceptionif hasTotalCountHint() returns false
Returns
total count hint
bool thomsonreuters::ema::access::Map::hasKeyFieldId ( ) const

Indicates presence of KeyFieldId.

Returns
true if key field id is set; false otherwise
bool thomsonreuters::ema::access::Map::hasTotalCountHint ( ) const

Indicates presence of TotalCountHint.

Returns
true if total count hint is set; false otherwise
Map& thomsonreuters::ema::access::Map::keyFieldId ( Int16  fieldId)

Specifies KeyFieldId.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error) [in] fieldId specifies key field id
Returns
reference to this object
Map& thomsonreuters::ema::access::Map::keyType ( DataType::DataTypeEnum  keyPrimitiveType)

Specifies a primitive type for Map entry key.

Remarks
This method is used to override the default BUFFER data type.
Call this method or any add**() method can override the default key type.
Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error) [in] keyPrimitiveType specifies a primitive type for the Key
Returns
reference to this object
void thomsonreuters::ema::access::Map::reset ( ) const

Resets iteration to start of container.

Map& thomsonreuters::ema::access::Map::summaryData ( const ComplexType summaryData)

Specifies the SummaryData OMM Data.

Remarks
Call to summaryData( ) must happen prior to calling any add***( ) method
the data type of summary data must match with the load type of Map entry
Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]summaryDataspecifies complex type as summaryData
Returns
reference to this object
const EmaString& thomsonreuters::ema::access::Map::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements thomsonreuters::ema::access::Data.

Map& thomsonreuters::ema::access::Map::totalCountHint ( UInt32  totalCountHint)

Specifies TotalCountHint.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]totalCountHintspecifies total count hint
Returns
reference to this object