EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Friends
thomsonreuters::ema::access::FieldEntry Class Reference

FieldEntry represents an entry of FieldList. More...

Public Member Functions

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

Friends

class FieldList
 

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();
...
}
}
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

const AckMsg& thomsonreuters::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
const OmmAnsiPage& thomsonreuters::ema::access::FieldEntry::getAnsiPage ( ) const

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

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmAnsiPage
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmAnsiPage class reference to contained object
const OmmArray& thomsonreuters::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
const EmaString& thomsonreuters::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
const EmaBuffer& thomsonreuters::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
Data::DataCode thomsonreuters::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
const OmmDate& thomsonreuters::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
const OmmDateTime& thomsonreuters::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
double thomsonreuters::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
const ElementList& thomsonreuters::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
UInt16 thomsonreuters::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
const EmaString& thomsonreuters::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
const OmmError& thomsonreuters::ema::access::FieldEntry::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained object
Int16 thomsonreuters::ema::access::FieldEntry::getFieldId ( ) const

Returns FieldId.

Returns
field id
const FieldList& thomsonreuters::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
const FilterList& thomsonreuters::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
float thomsonreuters::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
const GenericMsg& thomsonreuters::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
Int64 thomsonreuters::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
const Data& thomsonreuters::ema::access::FieldEntry::getLoad ( ) const

Returns the contained Data based on the DataType.

Returns
Data class reference to contained object
DataType::DataTypeEnum thomsonreuters::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
const Map& thomsonreuters::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
const EmaString& thomsonreuters::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
const OmmOpaque& thomsonreuters::ema::access::FieldEntry::getOpaque ( ) const

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

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmOpaque
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmOpaque class reference to contained object
const PostMsg& thomsonreuters::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
const OmmQos& thomsonreuters::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
const OmmReal& thomsonreuters::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
const RefreshMsg& thomsonreuters::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
const ReqMsg& thomsonreuters::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
Int16 thomsonreuters::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.
const EmaString& thomsonreuters::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.
const RmtesBuffer& thomsonreuters::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
const Series& thomsonreuters::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
const OmmState& thomsonreuters::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
const StatusMsg& thomsonreuters::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
const OmmTime& thomsonreuters::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
UInt64 thomsonreuters::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
const UpdateMsg& thomsonreuters::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
const EmaBuffer& thomsonreuters::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
const Vector& thomsonreuters::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
const OmmXml& thomsonreuters::ema::access::FieldEntry::getXml ( ) const

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

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmXml
OmmInvalidUsageExceptionif getCode() returns Data::BlankEnum
Returns
OmmXml class reference to contained object
bool thomsonreuters::ema::access::FieldEntry::hasEnumDisplay ( ) const

Indicates presence of the display value for the OmmEnum type.

Returns
true if the display value exists; false otherwise
const EmaString& thomsonreuters::ema::access::FieldEntry::toString ( ) const

Returns a string representation of the class instance.

Returns
string representation of the class instance

Friends And Related Function Documentation

friend class FieldList
friend

Definition at line 388 of file FieldEntry.h.