EMA C++ Edition
List of all members
refinitiv::ema::access::FieldEntry Class Reference

FieldEntry represents an entry of FieldList. More...

Accessors

class FieldList
 
DataType::DataTypeEnum getLoadType () const
  More...
 
Data::DataCode getCode () const
  More...
 
const EmaStringtoString () const
  More...
 
Int16 getFieldId () const
  More...
 
const EmaStringgetName () const
  More...
 
Int16 getRippleTo (Int16 fieldId=0) const
  More...
 
const EmaStringgetRippleToName (Int16 fieldId=0) const
  More...
 
const DatagetLoad () const
  More...
 
const ReqMsggetReqMsg () const
  More...
 
const RefreshMsggetRefreshMsg () const
  More...
 
const UpdateMsggetUpdateMsg () const
  More...
 
const StatusMsggetStatusMsg () const
  More...
 
const PostMsggetPostMsg () const
  More...
 
const AckMsggetAckMsg () const
  More...
 
const GenericMsggetGenericMsg () const
  More...
 
const FieldListgetFieldList () const
  More...
 
const ElementListgetElementList () const
  More...
 
const MapgetMap () const
  More...
 
const VectorgetVector () const
  More...
 
const SeriesgetSeries () const
  More...
 
const FilterListgetFilterList () const
  More...
 
const OmmOpaquegetOpaque () const
  More...
 
const OmmXmlgetXml () const
  More...
 
const OmmAnsiPagegetAnsiPage () const
  More...
 
Int64 getInt () const
  More...
 
UInt64 getUInt () const
  More...
 
const OmmRealgetReal () const
  More...
 
float getFloat () const
  More...
 
double getDouble () const
  More...
 
const OmmDategetDate () const
  More...
 
const OmmTimegetTime () const
  More...
 
const OmmDateTimegetDateTime () const
  More...
 
const OmmQosgetQos () const
  More...
 
const OmmStategetState () const
  More...
 
UInt16 getEnum () const
  More...
 
bool hasEnumDisplay () const
  More...
 
const EmaStringgetEnumDisplay () const
  More...
 
const EmaBuffergetBuffer () const
  More...
 
const EmaStringgetAscii () const
  More...
 
const EmaBuffergetUtf8 () const
  More...
 
const RmtesBuffergetRmtes () const
  More...
 
const OmmArraygetArray () const
  More...
 
const OmmErrorgetError () const
  More...
 

Detailed Description

FieldEntry associates entry's field id, name, data and its data type.

decodeFieldList( const FieldList& fList )
{
while ( fList.forth() )
{
const FieldEntry& fieldEntry = fList.getEntry();
Int32 fieldId = fieldEntry.getFieldId();
...
}
}
int Int32
represents 32-bit signed integer
Definition: Common.h:62
Remarks
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform extracting of data from entry.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See also
Data, ComplexType ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaBuffer, EmaString

Definition at line 98 of file FieldEntry.h.

Member Function Documentation

◆ getAckMsg()

const AckMsg& refinitiv::ema::access::FieldEntry::getAckMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not AckMsg
Returns
AckMsg class reference to contained object

◆ getAnsiPage()

const OmmAnsiPage& refinitiv::ema::access::FieldEntry::getAnsiPage ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmAnsiPage
Returns
OmmAnsiPage class reference to contained object

◆ getArray()

const OmmArray& refinitiv::ema::access::FieldEntry::getArray ( ) const

Returns current OMM data represented as an OmmArray.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmArray
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmArray class reference to contained object

◆ getAscii()

const EmaString& refinitiv::ema::access::FieldEntry::getAscii ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmAscii
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
EmaString

◆ getBuffer()

const EmaBuffer& refinitiv::ema::access::FieldEntry::getBuffer ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmBuffer
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
EmaBuffer

◆ getCode()

Data::DataCode refinitiv::ema::access::FieldEntry::getCode ( ) const

Returns the Code of the entry's load. The code indicates a special state of a Data.

Remarks
Attempts to extract data will cause OmmInvalidUsageException if Data::BlankEnum is returned.
Returns
data code of the contained object

◆ getDate()

const OmmDate& refinitiv::ema::access::FieldEntry::getDate ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmData
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmDate class reference to contained object

◆ getDateTime()

const OmmDateTime& refinitiv::ema::access::FieldEntry::getDateTime ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmDateTime
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmDateTime class reference to contained object

◆ getDouble()

double refinitiv::ema::access::FieldEntry::getDouble ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmDouble
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
double

◆ getElementList()

const ElementList& refinitiv::ema::access::FieldEntry::getElementList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ElementList
Returns
ElementList class reference to contained object

◆ getEnum()

UInt16 refinitiv::ema::access::FieldEntry::getEnum ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmEnum
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
UInt16

◆ getEnumDisplay()

const EmaString& refinitiv::ema::access::FieldEntry::getEnumDisplay ( ) const

Returns the display value for the OmmEnum type. Calling this method must be preceded by a call to hasEnumDisplay().

Exceptions
OmmInvalidUsageExceptionif hasEnumDisplay() returns false
OmmInvalidUsageExceptionif contained object is not OmmEnum
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
EmaString containing the display value

◆ getError()

const OmmError& refinitiv::ema::access::FieldEntry::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained object

◆ getFieldId()

Int16 refinitiv::ema::access::FieldEntry::getFieldId ( ) const

