EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DictionaryEntry.h
Go to the documentation of this file.
1 /*|-----------------------------------------------------------------------------
2  *| and is provided AS IS with no warranty or guarantee of fit for purpose. --
3  *| See the project's LICENSE.md for details. --
4  *| Copyright (C) 2019 Refinitiv. All rights reserved. --
5  *|-----------------------------------------------------------------------------
6  */
7 
8 #ifndef __thomsonreuters_ema_rdm_DictionaryEntry_h
9 #define __thomsonreuters_ema_rdm_DictionaryEntry_h
10 
18 #include "Access/Include/Common.h"
21 
22 namespace thomsonreuters {
23 
24 namespace ema {
25 
26 namespace rdm {
27 
28 class EnumType;
29 class EnumTypeTable;
30 class DictionaryEntryImpl;
31 class DataDictionaryImpl;
32 
34 {
35 public:
36 
38 
39 
44  const thomsonreuters::ema::access::EmaString& getAcronym() const;
45 
51  const thomsonreuters::ema::access::EmaString& getDDEAcronym() const;
52 
59 
65  thomsonreuters::ema::access::Int16 getRippleToField() const;
66 
72  thomsonreuters::ema::access::Int8 getFieldType() const;
73 
79  thomsonreuters::ema::access::UInt16 getLength() const;
80 
86  thomsonreuters::ema::access::UInt8 getRwfType() const;
87 
93  thomsonreuters::ema::access::UInt8 getEnumLength() const;
94 
100  thomsonreuters::ema::access::UInt32 getRwfLength() const;
102 
104 
111  bool hasEnumType(thomsonreuters::ema::access::UInt16 value) const;
112 
121  const EnumType& getEnumType(thomsonreuters::ema::access::UInt16 value) const;
122 
128  bool hasEnumTypeTable() const;
129 
136  const EnumTypeTable& getEnumTypeTable() const;
137 
142  const thomsonreuters::ema::access::EmaString& toString() const;
143 
147  operator const char* () const;
149 
151 
152 
154  DictionaryEntry();
156 
158 
159 
162  virtual ~DictionaryEntry();
164 
165 private:
166 
167  friend class DictionaryEntryImpl;
168  friend class DataDictionaryImpl;
169 
170  template<class T>
172 
173  // isManagedByUser true when the instance is created by user; false when the instance is created by API
174  DictionaryEntry(bool isManagedByUser);
175 
176  DictionaryEntry(const DictionaryEntry&);
177 
178  DictionaryEntry& operator=(const DictionaryEntry&);
179 
180  DictionaryEntryImpl* _pImpl;
181 };
182 
183 }
184 
185 }
186 
187 }
188 
189 #endif // __thomsonreuters_ema_rdm_DictionaryEntry_h
190 
unsigned short UInt16
represents 16-bit unsigned integer
Definition: Common.h:44
EmaVector class provides template vector implementation.
Definition: EmaVector.h:29
unsigned int UInt32
represents 32-bit unsigned integer
Definition: Common.h:56
EmaString class is a container of a null terminated Ascii character string.
Definition: EmaString.h:56
#define EMA_ACCESS_API
Definition: Common.h:95
Common.h file provides definitions of common variable types used in EMA.
signed char Int8
represents 8-bit signed integer
Definition: Common.h:38
unsigned char UInt8
represents 8-bit unsigned integer
Definition: Common.h:32
EmaVector< T > & operator=(const EmaVector< T > &other)
Definition: EmaVector.h:189
short Int16
represents 16-bit signed integer
Definition: Common.h:50