EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Key.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_key_h
10 #define __thomsonreuters_ema_access_key_h
11 
70 #include "Access/Include/Data.h"
71 
72 namespace thomsonreuters {
73 
74 namespace ema {
75 
76 namespace access {
77 
78 class OmmReal;
79 class OmmDate;
80 class OmmTime;
81 class OmmDateTime;
82 class OmmQos;
83 class OmmState;
84 class OmmError;
85 class RmtesBuffer;
86 
88 {
89 public :
90 
92 
93 
97  DataType::DataTypeEnum getDataType() const;
98 
102  const Data& getData() const;
103 
108  Int64 getInt() const;
109 
114  UInt64 getUInt() const;
115 
120  const OmmReal& getReal() const;
121 
126  float getFloat() const;
127 
132  double getDouble() const;
133 
138  const OmmDate& getDate() const;
139 
144  const OmmTime& getTime() const;
145 
150  const OmmDateTime& getDateTime() const;
151 
156  const OmmQos& getQos() const;
157 
162  const OmmState& getState() const;
163 
168  UInt16 getEnum() const;
169 
174  const EmaBuffer& getBuffer() const;
175 
180  const EmaString& getAscii() const;
181 
186  const EmaBuffer& getUtf8() const;
187 
192  const RmtesBuffer& getRmtes() const;
193 
198  const OmmError& getError() const;
200 
202 
203 
205  virtual ~Key();
207 
208 private :
209 
210  friend class Map;
211  friend class MapEntry;
212 
213  const Data* _pData;
214 
215  Key();
216  Key( const Key& );
217  Key& operator=( const Key& );
218 };
219 
220 }
221 
222 }
223 
224 }
225 
226 #endif // __thomsonreuters_ema_access_key_h
long long Int64
represents 64-bit signed integer
Definition: Common.h:74
unsigned short UInt16
represents 16-bit unsigned integer
Definition: Common.h:44
unsigned long long UInt64
represents 64-bit unsigned integer
Definition: Common.h:68
OmmDateTime represents DateTime info in Omm.
Definition: OmmDateTime.h:63
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
#define EMA_ACCESS_API
Definition: Common.h:95
OmmReal represents Real number in Omm.
Definition: OmmReal.h:71
OmmDate represents Date info in Omm.
Definition: OmmDate.h:69
MapEntry represents an entry of Map.
Definition: MapEntry.h:95
Key conveys MapEntry key information.
Definition: Key.h:87
OmmTime represents Time info in Omm.
Definition: OmmTime.h:69
OmmState represents State information in Omm.
Definition: OmmState.h:50
Map is a homogeneous container of complex data type entries.
Definition: Map.h:124
Data class is a parent abstract class defining common interfaces for all Data type classes...
Definition: Data.h:38
RmtesBuffer represents RMTES data.
Definition: RmtesBuffer.h:54