EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VectorEntry.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_VectorEntry_h
10 #define __thomsonreuters_ema_access_VectorEntry_h
11 
59 
60 namespace thomsonreuters {
61 
62 namespace ema {
63 
64 namespace access {
65 
66 class ReqMsg;
67 class RefreshMsg;
68 class StatusMsg;
69 class UpdateMsg;
70 class GenericMsg;
71 class PostMsg;
72 class AckMsg;
73 class FieldList;
74 class ElementList;
75 class Map;
76 class Series;
77 class FilterList;
78 class OmmOpaque;
79 class OmmXml;
80 class OmmAnsiPage;
81 class Vector;
82 class OmmError;
83 
84 class VectorDecoder;
85 
87 {
88 public :
89 
94  {
95  UpdateEnum = 1,
97  SetEnum = 2,
99  ClearEnum = 3,
101  InsertEnum = 4,
106  DeleteEnum = 5
109  };
110 
112 
113 
116  const EmaString& getVectorActionAsString() const;
117 
123  DataType::DataTypeEnum getLoadType() const;
124 
128  const EmaString& toString() const;
129 
133  bool hasPermissionData() const;
134 
138  UInt32 getPosition() const;
139 
144  const ReqMsg& getReqMsg() const;
145 
150  const RefreshMsg& getRefreshMsg() const;
151 
156  const UpdateMsg& getUpdateMsg() const;
157 
162  const StatusMsg& getStatusMsg() const;
163 
168  const PostMsg& getPostMsg() const;
169 
174  const AckMsg& getAckMsg() const;
175 
180  const GenericMsg& getGenericMsg() const;
181 
186  const FieldList& getFieldList() const;
187 
192  const ElementList& getElementList() const;
193 
198  const Map& getMap() const;
199 
204  const Vector& getVector() const;
205 
210  const Series& getSeries() const;
211 
216  const FilterList& getFilterList() const;
217 
222  const OmmOpaque& getOpaque() const;
223 
228  const OmmXml& getXml() const;
229 
234  const OmmAnsiPage& getAnsiPage() const;
235 
239  const Data& getLoad() const;
240 
244  VectorAction getAction() const;
245 
250  const EmaBuffer& getPermissionData() const;
251 
256  const OmmError& getError() const;
258 
259 private :
260 
261  friend class Vector;
262 
263  VectorDecoder* _pDecoder;
264  const Data* _pLoad;
265 
266  mutable EmaString _toString;
267 
268  VectorEntry();
269  virtual ~VectorEntry();
270 
271  VectorEntry( const VectorEntry& );
272  VectorEntry& operator=( const VectorEntry& );
273 };
274 
275 }
276 
277 }
278 
279 }
280 
281 #endif // __thomsonreuters_ema_access_VectorEntry_h
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:132
unsigned int UInt32
represents 32-bit unsigned integer
Definition: Common.h:56
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
VectorEntry represents an entry of Vector.
Definition: VectorEntry.h:86
GenericMsg allows applications to bidirectionally send messages without any implied message semantics...
Definition: GenericMsg.h:86
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