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

ElementList is a heterogeneous container of complex and primitive data type entries. More...

Inheritance diagram for thomsonreuters::ema::access::ElementList:
thomsonreuters::ema::access::ComplexType thomsonreuters::ema::access::Data

Public Member Functions

Constructor
 ElementList ()
 
Destructor
virtual ~ElementList ()
 
Accessors
DataType::DataTypeEnum getDataType () const
 
Data::DataCode getCode () const
 
const EmaBuffergetAsHex () const
 
const EmaStringtoString () const
 
bool hasInfo () const
 
Int16 getInfoElementListNum () const
 
bool forth () const
 
bool forth (const EmaString &name) const
 
bool forth (const Data &data) const
 
const ElementEntrygetEntry () const
 
void reset () const
 
Operations
ElementListclear ()
 
ElementListinfo (Int16 elementListNum)
 
ElementListaddReqMsg (const EmaString &name, const ReqMsg &value)
 
ElementListaddRefreshMsg (const EmaString &name, const RefreshMsg &value)
 
ElementListaddStatusMsg (const EmaString &name, const StatusMsg &value)
 
ElementListaddUpdateMsg (const EmaString &name, const UpdateMsg &value)
 
ElementListaddPostMsg (const EmaString &name, const PostMsg &value)
 
ElementListaddAckMsg (const EmaString &name, const AckMsg &value)
 
ElementListaddGenericMsg (const EmaString &name, const GenericMsg &value)
 
ElementListaddFieldList (const EmaString &name, const FieldList &value)
 
ElementListaddElementList (const EmaString &name, const ElementList &value)
 
ElementListaddMap (const EmaString &name, const Map &value)
 
ElementListaddVector (const EmaString &name, const Vector &value)
 
ElementListaddSeries (const EmaString &name, const Series &value)
 
ElementListaddFilterList (const EmaString &name, const FilterList &value)
 
ElementListaddOpaque (const EmaString &name, const OmmOpaque &value)
 
ElementListaddXml (const EmaString &name, const OmmXml &value)
 
ElementListaddAnsiPage (const EmaString &name, const OmmAnsiPage &value)
 
ElementListaddInt (const EmaString &name, Int64 value)
 
ElementListaddUInt (const EmaString &name, UInt64 value)
 
ElementListaddReal (const EmaString &name, Int64 mantissa, OmmReal::MagnitudeType magnitudeType)
 
ElementListaddRealFromDouble (const EmaString &name, double value, OmmReal::MagnitudeType magnitudeType=OmmReal::Exponent0Enum)
 
ElementListaddFloat (const EmaString &name, float value)
 
ElementListaddDouble (const EmaString &name, double value)
 
ElementListaddDate (const EmaString &name, UInt16 year, UInt8 month, UInt8 day)
 
ElementListaddTime (const EmaString &name, UInt8 hour=0, UInt8 minute=0, UInt8 second=0, UInt16 millisecond=0, UInt16 microsecond=0, UInt16 nanosecond=0)
 
ElementListaddDateTime (const EmaString &name, UInt16 year, UInt8 month, UInt8 day, UInt8 hour=0, UInt8 minute=0, UInt8 second=0, UInt16 millisecond=0, UInt16 microsecond=0, UInt16 nanosecond=0)
 
ElementListaddQos (const EmaString &name, UInt32 timeliness=OmmQos::RealTimeEnum, UInt32 rate=OmmQos::TickByTickEnum)
 
ElementListaddState (const EmaString &name, OmmState::StreamState streamState=OmmState::OpenEnum, OmmState::DataState dataState=OmmState::OkEnum, UInt8 statusCode=OmmState::NoneEnum, const EmaString &statusText=EmaString())
 
ElementListaddEnum (const EmaString &name, UInt16 value)
 
ElementListaddBuffer (const EmaString &name, const EmaBuffer &value)
 
ElementListaddAscii (const EmaString &name, const EmaString &value)
 
ElementListaddUtf8 (const EmaString &name, const EmaBuffer &value)
 
ElementListaddRmtes (const EmaString &name, const EmaBuffer &value)
 
ElementListaddArray (const EmaString &name, const OmmArray &value)
 
ElementListaddCodeInt (const EmaString &name)
 
ElementListaddCodeUInt (const EmaString &name)
 
ElementListaddCodeReal (const EmaString &name)
 
ElementListaddCodeFloat (const EmaString &name)
 
ElementListaddCodeDouble (const EmaString &name)
 
