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

MapEntry represents an entry of Map. More...

Public Types

enum  MapAction {
  UpdateEnum = 1,
  AddEnum = 2,
  DeleteEnum = 3
}
 

Public Member Functions

Accessors
const EmaStringgetMapActionAsString () const
 
DataType::DataTypeEnum getLoadType () const
 
const EmaStringtoString () const
 
bool hasPermissionData () const
 
const ReqMsggetReqMsg () const
 
const RefreshMsggetRefreshMsg () const
 
const UpdateMsggetUpdateMsg () const
 
const StatusMsggetStatusMsg () const
 
const PostMsggetPostMsg () const
 
const AckMsggetAckMsg () const
 
const GenericMsggetGenericMsg () const
 
const FieldListgetFieldList () const
 
const ElementListgetElementList () const
 
const MapgetMap () const
 
const VectorgetVector () const
 
const SeriesgetSeries () const
 
const FilterListgetFilterList () const
 
const OmmOpaquegetOpaque () const
 
const OmmXmlgetXml () const
 
const OmmAnsiPagegetAnsiPage () const
 
const DatagetLoad () const
 
const KeygetKey () const
 
MapAction getAction () const
 
const EmaBuffergetPermissionData () const
 
const OmmErrorgetError () const
 

Friends

class Map
 

Detailed Description

MapEntry associates entry's key, permission information, action, data and its data type.

decodeMap( const Map& map )
{
while ( map.forth() )
{
const MapEntry& mapEntry = map.getEntry();
if ( mapEntry.hasPermissionData() )
{
const EmaBuffer& permissionData = mapEntry.getPermissionData();
...
}
...
}
}
Remarks
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform extracting of data from entry.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See Also
Data, ComplexType ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaBuffer, EmaString

Definition at line 95 of file MapEntry.h.

Member Enumeration Documentation

An enumeration representing map entry action.

Enumerator
UpdateEnum 

Indicates a partial change of the current Omm data.

AddEnum 

Indicates to append or replace the current Omm data.

DeleteEnum 

Indicates to remove current Omm data.

Definition at line 102 of file MapEntry.h.

Member Function Documentation

const AckMsg& thomsonreuters::ema::access::MapEntry::getAckMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not AckMsg
Returns
AckMsg class reference to contained entry's load object
MapAction thomsonreuters::ema::access::MapEntry::getAction ( ) const

Returns the current action on the OMM data.

Returns
MapAction
const OmmAnsiPage& thomsonreuters::ema::access::MapEntry::getAnsiPage ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmAnsiPage
Returns
OmmAnsiPage class reference to contained entry's load object
const ElementList& thomsonreuters::ema::access::MapEntry::getElementList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ElementList
Returns
ElementList class reference to contained entry's load object
const OmmError& thomsonreuters::ema::access::MapEntry::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained entry's load object
const FieldList& thomsonreuters::ema::access::MapEntry::getFieldList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FieldList
Returns
FieldList class reference to contained entry's load object
const FilterList& thomsonreuters::ema::access::MapEntry::getFilterList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FilterList
Returns
FilterList class reference to contained entry's load object
const GenericMsg& thomsonreuters::ema::access::MapEntry::getGenericMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not GenericMsg
Returns
GenericMsg class reference to contained entry's load object
const Key& thomsonreuters::ema::access::MapEntry::getKey ( ) const

Returns the contained key Data based on the key DataType.

Returns
Key class reference to contained entry's Key object
const Data& thomsonreuters::ema::access::MapEntry::getLoad ( ) const

Returns the contained Data based on the DataType.

Returns
Data class reference to contained entry's load object
DataType::DataTypeEnum thomsonreuters::ema::access::MapEntry::getLoadType ( ) const

Returns the DataType of the entry's load.

Remarks
return of DataType::NoDataEnum signifies no data present in load
return of DataType::OmmErrorEnum signifies error while extracting content of load
Returns
data type of the contained object
const Map& thomsonreuters::ema::access::MapEntry::getMap ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Map
Returns
Map class reference to contained entry's load object
const EmaString& thomsonreuters::ema::access::MapEntry::getMapActionAsString ( ) const

Returns the MapAction value as a string format.

Returns
EmaString containing string representation of MapAction
const OmmOpaque& thomsonreuters::ema::access::MapEntry::getOpaque ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmOpaque
Returns
OmmOpaque class reference to contained entry's load object
const EmaBuffer& thomsonreuters::ema::access::MapEntry::getPermissionData ( ) const

Returns PermissionData.

Exceptions
OmmInvalidUsageExceptionif hasPermissionData() returns false
Returns
EmaBuffer containing permission information
const PostMsg& thomsonreuters::ema::access::MapEntry::getPostMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not PostMsg
Returns
PostMsg class reference to contained entry's load object
const RefreshMsg& thomsonreuters::ema::access::MapEntry::getRefreshMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not RefreshMsg
Returns
RefreshMsg class reference to contained entry's load object
const ReqMsg& thomsonreuters::ema::access::MapEntry::getReqMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ReqMsg
Returns
ReqMsg class reference to contained object
const Series& thomsonreuters::ema::access::MapEntry::getSeries ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Series
Returns
Series class reference to contained entry's load object
const StatusMsg& thomsonreuters::ema::access::MapEntry::getStatusMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not StatusMsg
Returns
StatusMsg class reference to contained entry's load object
const UpdateMsg& thomsonreuters::ema::access::MapEntry::getUpdateMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not UpdateMsg
Returns
UpdateMsg class reference to contained entry's load object
const Vector& thomsonreuters::ema::access::MapEntry::getVector ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Vector
Returns
Vector class reference to contained entry's load object
const OmmXml& thomsonreuters::ema::access::MapEntry::getXml ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmXml
Returns
OmmXml class reference to contained entry's load object
bool thomsonreuters::ema::access::MapEntry::hasPermissionData ( ) const

Indicates presence of PermissionData.

Returns
true if permission data is set; false otherwise
const EmaString& thomsonreuters::ema::access::MapEntry::toString ( ) const

Returns a string representation of the class instance.

Returns
string representation of the class instance

Friends And Related Function Documentation

friend class Map
friend

Definition at line 261 of file MapEntry.h.