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

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

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

Public Member Functions

Constructor
 FieldList ()
 
Destructor
virtual ~FieldList ()
 
Accessors
DataType::DataTypeEnum getDataType () const
 
Data::DataCode getCode () const
 
const EmaBuffergetAsHex () const
 
const EmaStringtoString () const
 
bool hasInfo () const
 
Int16 getInfoFieldListNum () const
 
Int16 getInfoDictionaryId () const
 
bool forth () const
 
bool forth (Int16 fieldId) const
 
bool forth (const EmaString &name) const
 
bool forth (const Data &data) const
 
const FieldEntrygetEntry () const
 
void reset () const
 
Operations
FieldListclear ()
 
FieldListinfo (Int16 dictionaryId, Int16 fieldListNum)
 
FieldListaddReqMsg (Int16 fieldId, const ReqMsg &value)
 
FieldListaddRefreshMsg (Int16 fieldId, const RefreshMsg &value)
 
FieldListaddStatusMsg (Int16 fieldId, const StatusMsg &value)
 
FieldListaddUpdateMsg (Int16 fieldId, const UpdateMsg &value)
 
FieldListaddPostMsg (Int16 fieldId, const PostMsg &value)
 
FieldListaddAckMsg (Int16 fieldId, const AckMsg &value)
 
FieldListaddGenericMsg (Int16 fieldId, const GenericMsg &value)
 
FieldListaddFieldList (Int16 fieldId, const FieldList &value)
 
FieldListaddElementList (Int16 fieldId, const ElementList &value)
 
FieldListaddMap (Int16 fieldId, const Map &value)
 
FieldListaddVector (Int16 fieldId, const Vector &value)
 
FieldListaddSeries (Int16 fieldId, const Series &value)
 
FieldListaddFilterList (Int16 fieldId, const FilterList &value)
 
FieldListaddOpaque (Int16 fieldId, const OmmOpaque &value)
 
FieldListaddXml (Int16 fieldId, const OmmXml &value)
 
FieldListaddAnsiPage (Int16 fieldId, const OmmAnsiPage &value)
 
FieldListaddInt (Int16 fieldId, Int64 value)
 
FieldListaddUInt (Int16 fieldId, UInt64 value)
 
FieldListaddReal (Int16 fieldId, Int64 mantissa, OmmReal::MagnitudeType magnitudeType)
 
FieldListaddRealFromDouble (Int16 fieldId, double value, OmmReal::MagnitudeType magnitudeType=OmmReal::Exponent0Enum)
 
FieldListaddFloat (Int16 fieldId, float value)
 
FieldListaddDouble (Int16 fieldId, double value)
 
FieldListaddDate (Int16 fieldId, UInt16 year, UInt8 month, UInt8 day)
 
FieldListaddTime (Int16 fieldId, UInt8 hour=0, UInt8 minute=0, UInt8 second=0, UInt16 millisecond=0, UInt16 microsecond=0, UInt16 nanosecond=0)
 
FieldListaddDateTime (Int16 fieldId, UInt16 year, UInt8 month, UInt8 day, UInt8 hour=0, UInt8 minute=0, UInt8 second=0, UInt16 millisecond=0, UInt16 microsecond=0, UInt16 nanosecond=0)
 
FieldListaddQos (Int16 fieldId, UInt32 timeliness=OmmQos::RealTimeEnum, UInt32 rate=OmmQos::TickByTickEnum)
 
FieldListaddState (Int16 fieldId, OmmState::StreamState streamState=OmmState::OpenEnum, OmmState::DataState dataState=OmmState::OkEnum, UInt8 statusCode=OmmState::NoneEnum, const EmaString &statusText=EmaString())
 
FieldListaddEnum (Int16 fieldId, UInt16 value)
 
FieldListaddBuffer (Int16 fieldId, const EmaBuffer &value)
 
FieldListaddAscii (Int16 fieldId, const EmaString &value)
 
FieldListaddUtf8 (Int16 fieldId, const EmaBuffer &value)
 
FieldListaddRmtes (Int16 fieldId, const EmaBuffer &value)
 
FieldListaddArray (Int16 fieldId, const OmmArray &value)
 
FieldListaddCodeInt (Int16 fieldId)
 
FieldListaddCodeUInt (Int16 fieldId)
 
FieldListaddCodeReal (Int16 fieldId)
 
FieldListaddCodeFloat (Int16 fieldId)
 
FieldListaddCodeDouble (Int16 fieldId)
 
FieldListaddCodeDate (Int16 fieldId)
 
FieldListaddCodeTime (Int16 fieldId)
 
FieldListaddCodeDateTime (Int16 fieldId)
 
