FieldList is a heterogeneous container of complex and primitive data type entries. More...
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
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.
The following code snippet shows addition of pre-populated containers to FieldList.
The following code snippet shows addition of clear containers to FieldList. The added containers are populated right after addition.
The following code snippet shows getting data from FieldList.
Definition at line 179 of file FieldList.h.
refinitiv::ema::access::FieldList::FieldList | ( | ) |
Constructs FieldList.
|
virtual |
Destructor.
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added AckMsg |
FieldList& refinitiv::ema::access::FieldList::addAnsiPage | ( | Int16 | fieldId, |
const OmmAnsiPage & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added OmmAnsiPage |
Adds an OmmArray of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added OmmArray |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a blank data code to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
FieldList& refinitiv::ema::access::FieldList::addDate | ( | Int16 | fieldId, |
UInt16 | year, | ||
UInt8 | month, | ||
UInt8 | day | ||
) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[in] | fieldId | field id value |
[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) |
FieldList& refinitiv::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.
OmmOutOfRangeException | if passed in OmmDateTime is invalid |
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[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) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added double |
FieldList& refinitiv::ema::access::FieldList::addElementList | ( | Int16 | fieldId, |
const ElementList & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added ElementList |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added Enum |
FieldList& refinitiv::ema::access::FieldList::addFieldList | ( | Int16 | fieldId, |
const FieldList & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added FieldList |
FieldList& refinitiv::ema::access::FieldList::addFilterList | ( | Int16 | fieldId, |
const FilterList & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added FilterList |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added float |
FieldList& refinitiv::ema::access::FieldList::addGenericMsg | ( | Int16 | fieldId, |
const GenericMsg & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added GenericMsg |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added Int64 |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added Map |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added OmmOpaque |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added PostMsg |
FieldList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | timeliness | added OmmQos::timeliness (default value is OmmQos::RealTimeEnum) |
[in] | rate | added OmmQos::rate (default value is OmmQos::TickByTickEnum) |
FieldList& refinitiv::ema::access::FieldList::addReal | ( | Int16 | fieldId, |
Int64 | mantissa, | ||
OmmReal::MagnitudeType | magnitudeType | ||
) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | mantissa | added OmmReal::Mantissa |
[in] | magnitudeType | added OmmReal::MagnitudeType |
FieldList& refinitiv::ema::access::FieldList::addRealFromDouble | ( | Int16 | fieldId, |
double | value, | ||
OmmReal::MagnitudeType | magnitudeType = OmmReal::Exponent0Enum |
||
) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added double to be converted to OmmReal |
[in] | magnitudeType | OmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum) |
FieldList& refinitiv::ema::access::FieldList::addRefreshMsg | ( | Int16 | fieldId, |
const RefreshMsg & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added RefreshMsg |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added ReqMsg |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added Series |
FieldList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[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') |
FieldList& refinitiv::ema::access::FieldList::addStatusMsg | ( | Int16 | fieldId, |
const StatusMsg & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added StatusMsg |
FieldList& refinitiv::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.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
OmmOutOfRangeException | if passed in OmmTime is invalid |
[in] | fieldId | field id value |
[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) |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added UInt64 |
FieldList& refinitiv::ema::access::FieldList::addUpdateMsg | ( | Int16 | fieldId, |
const UpdateMsg & | value | ||
) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added UpdateMsg |
Adds a specific simple type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added Vector |
Adds a complex type of OMM data to the FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | fieldId | field id value |
[in] | value | added OmmXml |
FieldList& refinitiv::ema::access::FieldList::clear | ( | ) |
const FieldList& refinitiv::ema::access::FieldList::complete | ( | ) |
Completes encoding of FieldList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::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().
bool refinitiv::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().
[in] | data | containing ElementList with a view definition specifying looked up field Ids |
bool refinitiv::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().
[in] | name | looked up FieldEntry's Field name (from RdmFieldDictionary) |
bool refinitiv::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().
[in] | fieldId | looked up FieldEntry's FieldId |
|
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.
Implements refinitiv::ema::access::Data.
const FieldEntry& refinitiv::ema::access::FieldList::getEntry | ( | ) | const |
Int16 refinitiv::ema::access::FieldList::getInfoDictionaryId | ( | ) | const |
Returns InfoDictionaryId.
OmmInvalidUsageException | if hasInfo() returns false |
Int16 refinitiv::ema::access::FieldList::getInfoFieldListNum | ( | ) | const |
Returns InfoFieldListNum.
OmmInvalidUsageException | if hasInfo() returns false |
bool refinitiv::ema::access::FieldList::hasInfo | ( | ) | const |
Indicates presence of Info.
Specifies Info.
OmmInvalidUsageException | if this method is called after adding an entry to FieldList. |
[in] | dictionaryId | dictionary id of the RdmFieldDictioanry associated with this FieldList |
[in] | fieldListNum | FieldList template number |
void refinitiv::ema::access::FieldList::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::FieldList::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 |
![]() |
![]() |
|