EMA C++ Edition
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 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_VectorEntry_h
10#define __refinitiv_ema_access_VectorEntry_h
11
59
60namespace refinitiv {
61
62namespace ema {
63
64namespace access {
65
66class ReqMsg;
67class RefreshMsg;
68class StatusMsg;
69class UpdateMsg;
70class GenericMsg;
71class PostMsg;
72class AckMsg;
73class FieldList;
74class ElementList;
75class Map;
76class Series;
77class FilterList;
78class OmmOpaque;
79class OmmXml;
80class OmmAnsiPage;
81class Vector;
82class OmmError;
83
84class VectorDecoder;
85
87{
88public :
89
94 {
95 UpdateEnum = 1,
97 SetEnum = 2,
99 ClearEnum = 3,
101 InsertEnum = 4,
106 DeleteEnum = 5
109 };
110
112
113
117
124
128 const EmaString& toString() const;
129
133 bool hasPermissionData() const;
134
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
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
245
251
256 const OmmError& getError() const;
258
259private :
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 // __refinitiv_ema_access_VectorEntry_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
unsigned int UInt32
represents 32-bit unsigned integer
Definition: Common.h:56
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
Map is a homogeneous container of complex data type entries.
Definition: Map.h:126
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
VectorEntry represents an entry of Vector.
Definition: VectorEntry.h:87
const Series & getSeries() const
const EmaString & toString() const
const FieldList & getFieldList() const
const GenericMsg & getGenericMsg() const
const AckMsg & getAckMsg() const
const EmaBuffer & getPermissionData() const
const OmmAnsiPage & getAnsiPage() const
const UpdateMsg & getUpdateMsg() const
const EmaString & getVectorActionAsString() const
DataType::DataTypeEnum getLoadType() const
const OmmError & getError() const
const StatusMsg & getStatusMsg() const
const OmmOpaque & getOpaque() const
const Vector & getVector() const
const OmmXml & getXml() const
const RefreshMsg & getRefreshMsg() const
const FilterList & getFilterList() const
const ElementList & getElementList() const
const ReqMsg & getReqMsg() const
const PostMsg & getPostMsg() const