EMA C++ Edition
MapEntry.h
Go to the documentation of this file.
1/*|-----------------------------------------------------------------------------
2 *| This source code is provided under the Apache 2.0 license
3 *| and is provided AS IS with no warranty or guarantee of fit for purpose.
4 *| See the project's LICENSE.md for details.
5 *| Copyright (C) 2019 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_MapEntry_h
10#define __refinitiv_ema_access_MapEntry_h
11
67#include "Access/Include/Key.h"
68
69namespace refinitiv {
70
71namespace ema {
72
73namespace access {
74
75class ReqMsg;
76class RefreshMsg;
77class StatusMsg;
78class UpdateMsg;
79class GenericMsg;
80class PostMsg;
81class AckMsg;
82class ElementList;
83class FieldList;
84class Map;
85class Vector;
86class Series;
87class FilterList;
88class OmmOpaque;
89class OmmXml;
90class OmmAnsiPage;
91class OmmError;
92
93class MapDecoder;
94
96{
97public :
98
103 {
104 UpdateEnum = 1,
106 AddEnum = 2,
108 DeleteEnum = 3
109 };
110
112
113
117
124
128 const EmaString& toString() const;
129
133 bool hasPermissionData() const;
134
139 const ReqMsg& getReqMsg() const;
140
145 const RefreshMsg& getRefreshMsg() const;
146
151 const UpdateMsg& getUpdateMsg() const;
152
157 const StatusMsg& getStatusMsg() const;
158
163 const PostMsg& getPostMsg() const;
164
169 const AckMsg& getAckMsg() const;
170
175 const GenericMsg& getGenericMsg() const;
176
181 const FieldList& getFieldList() const;
182
188
193 const Map& getMap() const;
194
199 const Vector& getVector() const;
200
205 const Series& getSeries() const;
206
211 const FilterList& getFilterList() const;
212
217 const OmmOpaque& getOpaque() const;
218
223 const OmmXml& getXml() const;
224
229 const OmmAnsiPage& getAnsiPage() const;
230
234 const Data& getLoad() const;
235
239 const Key& getKey() const;
240
245
251
256 const OmmError& getError() const;
258
259private :
260
261 friend class Map;
262
263 MapDecoder* _pDecoder;
264 const Data* _pLoad;
265 Key _key;
266
267 mutable EmaString _toString;
268
269 MapEntry();
270 virtual ~~MapEntry();
271
272 MapEntry( const MapEntry& );
273 MapEntry& operator=( const MapEntry& );
274};
275
276}
277
278}
279
280}
281
282#endif // __refinitiv_ema_access_MapEntry_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
The access namespace contains all interfaces and definitions specified for use with the EMA Access pa...
The ema namespace contains all interfaces and definitions specified for use with EMA.
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:69
Data class is a parent abstract class defining common interfaces for all Data type classes.
Definition: Data.h:39
ElementList is a heterogeneous container of complex and primitive data type entries.
Definition: ElementList.h:178
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:33
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:57
FieldList is a heterogeneous container of complex and primitive data type entries.
Definition: FieldList.h:180
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:134
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:88
Key conveys MapEntry key information.
Definition: Key.h:88
Map is a homogeneous container of complex data type entries.
Definition: Map.h:126
MapEntry represents an entry of Map.
Definition: MapEntry.h:96
const OmmOpaque & getOpaque() const
const PostMsg & getPostMsg() const
const Vector & getVector() const
const UpdateMsg & getUpdateMsg() const
const FieldList & getFieldList() const
const StatusMsg & getStatusMsg() const
const ElementList & getElementList() const
const GenericMsg & getGenericMsg() const
const Series & getSeries() const
const OmmAnsiPage & getAnsiPage() const
const EmaString & getMapActionAsString() const
const EmaString & toString() const
const AckMsg & getAckMsg() const
const FilterList & getFilterList() const
const RefreshMsg & getRefreshMsg() const
const Data & getLoad() const
const OmmError & getError() const
const ReqMsg & getReqMsg() const
DataType::DataTypeEnum getLoadType() const
const OmmXml & getXml() const
const EmaBuffer & getPermissionData() const
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:73
OmmError represents received Omm data who fails to process properly.
Definition: OmmError.h:63
OmmOpaque represents Opaque data format in Omm.
Definition: OmmOpaque.h:73
OmmXml represents XML data format in Omm.
Definition: OmmXml.h:73
PostMsg allows consumer applications to contribute content.
Definition: PostMsg.h:63
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:80
ReqMsg allows consumer application to express its interest in an item.
Definition: ReqMsg.h:60
Series is a homogeneous container of complex data type entries.
Definition: Series.h:130
StatusMsg conveys item state information.
Definition: StatusMsg.h:81
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:73
Vector is a homogeneous container of complex data type entries.
Definition: Vector.h:123