ElementList is a heterogeneous container of complex and primitive data type entries. More...
Public Member Functions | |
Constructor | |
ElementList () | |
More... | |
Destructor | |
virtual | ~ElementList () |
More... | |
Accessors | |
DataType::DataTypeEnum | getDataType () const |
More... | |
Data::DataCode | getCode () const |
More... | |
const EmaBuffer & | getAsHex () const |
More... | |
const EmaString & | toString () const |
More... | |
const EmaString & | toString (const refinitiv::ema::rdm::DataDictionary &dictionary) const |
More... | |
bool | hasInfo () const |
More... | |
Int16 | getInfoElementListNum () const |
More... | |
bool | forth () const |
More... | |
bool | forth (const EmaString &name) const |
More... | |
bool | forth (const Data &data) const |
More... | |
const ElementEntry & | getEntry () const |
More... | |
void | reset () const |
More... | |
![]() | |
virtual | ~ComplexType () |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
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.
The following code snippet shows addition of pre-populated containers to ElementList.
The following code snippet shows addition of clear containers to ElementList. The added containers are populated right after addition.
The following code snippet shows extracting data from ElementList.
Definition at line 177 of file ElementList.h.
refinitiv::ema::access::ElementList::ElementList | ( | ) |
Constructs ElementList.
|
virtual |
Destructor.
ElementList& refinitiv::ema::access::ElementList::add | ( | const EmaString & | name | ) |
Adds an entry with no payload to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addAckMsg | ( | const EmaString & | name, |
const AckMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added AckMsg |
ElementList& refinitiv::ema::access::ElementList::addAnsiPage | ( | const EmaString & | name, |
const OmmAnsiPage & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added OmmAnsiPage |
ElementList& refinitiv::ema::access::ElementList::addArray | ( | const EmaString & | name, |
const OmmArray & | value | ||
) |
Adds an OmmArray of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added OmmArray |
ElementList& refinitiv::ema::access::ElementList::addAscii | ( | const EmaString & | name, |
const EmaString & | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added EmaString as OmmAscii |
ElementList& refinitiv::ema::access::ElementList::addBuffer | ( | const EmaString & | name, |
const EmaBuffer & | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added EmaBuffer as OmmBuffer |
ElementList& refinitiv::ema::access::ElementList::addCodeAscii | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeBuffer | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeDate | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeDateTime | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeDouble | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeEnum | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeFloat | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeInt | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeQos | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeReal | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeRmtes | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeState | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeTime | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeUInt | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addCodeUtf8 | ( | const EmaString & | name | ) |
Adds a blank data code to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
ElementList& refinitiv::ema::access::ElementList::addDate | ( | const EmaString & | name, |
UInt16 | year, | ||
UInt8 | month, | ||
UInt8 | day | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[in] | name | EmaString object containing ElementEntry name |
[in] | year | added OmmDate::year (0 - 4095 where 0 indicates blank) |
[in] | month | added OmmDate::month (0 - 12 where 0 indicates blank) |
[in] | day | added OmmDate::day (0 - 31 where 0 indicates blank) |
ElementList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDateTime is invalid |
[in] | name | EmaString object containing ElementEntry name |
[in] | year | added OmmDateTime::year (0 - 4095 where 0 indicates blank) |
[in] | month | added OmmDateTime::month (0 - 12 where 0 indicates blank) |
[in] | day | added OmmDateTime::day (0 - 31 where 0 indicates blank) |
[in] | hour | added OmmDateTime::hour (0 - 23 where 255 indicates blank) |
[in] | minute | added OmmDateTime::minute (0 - 59 where 255 indicates blank) |
[in] | second | added OmmDateTime::second (0 - 60 where 255 indicates blank) |
[in] | millisecond | added OmmDateTime::millisecond (0 - 999 where 65535 indicates blank) |
[in] | microsecond | added OmmDateTime::microsecond (0 - 999 where 2047 indicates blank) |
[in] | picoseconds | added OmmDateTime::nanosecond (0 - 999 where 2047 indicates blank) |
ElementList& refinitiv::ema::access::ElementList::addDouble | ( | const EmaString & | name, |
double | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added double |
ElementList& refinitiv::ema::access::ElementList::addElementList | ( | const EmaString & | name, |
const ElementList & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added ElementList |
ElementList& refinitiv::ema::access::ElementList::addEnum | ( | const EmaString & | name, |
UInt16 | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added Enum |
ElementList& refinitiv::ema::access::ElementList::addFieldList | ( | const EmaString & | name, |
const FieldList & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added FieldList |
ElementList& refinitiv::ema::access::ElementList::addFilterList | ( | const EmaString & | name, |
const FilterList & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added FilterList |
ElementList& refinitiv::ema::access::ElementList::addFloat | ( | const EmaString & | name, |
float | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added float |
ElementList& refinitiv::ema::access::ElementList::addGenericMsg | ( | const EmaString & | name, |
const GenericMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added GenericMsg |
ElementList& refinitiv::ema::access::ElementList::addInt | ( | const EmaString & | name, |
Int64 | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added Int64 |
ElementList& refinitiv::ema::access::ElementList::addMap | ( | const EmaString & | name, |
const Map & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added Map |
ElementList& refinitiv::ema::access::ElementList::addOpaque | ( | const EmaString & | name, |
const OmmOpaque & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added OmmOpaque |
ElementList& refinitiv::ema::access::ElementList::addPostMsg | ( | const EmaString & | name, |
const PostMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added PostMsg |
ElementList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | timeliness | added OmmQos::timeliness (default value is OmmQos::RealTimeEnum) |
[in] | rate | added OmmQos::rate (default value is OmmQos::TickByTickEnum) |
ElementList& refinitiv::ema::access::ElementList::addReal | ( | const EmaString & | name, |
Int64 | mantissa, | ||
OmmReal::MagnitudeType | magnitudeType | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | mantissa | added OmmReal::mantissa |
[in] | magnitudeType | added OmmReal::magnitudeType |
ElementList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added double to be converted to OmmReal |
[in] | magnitudeType | OmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum) |
ElementList& refinitiv::ema::access::ElementList::addRefreshMsg | ( | const EmaString & | name, |
const RefreshMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added RefreshMsg |
ElementList& refinitiv::ema::access::ElementList::addReqMsg | ( | const EmaString & | name, |
const ReqMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added ReqMsg |
ElementList& refinitiv::ema::access::ElementList::addRmtes | ( | const EmaString & | name, |
const EmaBuffer & | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added EmaBuffer as OmmRmtes |
ElementList& refinitiv::ema::access::ElementList::addSeries | ( | const EmaString & | name, |
const Series & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added Series |
ElementList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | streamState | added OmmState::streamState (default value is OmmState::OpenEnum) |
[in] | dataState | added OmmState::dataState (default value is OmmState::OkEnum) |
[in] | statusCode | added OmmState::statusCode (default value is OmmState::NoneEnum) |
[in] | statusText | added OmmState::text (default value is 'empty string') |
ElementList& refinitiv::ema::access::ElementList::addStatusMsg | ( | const EmaString & | name, |
const StatusMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added StatusMsg |
ElementList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmTime is invalid |
[in] | name | EmaString object containing ElementEntry name |
[in] | hour | added OmmTime::hour (0 - 23 where 255 indicates blank) |
[in] | minute | added OmmTime::minute (0 - 59 where 255 indicates blank) |
[in] | second | added OmmTime::second (0 - 60 where 255 indicates blank) |
[in] | millisecond | added OmmTime::millisecond (0 - 999 where 65535 indicates blank) |
[in] | microsecond | added OmmTime::microsecond (0 - 999 where 2047 indicates blank) |
[in] | nanosecond | added OmmTime::nanosecond (0 - 999 where 2047 indicates blank) |
ElementList& refinitiv::ema::access::ElementList::addUInt | ( | const EmaString & | name, |
UInt64 | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added UInt64 |
ElementList& refinitiv::ema::access::ElementList::addUpdateMsg | ( | const EmaString & | name, |
const UpdateMsg & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added UpdateMsg |
ElementList& refinitiv::ema::access::ElementList::addUtf8 | ( | const EmaString & | name, |
const EmaBuffer & | value | ||
) |
Adds a specific simple type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added EmaBuffer as OmmUtf8 |
ElementList& refinitiv::ema::access::ElementList::addVector | ( | const EmaString & | name, |
const Vector & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added Vector |
ElementList& refinitiv::ema::access::ElementList::addXml | ( | const EmaString & | name, |
const OmmXml & | value | ||
) |
Adds a complex type of OMM data to the ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | name | EmaString object containing ElementEntry name |
[in] | value | added OmmXml |
ElementList& refinitiv::ema::access::ElementList::clear | ( | ) |
Clears the ElementList.
const ElementList& refinitiv::ema::access::ElementList::complete | ( | ) |
Completes encoding of ElementList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::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().
bool refinitiv::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().
[in] | data | containing ElementList with a view definition specifying looked up names |
bool refinitiv::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().
[in] | name | looked up ElementEntry's name |
|
virtual |
Returns a buffer that in turn provides an alphanumeric null-terminated hexadecimal string representation.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the Code, which indicates a special state of a DataType.
Implements refinitiv::ema::access::Data.
|
virtual |
Returns the DataType, which is the type of Omm data. Results in this class type. @retrun DataType::ElementListEnum
Implements refinitiv::ema::access::Data.
const ElementEntry& refinitiv::ema::access::ElementList::getEntry | ( | ) | const |
Returns Entry.
OmmInvalidUsageException | if forth() was not called first |
Int16 refinitiv::ema::access::ElementList::getInfoElementListNum | ( | ) | const |
Returns InfoElementListNum.
OmmInvalidUsageException | if hasInfo() returns false |
bool refinitiv::ema::access::ElementList::hasInfo | ( | ) | const |
Indicates presence of Info.
ElementList& refinitiv::ema::access::ElementList::info | ( | Int16 | elementListNum | ) |
Specifies Info.
OmmInvalidUsageException | if this method is called after adding an entry to ElementList. |
[in] | elementListNum | FieldList template number |
void refinitiv::ema::access::ElementList::reset | ( | ) | const |
Resets iteration to start of container.
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::ElementList::toString | ( | const refinitiv::ema::rdm::DataDictionary & | dictionary | ) | const |
Returns a string representation of the class instance for just encoded object.
[in] | dictionary | use for toString() conversion |
![]() |
![]() |
|