Series is a homogeneous container of complex data type entries. More...
Public Member Functions | |
Constructor | |
Series () | |
More... | |
Destructor | |
virtual | ~Series () |
More... | |
Operations | |
Series & | clear () |
More... | |
Series & | totalCountHint (UInt32 totalCountHint) |
More... | |
Series & | summaryData (const ComplexType &data) |
More... | |
Series & | add (const ComplexType &value) |
More... | |
Series & | add () |
More... | |
const Series & | complete () |
More... | |
![]() | |
virtual | ~ComplexType () |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Accessors | |
class | refinitiv::ema::rdm::DataDictionaryImpl |
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 | forth () const |
More... | |
void | reset () const |
More... | |
const SeriesEntry & | getEntry () const |
More... | |
bool | hasTotalCountHint () const |
More... | |
UInt32 | getTotalCountHint () const |
More... | |
const SummaryData & | getSummaryData () const |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
Series entries have no explicit identification. They are implicitly indexed inside Series.
Series 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 entry and summaryData to Series.
The following code snippet shows extracting of Series and its content.
refinitiv::ema::access::Series::Series | ( | ) |
Constructs Series.
|
virtual |
Destructor.
Series& refinitiv::ema::access::Series::add | ( | ) |
Adds an entry with no payload to the Series.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
Series& refinitiv::ema::access::Series::add | ( | const ComplexType & | value | ) |
Adds complex OMM data identified by a specific complex type of OMM data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | value | complex type contained in this entry |
Series& refinitiv::ema::access::Series::clear | ( | ) |
const Series& refinitiv::ema::access::Series::complete | ( | ) |
Completes encoding of the Series.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::ema::access::Series::forth | ( | ) | const |
Iterates through a list of Data of any DataType. Typical usage is to extract the entry during each iteration via getEntry().
|
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 SeriesEntry& refinitiv::ema::access::Series::getEntry | ( | ) | const |
Returns Entry.
OmmInvalidUsageException | if forth() was not called first |
const SummaryData& refinitiv::ema::access::Series::getSummaryData | ( | ) | const |
Returns the contained summaryData Data based on the summaryData DataType.
UInt32 refinitiv::ema::access::Series::getTotalCountHint | ( | ) | const |
Returns TotalCountHint.
bool refinitiv::ema::access::Series::hasTotalCountHint | ( | ) | const |
Indicates presence of TotalCountHint.
void refinitiv::ema::access::Series::reset | ( | ) | const |
Resets iteration to start of container.
Series& refinitiv::ema::access::Series::summaryData | ( | const ComplexType & | data | ) |
Specifies the SummaryData OMM Data.
[in] | summaryData | specifies complex type as summaryData |
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::Series::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 |
Specifies TotalCountHint.
[in] | totalCountHint | specifies total count hint |
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
![]() |
![]() |
|