EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ElementEntry.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_ElementEntry_h
10 #define __thomsonreuters_ema_access_ElementEntry_h
11 
60 #include "Access/Include/Data.h"
61 
62 namespace thomsonreuters {
63 
64 namespace ema {
65 
66 namespace access {
67 
68 class ReqMsg;
69 class RefreshMsg;
70 class StatusMsg;
71 class UpdateMsg;
72 class GenericMsg;
73 class PostMsg;
74 class AckMsg;
75 class FieldList;
76 class Map;
77 class Vector;
78 class Series;
79 class FilterList;
80 class OmmArray;
81 class OmmOpaque;
82 class OmmXml;
83 class OmmAnsiPage;
84 class OmmReal;
85 class OmmDate;
86 class OmmTime;
87 class OmmDateTime;
88 class OmmQos;
89 class OmmState;
90 class ElementList;
91 class OmmError;
92 class RmtesBuffer;
93 
94 class ElementListDecoder;
95 
97 {
98 public :
99 
101 
102 
107  DataType::DataTypeEnum getLoadType() const;
108 
113  Data::DataCode getCode() const;
114 
118  const EmaString& toString() const;
119 
123  const EmaString& getName() const;
124 
128  const Data& getLoad() const;
129 
134  const ReqMsg& getReqMsg() const;
135 
140  const RefreshMsg& getRefreshMsg() const;
141 
146  const UpdateMsg& getUpdateMsg() const;
147 
152  const StatusMsg& getStatusMsg() const;
153 
158  const PostMsg& getPostMsg() const;
159 
164  const AckMsg& getAckMsg() const;
165 
170  const GenericMsg& getGenericMsg() const;
171 
176  const FieldList& getFieldList() const;
177 
182  const ElementList& getElementList() const;
183 
188  const Map& getMap() const;
189 
194  const Vector& getVector() const;
195 
200  const Series& getSeries() const;
201 
206  const FilterList& getFilterList() const;
207 
213  const OmmOpaque& getOpaque() const;
214 
220  const OmmXml& getXml() const;
221 
227  const OmmAnsiPage& getAnsiPage() const;
228 
234  Int64 getInt() const;
235 
241  UInt64 getUInt() const;
242 
248  const OmmReal& getReal() const;
249 
255  float getFloat() const;
256 
262  double getDouble() const;
263 
269  const OmmDate& getDate() const;
270 
276  const OmmTime& getTime() const;
277 
283  const OmmDateTime& getDateTime() const;
284 
290  const OmmQos& getQos() const;
291 
297  const OmmState& getState() const;
298 
304  UInt16 getEnum() const;
305 
311  const EmaBuffer& getBuffer() const;
312 
318  const EmaString& getAscii() const;
319 
325  const EmaBuffer& getUtf8() const;
326 
332  const RmtesBuffer& getRmtes() const;
333 
339  const OmmArray& getArray() const;
340 
345  const OmmError& getError() const;
347 
348 private :
349 
350  friend class ElementList;
351 
352  ElementListDecoder* _pDecoder;
353  const Data* const* _pLoad;
354 
355  mutable EmaString _toString;
356 
357  ElementEntry();
358  virtual ~ElementEntry();
359 
360  ElementEntry( const ElementEntry& );
361  ElementEntry& operator=( const ElementEntry& );
362 };
363 
364 }
365 
366 }
367 
368 }
369 
370 #endif // __thomsonreuters_ema_access_ElementEntry_h
long long Int64
represents 64-bit signed integer
Definition: Common.h:74
unsigned short UInt16
represents 16-bit unsigned integer
Definition: Common.h:44
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:132
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
OmmDateTime represents DateTime info in Omm.
Definition: OmmDateTime.h:63
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
OmmReal represents Real number in Omm.
Definition: OmmReal.h:71
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
OmmDate represents Date info in Omm.
Definition: OmmDate.h:69
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
OmmArray is a homogeneous container of primitive data type entries.
Definition: OmmArray.h:85
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
OmmTime represents Time info in Omm.
Definition: OmmTime.h:69
OmmState represents State information in Omm.
Definition: OmmState.h:50
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
RmtesBuffer represents RMTES data.
Definition: RmtesBuffer.h:54
ElementEntry represents an entry of ElementList.
Definition: ElementEntry.h:96
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:72