Vector is a homogeneous container of complex data type entries. More...
Public Member Functions | |
Constructor | |
Vector () | |
More... | |
Destructor | |
virtual | ~Vector () |
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 | forth () const |
More... | |
void | reset () const |
More... | |
bool | hasTotalCountHint () const |
More... | |
bool | getSortable () const |
More... | |
UInt32 | getTotalCountHint () const |
More... | |
const SummaryData & | getSummaryData () const |
More... | |
const VectorEntry & | getEntry () const |
More... | |
![]() | |
virtual | ~ComplexType () |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Operations | |
Vector & | clear () |
More... | |
Vector & | add (UInt32 position, VectorEntry::VectorAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer()) |
More... | |
Vector & | add (UInt32 position, VectorEntry::VectorAction action, const EmaBuffer &permissionData=EmaBuffer()) |
More... | |
const Vector & | complete () |
More... | |
Vector & | sortable (bool sortable=false) |
More... | |
Vector & | totalCountHint (UInt32 totalCountHint) |
More... | |
Vector & | summaryData (const ComplexType &data) |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
Vector entries are identified by index.
Vector 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 Vector.
The following code snippet shows extracting of Vector and its content.
refinitiv::ema::access::Vector::Vector | ( | ) |
Constructs Vector.
|
virtual |
Destructor.
Vector& refinitiv::ema::access::Vector::add | ( | UInt32 | position, |
VectorEntry::VectorAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds complex OMM data identified by a position.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | position | specifies position of this entry in Vector |
[in] | action | specifies action to be performed on this entry |
[in] | value | complex type contained in this entry |
[in] | permissionData | specifies permission data for this entry |
Vector& refinitiv::ema::access::Vector::add | ( | UInt32 | position, |
VectorEntry::VectorAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload identified by a position.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | position | specifies position of this entry in Vector |
[in] | action | specifies action to be performed on this entry |
[in] | permissionData | specifies permission data for this entry |
Vector& refinitiv::ema::access::Vector::clear | ( | ) |
const Vector& refinitiv::ema::access::Vector::complete | ( | ) |
Completes encoding of the Vector.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::ema::access::Vector::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 VectorEntry& refinitiv::ema::access::Vector::getEntry | ( | ) | const |
Returns Entry.
OmmInvalidUsageException | if forth() was not called first |
bool refinitiv::ema::access::Vector::getSortable | ( | ) | const |
Returns Sortable.
const SummaryData& refinitiv::ema::access::Vector::getSummaryData | ( | ) | const |
Returns the contained summaryData Data based on the summaryData DataType.
UInt32 refinitiv::ema::access::Vector::getTotalCountHint | ( | ) | const |
Returns TotalCountHint.
OmmInvalidUsageException | if hasTotalCountHint() returns false |
bool refinitiv::ema::access::Vector::hasTotalCountHint | ( | ) | const |
Indicates presence of TotalCountHint.
void refinitiv::ema::access::Vector::reset | ( | ) | const |
Resets iteration to start of container.
Vector& refinitiv::ema::access::Vector::sortable | ( | bool | sortable = false | ) |
Specifies Sortable.
[in] | sortable | specifies if this object is sortable |
Vector& refinitiv::ema::access::Vector::summaryData | ( | const ComplexType & | data | ) |
Specifies the SummaryData OMM Data.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | summaryData | specifies complex type as summaryData |
|
virtual |
Returns a string representation of the class instance.
Implements refinitiv::ema::access::Data.
const EmaString& refinitiv::ema::access::Vector::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 |
![]() |
![]() |
|