Returns FieldId.

Returns
field id

◆ getFieldList()

const FieldList& refinitiv::ema::access::FieldEntry::getFieldList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FieldList
Returns
FieldList class reference to contained object

◆ getFilterList()

const FilterList& refinitiv::ema::access::FieldEntry::getFilterList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FilterList
Returns
FilterList class reference to contained object

◆ getFloat()

float refinitiv::ema::access::FieldEntry::getFloat ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmFloat
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
float

◆ getGenericMsg()

const GenericMsg& refinitiv::ema::access::FieldEntry::getGenericMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not GenericMsg
Returns
GenericMsg class reference to contained object

◆ getInt()

Int64 refinitiv::ema::access::FieldEntry::getInt ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmInt
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
Int64

◆ getLoad()

const Data& refinitiv::ema::access::FieldEntry::getLoad ( ) const

Returns the contained Data based on the DataType.

Returns
Data class reference to contained object

◆ getLoadType()

DataType::DataTypeEnum refinitiv::ema::access::FieldEntry::getLoadType ( ) const

Returns the DataType of the entry's load.

Remarks
return of DataType::NoDataEnum signifies no data present in load
return of DataType::OmmErrorEnum signifies error while extracting content of load
Returns
data type of the contained object

◆ getMap()

const Map& refinitiv::ema::access::FieldEntry::getMap ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Map
Returns
Map class reference to contained object

◆ getName()

const EmaString& refinitiv::ema::access::FieldEntry::getName ( ) const

Returns acronym field name associated to the FieldId from the field dictionary.

Remarks
Returns empty string if FieldId is not found in field dictionary.
Returns
EmaString containing name of the entry

◆ getOpaque()

const OmmOpaque& refinitiv::ema::access::FieldEntry::getOpaque ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmOpaque
Returns
OmmOpaque class reference to contained object

◆ getPostMsg()

const PostMsg& refinitiv::ema::access::FieldEntry::getPostMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not PostMsg
Returns
PostMsg class reference to contained object

◆ getQos()

const OmmQos& refinitiv::ema::access::FieldEntry::getQos ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmQos
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmQos class reference to contained object

◆ getReal()

const OmmReal& refinitiv::ema::access::FieldEntry::getReal ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmReal
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmReal class reference to contained object

◆ getRefreshMsg()

const RefreshMsg& refinitiv::ema::access::FieldEntry::getRefreshMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not RefreshMsg
Returns
RefreshMsg class reference to contained object

◆ getReqMsg()

const ReqMsg& refinitiv::ema::access::FieldEntry::getReqMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ReqMsg
Returns
ReqMsg class reference to contained object

◆ getRippleTo()

Int16 refinitiv::ema::access::FieldEntry::getRippleTo ( Int16  fieldId = 0) const

Returns a ripple FieldId if the current entry has a ripple field. A subsequent call using the former non-zero return value as a formal parameter, returns the next ripple field in a ripple sequence.

Parameters
[in]fieldId
Returns
ripple field id; zero if no ripple field or the final ripple field of a ripple sequence.

◆ getRippleToName()

const EmaString& refinitiv::ema::access::FieldEntry::getRippleToName ( Int16  fieldId = 0) const

Returns a ripple field name if the current entry has a ripple field. A subsequent call using the former non-zero return value as a formal parameter, returns the next ripple field in a ripple sequence.

Parameters
[in]fieldId
Returns
ripple field name; empty string if no ripple field or the final ripple field of a ripple sequence.

◆ getRmtes()

const RmtesBuffer& refinitiv::ema::access::FieldEntry::getRmtes ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmRmtes
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
RmtesBuffer

◆ getSeries()

const Series& refinitiv::ema::access::FieldEntry::getSeries ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Series
Returns
Series class reference to contained object

◆ getState()

const OmmState& refinitiv::ema::access::FieldEntry::getState ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmState
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmState class reference to contained object

◆ getStatusMsg()

const StatusMsg& refinitiv::ema::access::FieldEntry::getStatusMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not StatusMsg
Returns
StatusMsg class reference to contained object

◆ getTime()

const OmmTime& refinitiv::ema::access::FieldEntry::getTime ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmTime
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
ommTime class reference to contained object

◆ getUInt()

UInt64 refinitiv::ema::access::FieldEntry::getUInt ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmUInt
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
UInt64

◆ getUpdateMsg()

const UpdateMsg& refinitiv::ema::access::FieldEntry::getUpdateMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not UpdateMsg
Returns
UpdateMsg class reference to contained object

◆ getUtf8()

const EmaBuffer& refinitiv::ema::access::FieldEntry::getUtf8 ( ) const

Returns the current OMM data represented as a specific simple type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmUtf8
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
EmaBuffer

◆ getVector()

const Vector& refinitiv::ema::access::FieldEntry::getVector ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Vector
Returns
Vector class reference to contained object

◆ getXml()

const OmmXml& refinitiv::ema::access::FieldEntry::getXml ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmXml
Returns
OmmXml class reference to contained object

◆ hasEnumDisplay()

bool refinitiv::ema::access::FieldEntry::hasEnumDisplay ( ) const

Indicates presence of the display value for the OmmEnum type.

Returns
true if the display value exists; false otherwise

◆ toString()

const EmaString& refinitiv::ema::access::FieldEntry::toString ( ) const

Returns a string representation of the class instance.

Returns
string representation of the class instance