EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Payload.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_Payload_h
10 #define __thomsonreuters_ema_access_Payload_h
11 
76 
77 namespace thomsonreuters {
78 
79 namespace ema {
80 
81 namespace access {
82 
83 class ReqMsg;
84 class RefreshMsg;
85 class UpdateMsg;
86 class StatusMsg;
87 class GenericMsg;
88 class PostMsg;
89 class AckMsg;
90 class FieldList;
91 class ElementList;
92 class Map;
93 class Vector;
94 class Series;
95 class FilterList;
96 class OmmOpaque;
97 class OmmXml;
98 class OmmAnsiPage;
99 class OmmError;
100 
101 class MsgDecoder;
102 
104 {
105 public :
106 
108 
109 
114  DataType::DataTypeEnum getDataType() const;
115 
119  const ComplexType& getData() const;
120 
125  const ReqMsg& getReqMsg() const;
126 
131  const RefreshMsg& getRefreshMsg() const;
132 
137  const UpdateMsg& getUpdateMsg() const;
138 
143  const StatusMsg& getStatusMsg() const;
144 
149  const PostMsg& getPostMsg() const;
150 
155  const AckMsg& getAckMsg() const;
156 
161  const GenericMsg& getGenericMsg() const;
162 
167  const FieldList& getFieldList() const;
168 
173  const ElementList& getElementList() const;
174 
179  const Map& getMap() const;
180 
185  const Vector& getVector() const;
186 
191  const Series& getSeries() const;
192 
197  const FilterList& getFilterList() const;
198 
203  const OmmOpaque& getOpaque() const;
204 
209  const OmmXml& getXml() const;
210 
215  const OmmAnsiPage& getAnsiPage() const;
216 
221  const OmmError& getError() const;
223 
225 
226 
228  virtual ~Payload();
230 
231 private :
232 
233  friend class Msg;
234 
235  const Data* _pPayload;
236 
237  Payload();
238  Payload( const Payload& );
239  Payload& operator=( const Payload& );
240 };
241 
242 }
243 
244 }
245 
246 }
247 
248 #endif // __thomsonreuters_ema_access_Payload_h
FilterList is a heterogeneous container of complex data type entries.
Definition: FilterList.h:132
Msg class is a parent class for all message representing classes.
Definition: Msg.h:45
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
Payload conveys the data part of item image.
Definition: Payload.h:103
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
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