EMA C++ Edition
FilterEntry.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_FilterEntry_h
10#define __refinitiv_ema_access_FilterEntry_h
11
60#include "Access/Include/Data.h"
61
62namespace refinitiv {
63
64namespace ema {
65
66namespace access {
67
68class ReqMsg;
69class RefreshMsg;
70class StatusMsg;
71class UpdateMsg;
72class GenericMsg;
73class PostMsg;
74class AckMsg;
75class FieldList;
76class ElementList;
77class Map;
78class Vector;
79class Series;
80class FilterList;
81class OmmOpaque;
82class OmmXml;
83class OmmAnsiPage;
84class OmmError;
85
86class FilterListDecoder;
87
89{
90public :
91
96 {
97 UpdateEnum = 1,
99 SetEnum = 2,
101 ClearEnum = 3
102 };
103
105
106
110
117
121 const EmaString& toString() const;
122
127
131 bool hasPermissionData() const;
132
137 const ReqMsg& getReqMsg() const;
138
143 const RefreshMsg& getRefreshMsg() const;
144
149 const UpdateMsg& getUpdateMsg() const;
150
155 const StatusMsg& getStatusMsg() const;
156
161 const PostMsg& getPostMsg() const;
162
167 const AckMsg& getAckMsg() const;
168
173 const GenericMsg& getGenericMsg() const;
174
179 const FieldList& getFieldList() const;
180
186
191 const Map& getMap() const;
192
197 const Vector& getVector() const;
198
203 const Series& getSeries() const;
204
209 const FilterList& getFilterList() const;
210
215 const OmmOpaque& getOpaque() const;
216
221 const OmmXml& getXml() const;
222
227 const OmmAnsiPage& getAnsiPage() const;
228
232 const Data& getLoad() const;
233
238
244
249 const OmmError& getError() const;
251
252private :
253
254 friend class FilterList;
255
256 FilterListDecoder* _pDecoder;
257 const Data* _pLoad;
258
259 mutable EmaString _toString;
260
261 FilterEntry();
262 virtual ~~FilterEntry();
263
264 FilterEntry( const FilterEntry& );
265 FilterEntry& operator=( const FilterEntry& );
266};
267
268}
269
270}
271
272}
273
274#endif // __refinitiv_ema_access_FilterEntry_h
#define EMA_ACCESS_API
Definition: Common.h:95
*|--------------------------------------------------------------------------—
Definition: AckMsg.h:62
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32
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
FieldList is a heterogeneous container of complex and primitive data type entries.
Definition: FieldList.h:180
FilterEntry represents an entry of FilterList.
Definition: FilterEntry.h:89
const OmmOpaque & getOpaque() const
const GenericMsg & getGenericMsg() const
const ReqMsg & getReqMsg() const
const UpdateMsg & getUpdateMsg() const
const RefreshMsg & getRefreshMsg() const
DataType::DataTypeEnum getLoadType() const
const OmmXml & getXml() const
const StatusMsg & getStatusMsg() const
const FilterList & getFilterList() const
const ElementList & getElementList() const
const FieldList & getFieldList() const
const AckMsg & getAckMsg() const
const OmmAnsiPage & getAnsiPage() const
const EmaString & getFilterActionAsString() const
const OmmError & getError() const
const PostMsg & getPostMsg() const
const Vector & getVector() const
const Series & getSeries() const
const EmaBuffer & getPermissionData() const
const EmaString & toString() const
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
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
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
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