EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 Refinitiv. All rights reserved. --
6  *|-----------------------------------------------------------------------------
7  */
8 
9 #ifndef __thomsonreuters_ema_access_FilterEntry_h
10 #define __thomsonreuters_ema_access_FilterEntry_h
11 
60 #include "Access/Include/Data.h"
61 
62 namespace thomsonreuters {
63 
64 namespace ema {
65 
66 namespace access {
67 
68 class ReqMsg;
69 class RefreshMsg;
70 class StatusMsg;
71 class UpdateMsg;
72 class GenericMsg;
73 class PostMsg;
74 class AckMsg;
75 class FieldList;
76 class ElementList;
77 class Map;
78 class Vector;
79 class Series;
80 class FilterList;
81 class OmmOpaque;
82 class OmmXml;
83 class OmmAnsiPage;
84 class OmmError;
85 
86 class FilterListDecoder;
87 
89 {
90 public :
91 
96  {
97  UpdateEnum = 1,
99  SetEnum = 2,
101  ClearEnum = 3
102  };
103 
105 
106 
109  const EmaString& getFilterActionAsString() const;
110 
116  DataType::DataTypeEnum getLoadType() const;
117 
121  const EmaString& toString() const;
122 
126  UInt8 getFilterId() const;
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 
185  const ElementList& getElementList() const;
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 
237  FilterAction getAction() const;
238 
243  const EmaBuffer& getPermissionData() const;
244 
249  const OmmError& getError() const;
251 
252 private :
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 // __thomsonreuters_ema_access_FilterEntry_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
EmaBuffer represents a general use binary buffer.
Definition: EmaBuffer.h:32
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
FilterEntry represents an entry of FilterList.
Definition: FilterEntry.h:88
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
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32
OmmAnsiPage represents AnsiPage data format in Omm.
Definition: OmmAnsiPage.h:72