EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SummaryData.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_Summary_h
10 #define __thomsonreuters_ema_access_Summary_h
11 
71 
72 namespace thomsonreuters {
73 
74 namespace ema {
75 
76 namespace access {
77 
78 class ReqMsg;
79 class RefreshMsg;
80 class UpdateMsg;
81 class StatusMsg;
82 class GenericMsg;
83 class PostMsg;
84 class AckMsg;
85 class FieldList;
86 class ElementList;
87 class Map;
88 class Vector;
89 class Series;
90 class FilterList;
91 class OmmOpaque;
92 class OmmXml;
93 class OmmAnsiPage;
94 class OmmError;
95 
96 class Decoder;
97 
99 {
100 public:
101 
103 
104 
109  DataType::DataTypeEnum getDataType() const;
110 
114  const ComplexType& getData() const;
115 
120  const ReqMsg& getReqMsg() const;
121 
126  const RefreshMsg& getRefreshMsg() const;
127 
132  const UpdateMsg& getUpdateMsg() const;
133 
138  const StatusMsg& getStatusMsg() const;
139 
144  const PostMsg& getPostMsg() const;
145 
150  const AckMsg& getAckMsg() const;
151 
156  const GenericMsg& getGenericMsg() const;
157 
162  const FieldList& getFieldList() const;
163 
168  const ElementList& getElementList() const;
169 
174  const Map& getMap() const;
175 
180  const Vector& getVector() const;
181 
186  const Series& getSeries() const;
187 
192  const FilterList& getFilterList() const;
193 
198  const OmmOpaque& getOpaque() const;
199 
204  const OmmXml& getXml() const;
205 
210  const OmmAnsiPage& getAnsiPage() const;
211 
216  const OmmError& getError() const;
218 
220 
221 
223  virtual ~SummaryData();
225 
226 private :
227 
228  friend class Map;
229  friend class Series;
230  friend class Vector;
231 
232  Decoder* _pDecoder;
233 
234  SummaryData();
235  SummaryData( const SummaryData& );
236  SummaryData& operator=( const SummaryData& );
237 };
238 
239 }
240 
241 }
242 
243 }
244 
245 #endif // __thomsonreuters_ema_access_Summary_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
OmmError represents received Omm data who fails to process properly.
Definition: OmmError.h:62
SummaryData is used to convey Omm SummaryData information optionally present on Map, Series and Vector.
Definition: SummaryData.h:98
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
ComplexType class is a parent class from whom all complex data types inherit.
Definition: ComplexType.h:33
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
AckMsg indicates success or failure of PostMsg.
Definition: AckMsg.h:67
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:72