EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SeriesEntry.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_SeriesEntry_h
10 #define __thomsonreuters_ema_access_SeriesEntry_h
11 
58 #include "Access/Include/Data.h"
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 Vector;
77 class FilterList;
78 class OmmOpaque;
79 class OmmXml;
80 class OmmAnsiPage;
81 class OmmError;
82 class Series;
83 
84 class SeriesDecoder;
85 
87 {
88 public :
89 
91 
92 
96  DataType::DataTypeEnum getLoadType() const;
97 
101  const EmaString& toString() const;
102 
107  const ReqMsg& getReqMsg() const;
108 
113  const RefreshMsg& getRefreshMsg() const;
114 
119  const UpdateMsg& getUpdateMsg() const;
120 
125  const StatusMsg& getStatusMsg() const;
126 
131  const PostMsg& getPostMsg() const;
132 
137  const AckMsg& getAckMsg() const;
138 
143  const GenericMsg& getGenericMsg() const;
144 
149  const FieldList& getFieldList() const;
150 
155  const ElementList& getElementList() const;
156 
161  const Map& getMap() const;
162 
167  const Vector& getVector() const;
168 
173  const Series& getSeries() const;
174 
179  const FilterList& getFilterList() const;
180 
185  const OmmOpaque& getOpaque() const;
186 
191  const OmmXml& getXml() const;
192 
197  const OmmAnsiPage& getAnsiPage() const;
198 
202  const Data& getLoad() const;
203 
208  const OmmError& getError() const;
210 
211 private :
212 
213  friend class Series;
214 
215  SeriesDecoder* _pDecoder;
216  const Data* _pLoad;
217 
218  mutable EmaString _toString;
219 
220  SeriesEntry();
221  virtual ~SeriesEntry();
222 
223  SeriesEntry( const SeriesEntry& );
224  SeriesEntry& operator=( const SeriesEntry& );
225 };
226 
227 }
228 
229 }
230 
231 }
232 
233 #endif //__thomsonreuters_ema_access_SeriesEntry_h
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:132
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
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
SeriesEntry represents an entry of Series.
Definition: SeriesEntry.h:86
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
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