ElementListaddCodeDate (const EmaString &name)
 
ElementListaddCodeTime (const EmaString &name)
 
ElementListaddCodeDateTime (const EmaString &name)
 
ElementListaddCodeQos (const EmaString &name)
 
ElementListaddCodeState (const EmaString &name)
 
ElementListaddCodeEnum (const EmaString &name)
 
ElementListaddCodeBuffer (const EmaString &name)
 
ElementListaddCodeAscii (const EmaString &name)
 
ElementListaddCodeUtf8 (const EmaString &name)
 
ElementListaddCodeRmtes (const EmaString &name)
 
ElementListadd (const EmaString &name)
 
const ElementListcomplete ()
 
- Public Member Functions inherited from thomsonreuters::ema::access::ComplexType
virtual ~ComplexType ()
 
- Public Member Functions inherited from thomsonreuters::ema::access::Data
const EmaStringgetCodeAsString () const
 
 operator const char * () const
 
virtual ~Data ()
 

Additional Inherited Members

- Public Types inherited from thomsonreuters::ema::access::Data
enum  DataCode {
  NoCodeEnum = 0,
  BlankEnum = 1
}
 
- Protected Member Functions inherited from thomsonreuters::ema::access::ComplexType
 ComplexType ()
 
- Protected Member Functions inherited from thomsonreuters::ema::access::Data
 Data ()
 

Detailed Description

ElementList entries are identified by name.

ElementList supports two methods of adding containers; they are:

The first method of adding of already populated containers allows for easy data manipulation but incurs additional memory copy. This method is useful in applications extracting data containers from some messages or containers and then setting them on other containers.

The second method allows for fast container population since it avoids additional memory copy incurred by the first method. This method is useful in source applications setting OMM data from native data formats.

The following code snippet shows addition of primitive data types to ElementList.

EmaString entryName;
eList.addAscii( entryName.set( "string" ), EmaString( "entry 1" ) )
.addInt( entryName.set( "int" ), 123 )
.addRealFromDouble( entryName.set( "real" ), 1.2345, OmmReal::ExponentNeg4Enum )

The following code snippet shows addition of pre-populated containers to ElementList.

OmmArray array;
EmaString entryName;
// first step - populate array
array.addInt( 12 ).addInt( -23 ).addInt( 234 ).complete();
// second step - add already populated array
eList.addArray( entryName.set( "populated array" ), array );
// third step - complete ElementList
eList.complete();

The following code snippet shows addition of clear containers to ElementList. The added containers are populated right after addition.

EmaString entryName;
OmmArray array;
// first step - add clear array
eList.addArray( entryName.set( "clear array" ), array );
// second step - populate array
array.addInt( 12 ).addInt( -23 ).addInt( 234 ).complete();
// third step - complete ElementList
eList.complete()

The following code snippet shows extracting data from ElementList.

const MapEntry& mEntry = map.getEntry();
if ( mEntry.getLoadType() == DataType::ElementListEnum )
{
const ElementList& eList = map.getElementList();
while ( eList.forth() )
{
const ElementEntry& eEntry = eList.getEntry();
switch ( eEntry.getLoadType() )
{
Int64 value = eEntry.getInt();
break;
const OmmReal& real = eEntry.getReal();
break;
...
}
}
}
Remarks
These two methods apply to containers only: OmmArray, ElementList, FieldList, FilterList, Map, Series, and Vector.
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform setting and extracting of ElementList and its content.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See Also
Data, ElementEntry, ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaString, EmaBuffer

Definition at line 176 of file ElementList.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::ElementList::ElementList ( )

Constructs ElementList.

virtual thomsonreuters::ema::access::ElementList::~ElementList ( )
virtual

Destructor.

Member Function Documentation

ElementList& thomsonreuters::ema::access::ElementList::add ( const EmaString name)

