EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FieldEntry.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_FieldEntry_h
10 #define __thomsonreuters_ema_access_FieldEntry_h
11 
62 #include "Access/Include/Data.h"
63 
64 namespace thomsonreuters {
65 
66 namespace ema {
67 
68 namespace access {
69 
70 class ReqMsg;
71 class RefreshMsg;
72 class StatusMsg;
73 class UpdateMsg;
74 class GenericMsg;
75 class PostMsg;
76 class AckMsg;
77 class ElementList;
78 class FieldList;
79 class Map;
80 class Vector;
81 class Series;
82 class FilterList;
83 class OmmArray;
84 class OmmOpaque;
85 class OmmXml;
86 class OmmAnsiPage;
87 class OmmReal;
88 class OmmDate;
89 class OmmTime;
90 class OmmDateTime;
91 class OmmQos;
92 class OmmState;
93 class OmmError;
94 class RmtesBuffer;
95 
96 class FieldListDecoder;
97 
99 {
100 public :
101 
103 
104 
109  DataType::DataTypeEnum getLoadType() const;
110 
115  Data::DataCode getCode() const;
116 
120  const EmaString& toString() const;
121 
125  Int16 getFieldId() const;
126 
131  const EmaString& getName() const;
132 
139  Int16 getRippleTo( Int16 fieldId = 0 ) const;
140 
147  const EmaString& getRippleToName(Int16 fieldId = 0) const;
148 
152  const Data& getLoad() const;
153 
158  const ReqMsg& getReqMsg() const;
159 
164  const RefreshMsg& getRefreshMsg() const;
165 
170  const UpdateMsg& getUpdateMsg() const;
171 
176  const StatusMsg& getStatusMsg() const;
177 
182  const PostMsg& getPostMsg() const;
183 
188  const AckMsg& getAckMsg() const;
189 
194  const GenericMsg& getGenericMsg() const;
195 
200  const FieldList& getFieldList() const;
201 
206  const ElementList& getElementList() const;
207 
212  const Map& getMap() const;
213 
218  const Vector& getVector() const;
219 
224  const Series& getSeries() const;
225 
230  const FilterList& getFilterList() const;
231 
237  const OmmOpaque& getOpaque() const;
238 
244  const OmmXml& getXml() const;
245 
251  const OmmAnsiPage& getAnsiPage() const;
252 
258  Int64 getInt() const;
259 
265  UInt64 getUInt() const;
266 
272  const OmmReal& getReal() const;
273 
279  float getFloat() const;
280 
286  double getDouble() const;
287 
293  const OmmDate& getDate() const;
294 
300  const OmmTime& getTime() const;
301 
307  const OmmDateTime& getDateTime() const;
308 
314  const OmmQos& getQos() const;
315 
321  const OmmState& getState() const;
322 
328  UInt16 getEnum() const;
329 
333  bool hasEnumDisplay() const;
334 
342  const EmaString& getEnumDisplay() const;
343 
349  const EmaBuffer& getBuffer() const;
350 
356  const EmaString& getAscii() const;
357 
363  const EmaBuffer& getUtf8() const;
364 
370  const RmtesBuffer& getRmtes() const;
371 
377  const OmmArray& getArray() const;
378 
383  const OmmError& getError() const;
385 
386 private :
387 
388  friend class FieldList;
389 
390  FieldListDecoder* _pDecoder;
391  const Data* const* _pLoad;
392 
393  mutable EmaString _toString;
394 
395  FieldEntry();
396  virtual ~FieldEntry();
397 
398  FieldEntry( const FieldEntry&);
399  FieldEntry& operator=( const FieldEntry& );
400 };
401 
402 }
403 
404 }
405 
406 }
407 
408 #endif // __thomsonreuters_ema_access_FieldEntry_h
FieldEntry represents an entry of FieldList.
Definition: FieldEntry.h:98
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
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:72
short Int16
represents 16-bit signed integer
Definition: Common.h:50