FieldListaddCodeQos (Int16 fieldId)
 
FieldListaddCodeState (Int16 fieldId)
 
FieldListaddCodeEnum (Int16 fieldId)
 
FieldListaddCodeBuffer (Int16 fieldId)
 
FieldListaddCodeAscii (Int16 fieldId)
 
FieldListaddCodeUtf8 (Int16 fieldId)
 
FieldListaddCodeRmtes (Int16 fieldId)
 
const FieldListcomplete ()
 
- 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 ()
 

Friends

class thomsonreuters::ema::rdm::DictionaryUtility
 

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

FieldList entries are identified by Field Id. The meaning of the Field Id is conveyed by the RDMFieldDictionary.

FieldList 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 FieldList.

FieldList fList;
fList.addAscii( 235, EmaString( "entry 1" ) )
.addUInt( 239, 123 )
.addRealFromDouble( 234, 1.2345, OmmReal::ExponentNeg4Enum )
.complete();

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

FieldList fList;
OmmArray array;
// first step - populate array
array.addInt( 12 ).addInt( -23 ).addInt( 234 ).complete();
// second step - add already populated array
fList.addArray( 1234, array );
// third step - complete FieldList
fList.complete();

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

FieldList fList;
OmmArray array;
// first step - add clear array
fList.addArray( 1234, array );
// second step - populate array
array.addInt( 12 ).addInt( -23 ).addInt( 234 ).complete();
// third step - complete FieldList
fList.complete()

The following code snippet shows getting data from FieldList.