Adds an entry with no payload to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addAckMsg ( const EmaString name,
const AckMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded AckMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addAnsiPage ( const EmaString name,
const OmmAnsiPage value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded OmmAnsiPage
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addArray ( const EmaString name,
const OmmArray value 
)

Adds an OmmArray of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded OmmArray
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addAscii ( const EmaString name,
const EmaString value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded EmaString as OmmAscii
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addBuffer ( const EmaString name,
const EmaBuffer value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded EmaBuffer as OmmBuffer
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeAscii ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeBuffer ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeDate ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeDateTime ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeDouble ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeEnum ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeFloat ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeInt ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeQos ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeReal ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeRmtes ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeState ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeTime ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeUInt ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addCodeUtf8 ( const EmaString name)

Adds a blank data code to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addDate ( const EmaString name,
UInt16  year,
UInt8  month,
UInt8  day 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDate is invalid
Parameters
[in]nameEmaString object containing ElementEntry name
[in]yearadded OmmDate::year (0 - 4095 where 0 indicates blank)
[in]monthadded OmmDate::month (0 - 12 where 0 indicates blank)
[in]dayadded OmmDate::day (0 - 31 where 0 indicates blank)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addDateTime ( const EmaString name,
UInt16  year,
UInt8  month,
UInt8  day,
UInt8  hour = 0,
UInt8  minute = 0,
UInt8  second = 0,
UInt16  millisecond = 0,
UInt16  microsecond = 0,
UInt16  nanosecond = 0 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDateTime is invalid
Parameters
[in]nameEmaString object containing ElementEntry name
[in]yearadded OmmDateTime::year (0 - 4095 where 0 indicates blank)
[in]monthadded OmmDateTime::month (0 - 12 where 0 indicates blank)
[in]dayadded OmmDateTime::day (0 - 31 where 0 indicates blank)
[in]houradded OmmDateTime::hour (0 - 23 where 255 indicates blank)
[in]minuteadded OmmDateTime::minute (0 - 59 where 255 indicates blank)
[in]secondadded OmmDateTime::second (0 - 60 where 255 indicates blank)
[in]millisecondadded OmmDateTime::millisecond (0 - 999 where 65535 indicates blank)
[in]microsecondadded OmmDateTime::microsecond (0 - 999 where 2047 indicates blank)
[in]picosecondsadded OmmDateTime::nanosecond (0 - 999 where 2047 indicates blank)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addDouble ( const EmaString name,
double  value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded double
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addElementList ( const EmaString name,
const ElementList value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded ElementList
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addEnum ( const EmaString name,
UInt16  value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded Enum
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addFieldList ( const EmaString name,
const FieldList value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded FieldList
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addFilterList ( const EmaString name,
const FilterList value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded FilterList
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addFloat ( const EmaString name,
float  value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded float
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addGenericMsg ( const EmaString name,
const GenericMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded GenericMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addInt ( const EmaString name,
Int64  value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded Int64
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addMap ( const EmaString name,
const Map value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded Map
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addOpaque ( const EmaString name,
const OmmOpaque value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded OmmOpaque
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addPostMsg ( const EmaString name,
const PostMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded PostMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addQos ( const EmaString name,
UInt32  timeliness = OmmQos::RealTimeEnum,
UInt32  rate = OmmQos::TickByTickEnum 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]timelinessadded OmmQos::timeliness (default value is OmmQos::RealTimeEnum)
[in]rateadded OmmQos::rate (default value is OmmQos::TickByTickEnum)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addReal ( const EmaString name,
Int64  mantissa,
OmmReal::MagnitudeType  magnitudeType 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]mantissaadded OmmReal::mantissa
[in]magnitudeTypeadded OmmReal::magnitudeType
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addRealFromDouble ( const EmaString name,
double  value,
OmmReal::MagnitudeType  magnitudeType = OmmReal::Exponent0Enum 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded double to be converted to OmmReal
[in]magnitudeTypeOmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addRefreshMsg ( const EmaString name,
const RefreshMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded RefreshMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addReqMsg ( const EmaString name,
const ReqMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded ReqMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addRmtes ( const EmaString name,
const EmaBuffer value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded EmaBuffer as OmmRmtes
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addSeries ( const EmaString name,
const Series value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded Series
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addState ( const EmaString name,
OmmState::StreamState  streamState = OmmState::OpenEnum,
OmmState::DataState  dataState = OmmState::OkEnum,
UInt8  statusCode = OmmState::NoneEnum,
const EmaString statusText = EmaString() 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]streamStateadded OmmState::streamState (default value is OmmState::OpenEnum)
[in]dataStateadded OmmState::dataState (default value is OmmState::OkEnum)
[in]statusCodeadded OmmState::statusCode (default value is OmmState::NoneEnum)
[in]statusTextadded OmmState::text (default value is 'empty string')
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addStatusMsg ( const EmaString name,
const StatusMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded StatusMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addTime ( const EmaString name,
UInt8  hour = 0,
UInt8  minute = 0,
UInt8  second = 0,
UInt16  millisecond = 0,
UInt16  microsecond = 0,
UInt16  nanosecond = 0 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmTime is invalid
Parameters
[in]nameEmaString object containing ElementEntry name
[in]houradded OmmTime::hour (0 - 23 where 255 indicates blank)
[in]minuteadded OmmTime::minute (0 - 59 where 255 indicates blank)
[in]secondadded OmmTime::second (0 - 60 where 255 indicates blank)
[in]millisecondadded OmmTime::millisecond (0 - 999 where 65535 indicates blank)
[in]microsecondadded OmmTime::microsecond (0 - 999 where 2047 indicates blank)
[in]nanosecondadded OmmTime::nanosecond (0 - 999 where 2047 indicates blank)
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addUInt ( const EmaString name,
UInt64  value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded UInt64
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addUpdateMsg ( const EmaString name,
const UpdateMsg value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded UpdateMsg
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addUtf8 ( const EmaString name,
const EmaBuffer value 
)

Adds a specific simple type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded EmaBuffer as OmmUtf8
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addVector ( const EmaString name,
const Vector value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded Vector
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::addXml ( const EmaString name,
const OmmXml value 
)

Adds a complex type of OMM data to the ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]nameEmaString object containing ElementEntry name
[in]valueadded OmmXml
Returns
reference to this object
ElementList& thomsonreuters::ema::access::ElementList::clear ( )

Clears the ElementList.

Remarks
Note: allows re-use of ElementList instance during encoding.
Returns
reference to this object
const ElementList& thomsonreuters::ema::access::ElementList::complete ( )

Completes encoding of ElementList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
const reference to this object
bool thomsonreuters::ema::access::ElementList::forth ( ) const

Iterates through a list of Data of any DataType. Typical usage is to extract the entry during each iteration via getEntry().

Returns
false at the end of ElementList; true otherwise
bool thomsonreuters::ema::access::ElementList::forth ( const EmaString name) const

Iterates through a list of Data matching the name. Typical usage is to extract the entry during each iteration via getEntry().

Parameters
[in]namelooked up ElementEntry's name
Returns
false at the end of ElementList; true otherwise
bool thomsonreuters::ema::access::ElementList::forth ( const Data data) const

Iterates through a list of Data having the name matching the specified Data. Typical usage is for the Data to be a view, and thus extract each matched entry during each iteration via getEntry().

Parameters
[in]datacontaining ElementList with a view definition specifying looked up names
Returns
false at the end of ElementList; true otherwise
const EmaBuffer& thomsonreuters::ema::access::ElementList::getAsHex ( ) const
virtual

Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.

Returns
EmaBuffer with the message hex information

Implements thomsonreuters::ema::access::Data.

Data::DataCode thomsonreuters::ema::access::ElementList::getCode ( ) const
virtual

Returns the Code, which indicates a special state of a DataType.

Returns
Data::NoCodeEnum

Implements thomsonreuters::ema::access::Data.

DataType::DataTypeEnum thomsonreuters::ema::access::ElementList::getDataType ( ) const
virtual

Returns the DataType, which is the type of Omm data. Results in this class type. DataType::ElementListEnum

Implements thomsonreuters::ema::access::Data.

const ElementEntry& thomsonreuters::ema::access::ElementList::getEntry ( ) const

Returns Entry.

Exceptions
OmmInvalidUsageExceptionif forth() was not called first
Returns
ElementEntry
Int16 thomsonreuters::ema::access::ElementList::getInfoElementListNum ( ) const

Returns InfoElementListNum.

Exceptions
OmmInvalidUsageExceptionif hasInfo() returns false
Returns
ElementList Number
bool thomsonreuters::ema::access::ElementList::hasInfo ( ) const

Indicates presence of Info.

Returns
true if ElementList Info is set; false otherwise
ElementList& thomsonreuters::ema::access::ElementList::info ( Int16  elementListNum)

Specifies Info.

Remarks
The ElementList Info is optional. If used, it must be specified before adding anything to ElementList.
Exceptions
OmmInvalidUsageExceptionif this method is called after adding an entry to ElementList.
Parameters
[in]elementListNumFieldList template number
Returns
reference to this object
void thomsonreuters::ema::access::ElementList::reset ( ) const

Resets iteration to start of container.

const EmaString& thomsonreuters::ema::access::ElementList::toString ( ) const
virtual

Returns a string representation of the class instance.

Returns
string representation of the class instance

Implements thomsonreuters::ema::access::Data.