EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Refinitiv. All rights reserved. --
6  *|-----------------------------------------------------------------------------
7  */
8 
9 #ifndef __thomsonreuters_ema_access_MapEntry_h
10 #define __thomsonreuters_ema_access_MapEntry_h
11 
67 #include "Access/Include/Key.h"
68 
69 namespace thomsonreuters {
70 
71 namespace ema {
72 
73 namespace access {
74 
75 class ReqMsg;
76 class RefreshMsg;
77 class StatusMsg;
78 class UpdateMsg;
79 class GenericMsg;
80 class PostMsg;
81 class AckMsg;
82 class ElementList;
83 class FieldList;
84 class Map;
85 class Vector;
86 class Series;
87 class FilterList;
88 class OmmOpaque;
89 class OmmXml;
90 class OmmAnsiPage;
91 class OmmError;
92 
93 class MapDecoder;
94 
96 {
97 public :
98 
103  {
104  UpdateEnum = 1,
106  AddEnum = 2,
108  DeleteEnum = 3
109  };
110 
112 
113 
116  const EmaString& getMapActionAsString() const;
117 
123  DataType::DataTypeEnum getLoadType() const;
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 
187  const ElementList& getElementList() const;
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 
244  MapAction getAction() const;
245 
250  const EmaBuffer& getPermissionData() const;
251 
256  const OmmError& getError() const;
258 
259 private :
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 // __thomsonreuters_ema_access_MapEntry_h
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:132
OmmOpaque represents Opaque data format in Omm.
Definition: OmmOpaque.h:72
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:56
OmmError represents received Omm data who fails to process properly.
Definition: OmmError.h:62
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:32
ReqMsg allows consumer application to express its interest in an item.
Definition: ReqMsg.h:58
#define EMA_ACCESS_API
Definition: Common.h:95
Vector is a homogeneous container of complex data type entries.
Definition: Vector.h:121
StatusMsg conveys item state information.
Definition: StatusMsg.h:79
RefreshMsg conveys item image, state, permission and group information.
Definition: RefreshMsg.h:78
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:86
MapEntry represents an entry of Map.
Definition: MapEntry.h:95
Key conveys MapEntry key information.
Definition: Key.h:87
ElementList is a heterogeneous container of complex and primitive data type entries.
Definition: ElementList.h:176
OmmXml represents XML data format in Omm.
Definition: OmmXml.h:72
FieldList is a heterogeneous container of complex and primitive data type entries.
Definition: FieldList.h:178
UpdateMsg conveys changes to item data.
Definition: UpdateMsg.h:71
Series is a homogeneous container of complex data type entries.
Definition: Series.h:128
Map is a homogeneous container of complex data type entries.
Definition: Map.h:124
PostMsg allows consumer applications to contribute content.
Definition: PostMsg.h:61
Data class is a parent abstract class defining common interfaces for all Data type classes...
Definition: Data.h:38
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:67
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:72