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

OmmArrayEntry represents an entry of OmmArray. More...

Accessors

class OmmArray
 
DataType::DataTypeEnum getLoadType () const
  More...
 
Data::DataCode getCode () const
  More...
 
const EmaStringtoString () const
  More...
 
const DatagetLoad () 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...
 
const EmaBuffergetBuffer () const
  More...
 
const EmaStringgetAscii () const
  More...
 
const EmaBuffergetUtf8 () const
  More...
 
const RmtesBuffergetRmtes () const
  More...
 
const OmmErrorgetError () const
  More...
 

Detailed Description

OmmArrayEntry associates entry's data and its data type.

decodeArray( const OmmArray& array )
{
while ( array.forth() )
{
const ArrayEntry& aEntry = array.getEntry();
if ( aEntry.getCode() != Data::BlankEnum )
switch ( aEntry.getLoadType() )
{
aEntry.getInt();
break;
}
}
}
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, OmmArray, EmaString, EmaBuffer, OmmReal, OmmDate, OmmTime, OmmDateTime, OmmQos, OmmState, OmmError

Definition at line 77 of file OmmArrayEntry.h.

Member Function Documentation

◆ getAscii()

const EmaString& refinitiv::ema::access::OmmArrayEntry::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::OmmArrayEntry::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::OmmArrayEntry::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::OmmArrayEntry::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::OmmArrayEntry::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::OmmArrayEntry::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

◆ getEnum()

UInt16 refinitiv::ema::access::OmmArrayEntry::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

◆ getError()

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

Returns Error.

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

◆ getFloat()

float refinitiv::ema::access::OmmArrayEntry::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

◆ getInt()

Int64 refinitiv::ema::access::OmmArrayEntry::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::OmmArrayEntry::getLoad ( ) const

Returns the contained Data based on the DataType.

Returns
Data class reference to contained object

◆ getLoadType()

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

Returns the DataType of the entry's load.

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

◆ getQos()

const OmmQos& refinitiv::ema::access::OmmArrayEntry::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::OmmArrayEntry::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

◆ getRmtes()

const RmtesBuffer& refinitiv::ema::access::OmmArrayEntry::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

◆ getState()

const OmmState& refinitiv::ema::access::OmmArrayEntry::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

◆ getTime()

const OmmTime& refinitiv::ema::access::OmmArrayEntry::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::OmmArrayEntry::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

◆ getUtf8()

const EmaBuffer& refinitiv::ema::access::OmmArrayEntry::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

◆ toString()

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

Returns a string representation of the class instance.

Returns
string representation of the class instance