const MapEntry& mEntry = map.getEntry();
if ( mEntry.getLoadType() == DataType::FieldListEnum )
{
const FieldList& fList = map.getFieldList();
while ( fList.forth() )
{
const FieldEntry& fEntry = fList.getEntry();
switch ( fEntry.getLoadType() )
{
UInt64 value = eEntry.getUInt();
break;
const OmmReal& real = fEntry.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 FieldList and its content.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See Also
Data, FieldEntry, ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaString, EmaBuffer

Definition at line 178 of file FieldList.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::FieldList::FieldList ( )

Constructs FieldList.

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

Destructor.

Member Function Documentation

FieldList& thomsonreuters::ema::access::FieldList::addAckMsg ( Int16  fieldId,
const AckMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded AckMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addAnsiPage ( Int16  fieldId,
const OmmAnsiPage value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded OmmAnsiPage
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addArray ( Int16  fieldId,
const OmmArray value 
)

Adds an OmmArray of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded OmmArray
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addAscii ( Int16  fieldId,
const EmaString value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded EmaString as OmmAscii
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addBuffer ( Int16  fieldId,
const EmaBuffer value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded EmaBuffer as OmmBuffer
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeAscii ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeBuffer ( Int16  fieldId)

Adds a blank data code to the FieldList.

Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeDate ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeDateTime ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeDouble ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeEnum ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeFloat ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeInt ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeQos ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeReal ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeRmtes ( Int16  fieldId)

Adds a blank data code to the FieldList.

Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeState ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeTime ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeUInt ( Int16  fieldId)

Adds a blank data code to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addCodeUtf8 ( Int16  fieldId)

Adds a blank data code to the FieldList.

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

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmDate is invalid
Parameters
[in]fieldIdfield id value
[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
FieldList& thomsonreuters::ema::access::FieldList::addDateTime ( Int16  fieldId,
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 FieldList.

Exceptions
OmmOutOfRangeExceptionif passed in OmmDateTime is invalid
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[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
FieldList& thomsonreuters::ema::access::FieldList::addDouble ( Int16  fieldId,
double  value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded double
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addElementList ( Int16  fieldId,
const ElementList value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded ElementList
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addEnum ( Int16  fieldId,
UInt16  value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded Enum
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addFieldList ( Int16  fieldId,
const FieldList value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded FieldList
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addFilterList ( Int16  fieldId,
const FilterList value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded FilterList
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addFloat ( Int16  fieldId,
float  value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded float
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addGenericMsg ( Int16  fieldId,
const GenericMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded GenericMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addInt ( Int16  fieldId,
Int64  value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded Int64
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addMap ( Int16  fieldId,
const Map value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded Map
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addOpaque ( Int16  fieldId,
const OmmOpaque value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded OmmOpaque
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addPostMsg ( Int16  fieldId,
const PostMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded PostMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addQos ( Int16  fieldId,
UInt32  timeliness = OmmQos::RealTimeEnum,
UInt32  rate = OmmQos::TickByTickEnum 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]timelinessadded OmmQos::timeliness (default value is OmmQos::RealTimeEnum)
[in]rateadded OmmQos::rate (default value is OmmQos::TickByTickEnum)
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addReal ( Int16  fieldId,
Int64  mantissa,
OmmReal::MagnitudeType  magnitudeType 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]mantissaadded OmmReal::Mantissa
[in]magnitudeTypeadded OmmReal::MagnitudeType
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addRealFromDouble ( Int16  fieldId,
double  value,
OmmReal::MagnitudeType  magnitudeType = OmmReal::Exponent0Enum 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[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
FieldList& thomsonreuters::ema::access::FieldList::addRefreshMsg ( Int16  fieldId,
const RefreshMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded RefreshMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addReqMsg ( Int16  fieldId,
const ReqMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded ReqMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addRmtes ( Int16  fieldId,
const EmaBuffer value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded EmaBuffer as OmmRmtes
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addSeries ( Int16  fieldId,
const Series value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded Series
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addState ( Int16  fieldId,
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 FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[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
FieldList& thomsonreuters::ema::access::FieldList::addStatusMsg ( Int16  fieldId,
const StatusMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded StatusMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addTime ( Int16  fieldId,
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 FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
OmmOutOfRangeExceptionif passed in OmmTime is invalid
Parameters
[in]fieldIdfield id value
[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
FieldList& thomsonreuters::ema::access::FieldList::addUInt ( Int16  fieldId,
UInt64  value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded UInt64
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addUpdateMsg ( Int16  fieldId,
const UpdateMsg value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded UpdateMsg
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addUtf8 ( Int16  fieldId,
const EmaBuffer value 
)

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

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded EmaBuffer as OmmUtf8
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addVector ( Int16  fieldId,
const Vector value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded Vector
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::addXml ( Int16  fieldId,
const OmmXml value 
)

Adds a complex type of OMM data to the FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Parameters
[in]fieldIdfield id value
[in]valueadded OmmXml
Returns
reference to this object
FieldList& thomsonreuters::ema::access::FieldList::clear ( )

Clears the FieldList.

Remarks
Invoking clear() method clears all the values and resets all the defaults
Returns
reference to this object
const FieldList& thomsonreuters::ema::access::FieldList::complete ( )

Completes encoding of FieldList.

Exceptions
OmmInvalidUsageExceptionif an error is detected (exception will specify the cause of the error)
Returns
const reference to this object
bool thomsonreuters::ema::access::FieldList::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 FieldList; true otherwise
bool thomsonreuters::ema::access::FieldList::forth ( Int16  fieldId) const

Iterates through a list of Data having the FieldId matching in the field dictionary. Typical usage is to extract the entry during each iteration via getEntry().

Parameters
[in]fieldIdlooked up FieldEntry's FieldId
Returns
false at the end of FieldList; true otherwise
bool thomsonreuters::ema::access::FieldList::forth ( const EmaString name) const

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

Parameters
[in]namelooked up FieldEntry's Field name (from RdmFieldDictionary)
Returns
false at the end of FieldList; true otherwise
bool thomsonreuters::ema::access::FieldList::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 field Ids
Returns
false at the end of FieldList; true otherwise
const EmaBuffer& thomsonreuters::ema::access::FieldList::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::FieldList::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::FieldList::getDataType ( ) const
virtual

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

Returns
DataType::FieldListEnum

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

const FieldEntry& thomsonreuters::ema::access::FieldList::getEntry ( ) const

Returns Entry.

Exceptions
OmmInvalidUsageExceptionif forth() was not called first
Returns
FieldEntry
Int16 thomsonreuters::ema::access::FieldList::getInfoDictionaryId ( ) const

Returns InfoDictionaryId.

Exceptions
OmmInvalidUsageExceptionif hasInfo() returns false
Returns
DictionaryId associated with this FieldList
Int16 thomsonreuters::ema::access::FieldList::getInfoFieldListNum ( ) const

Returns InfoFieldListNum.

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

Indicates presence of Info.

Returns
true if FieldList Info is set; false otherwise
FieldList& thomsonreuters::ema::access::FieldList::info ( Int16  dictionaryId,
Int16  fieldListNum 
)

Specifies Info.

Remarks
The FieldList Info is optional. If used, it must be set prior to adding anything to FieldList.
Exceptions
OmmInvalidUsageExceptionif this method is called after adding an entry to FieldList.
Parameters
[in]dictionaryIddictionary id of the RdmFieldDictioanry associated with this FieldList
[in]fieldListNumFieldList template number
Returns
reference to this object
void thomsonreuters::ema::access::FieldList::reset ( ) const

Resets iteration to start of container.

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

Returns a string representation of the class instance.

Returns
string representation of the class instance

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

Friends And Related Function Documentation

Definition at line 682 of file FieldList.h.