MapEntry represents an entry of Map.
More...
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();
...
}
...
}
}
- 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.
◆ MapAction
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.
◆ getAckMsg()
const AckMsg& refinitiv::ema::access::MapEntry::getAckMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- AckMsg class reference to contained entry's load object
◆ getAction()
MapAction refinitiv::ema::access::MapEntry::getAction |
( |
| ) |
const |
Returns the current action on the OMM data.
- Returns
- MapAction
◆ getAnsiPage()
const OmmAnsiPage& refinitiv::ema::access::MapEntry::getAnsiPage |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmAnsiPage class reference to contained entry's load object
◆ getElementList()
const ElementList& refinitiv::ema::access::MapEntry::getElementList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ElementList class reference to contained entry's load object
◆ getError()
const OmmError& refinitiv::ema::access::MapEntry::getError |
( |
| ) |
const |
Returns Error.
- Exceptions
-
- Returns
- OmmError class reference to contained entry's load object
◆ getFieldList()
const FieldList& refinitiv::ema::access::MapEntry::getFieldList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FieldList class reference to contained entry's load object
◆ getFilterList()
const FilterList& refinitiv::ema::access::MapEntry::getFilterList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FilterList class reference to contained entry's load object
◆ getGenericMsg()
const GenericMsg& refinitiv::ema::access::MapEntry::getGenericMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- GenericMsg class reference to contained entry's load object
◆ getKey()
const Key& refinitiv::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
◆ getLoad()
const Data& refinitiv::ema::access::MapEntry::getLoad |
( |
| ) |
const |
Returns the contained Data based on the DataType.
- Returns
- Data class reference to contained entry's load object
◆ getLoadType()
Returns the DataType of the entry's load.
- Returns
- data type of the contained object
◆ getMap()
const Map& refinitiv::ema::access::MapEntry::getMap |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Map class reference to contained entry's load object
◆ getMapActionAsString()
const EmaString& refinitiv::ema::access::MapEntry::getMapActionAsString |
( |
| ) |
const |
Returns the MapAction value as a string format.
- Returns
- EmaString containing string representation of MapAction
◆ getOpaque()
const OmmOpaque& refinitiv::ema::access::MapEntry::getOpaque |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmOpaque class reference to contained entry's load object
◆ getPermissionData()
const EmaBuffer& refinitiv::ema::access::MapEntry::getPermissionData |
( |
| ) |
const |
Returns PermissionData.
- Exceptions
-
- Returns
- EmaBuffer containing permission information
◆ getPostMsg()
const PostMsg& refinitiv::ema::access::MapEntry::getPostMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- PostMsg class reference to contained entry's load object
◆ getRefreshMsg()
const RefreshMsg& refinitiv::ema::access::MapEntry::getRefreshMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- RefreshMsg class reference to contained entry's load object
◆ getReqMsg()
const ReqMsg& refinitiv::ema::access::MapEntry::getReqMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ReqMsg class reference to contained object
◆ getSeries()
const Series& refinitiv::ema::access::MapEntry::getSeries |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Series class reference to contained entry's load object
◆ getStatusMsg()
const StatusMsg& refinitiv::ema::access::MapEntry::getStatusMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- StatusMsg class reference to contained entry's load object
◆ getUpdateMsg()
const UpdateMsg& refinitiv::ema::access::MapEntry::getUpdateMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- UpdateMsg class reference to contained entry's load object
◆ getVector()
const Vector& refinitiv::ema::access::MapEntry::getVector |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Vector class reference to contained entry's load object
◆ getXml()
const OmmXml& refinitiv::ema::access::MapEntry::getXml |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmXml class reference to contained entry's load object
◆ hasPermissionData()
bool refinitiv::ema::access::MapEntry::hasPermissionData |
( |
| ) |
const |
Indicates presence of PermissionData.
- Returns
- true if permission data is set; false otherwise
◆ toString()
const EmaString& refinitiv::ema::access::MapEntry::toString |
( |
| ) |
const |
Returns a string representation of the class instance.
- Returns
- string representation of the class instance