EMA C++ Edition
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 LSEG. All rights reserved. --
6 *|-----------------------------------------------------------------------------
7 */
8
9#ifndef __refinitiv_ema_access_FieldEntry_h
10#define __refinitiv_ema_access_FieldEntry_h
11
62#include "Access/Include/Data.h"
63
64namespace refinitiv {
65
66namespace ema {
67
68namespace access {
69
70class ReqMsg;
71class RefreshMsg;
72class StatusMsg;
73class UpdateMsg;
74class GenericMsg;
75class PostMsg;
76class AckMsg;
77class ElementList;
78class FieldList;
79class Map;
80class Vector;
81class Series;
82class FilterList;
83class OmmArray;
84class OmmOpaque;
85class OmmXml;
86class OmmAnsiPage;
87class OmmReal;
88class OmmDate;
89class OmmTime;
90class OmmDateTime;
91class OmmQos;
92class OmmState;
93class OmmError;
94class RmtesBuffer;
95
96class FieldListDecoder;
97
99{
100public :
101
103
104
110
116
120 const EmaString& toString() const;
121
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
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
236 const OmmOpaque& getOpaque() const;
237
242 const OmmXml& getXml() const;
243
248 const OmmAnsiPage& getAnsiPage() const;
249
255 Int64 getInt() const;
256
263
269 const OmmReal& getReal() const;
270
276 float getFloat() const;
277
283 double getDouble() const;
284
290 const OmmDate& getDate() const;
291
297 const OmmTime& getTime() const;
298
304 const OmmDateTime& getDateTime() const;
305
311 const OmmQos& getQos() const;
312
318 const OmmState& getState() const;
319
326
330 bool hasEnumDisplay() const;
331
339 const EmaString& getEnumDisplay() const;
340
346 const EmaBuffer& getBuffer() const;
347
353 const EmaString& getAscii() const;
354
360 const EmaBuffer& getUtf8() const;
361
367 const RmtesBuffer& getRmtes() const;
368
374 const OmmArray& getArray() const;
375
380 const OmmError& getError() const;
382
383private :
384
385 friend class FieldList;
386
387 FieldListDecoder* _pDecoder;
388 const Data* const* _pLoad;
389
390 mutable EmaString _toString;
391
392 FieldEntry();
393 virtual ~~FieldEntry();
394
395 FieldEntry( const FieldEntry&);
396 FieldEntry& operator=( const FieldEntry& );
397};
398
399}
400
401}
402
403}
404
405#endif // __refinitiv_ema_access_FieldEntry_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
short Int16
represents 16-bit signed integer
Definition: Common.h:50
long long Int64
represents 64-bit signed integer
Definition: Common.h:74
unsigned short UInt16
represents 16-bit unsigned integer
Definition: Common.h:44
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
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
FieldEntry represents an entry of FieldList.
Definition: FieldEntry.h:99
const UpdateMsg & getUpdateMsg() const
Int16 getRippleTo(Int16 fieldId=0) const
const EmaString & getRippleToName(Int16 fieldId=0) const
const PostMsg & getPostMsg() const
const OmmDate & getDate() const
const EmaString & getName() const
const OmmReal & getReal() const
DataType::DataTypeEnum getLoadType() const
const EmaString & toString() const
const EmaString & getAscii() const
const OmmAnsiPage & getAnsiPage() const
const RmtesBuffer & getRmtes() const
const OmmState & getState() const
const ElementList & getElementList() const
const AckMsg & getAckMsg() const
const Vector & getVector() const
const GenericMsg & getGenericMsg() const
const Series & getSeries() const
const OmmArray & getArray() const
const OmmQos & getQos() const
const EmaBuffer & getBuffer() const
const OmmXml & getXml() const
const OmmOpaque & getOpaque() const
Data::DataCode getCode() const
const EmaString & getEnumDisplay() const
const OmmTime & getTime() const
const ReqMsg & getReqMsg() const
const StatusMsg & getStatusMsg() const
const EmaBuffer & getUtf8() const
const FilterList & getFilterList() const
const RefreshMsg & getRefreshMsg() const
const OmmError & getError() const
const FieldList & getFieldList() const
const OmmDateTime & getDateTime() const
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
OmmArray is a homogeneous container of primitive data type entries.
Definition: OmmArray.h:87
OmmDate represents Date info in Omm.
Definition: OmmDate.h:70
OmmDateTime represents DateTime info in Omm.
Definition: OmmDateTime.h:64
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
OmmReal represents Real number in Omm.
Definition: OmmReal.h:72
OmmState represents State information in Omm.
Definition: OmmState.h:51
OmmTime represents Time info in Omm.
Definition: OmmTime.h:70
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
RmtesBuffer represents RMTES data.
Definition: RmtesBuffer.h:55
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