OmmArray is a homogeneous container of primitive data type entries. More...
Public Member Functions | |
Constructor | |
OmmArray () | |
More... | |
Destructor | |
virtual | ~OmmArray () |
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 | hasFixedWidth () const |
More... | |
UInt16 | getFixedWidth () const |
More... | |
bool | forth () const |
More... | |
const OmmArrayEntry & | getEntry () const |
More... | |
void | reset () const |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
Data () | |
The following code snippet shows addition of primitive data type entries to OmmArray.
The following code snippet shows getting data from OmmArray.
Definition at line 86 of file OmmArray.h.
refinitiv::ema::access::OmmArray::OmmArray | ( | ) |
Constructs OmmArray
|
virtual |
Destructor
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeAscii | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeBuffer | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeDate | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeDateTime | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeDouble | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeEnum | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeFloat | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeInt | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeQos | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeReal | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeRmtes | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeState | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeTime | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeUInt | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addCodeUtf8 | ( | ) |
Adds a blank data code to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[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) |
OmmArray& refinitiv::ema::access::OmmArray::addDateTime | ( | 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 OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmOutOfRangeException | if passed in OmmDate is invalid |
[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) |
OmmArray& refinitiv::ema::access::OmmArray::addDouble | ( | double | value | ) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | added double |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | added Enum |
OmmArray& refinitiv::ema::access::OmmArray::addFloat | ( | float | value | ) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | added float |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | specifies added Int64 |
OmmArray& refinitiv::ema::access::OmmArray::addQos | ( | UInt32 | timeliness = OmmQos::RealTimeEnum , |
UInt32 | rate = OmmQos::TickByTickEnum |
||
) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | timeliness | added OmmQos::timeliness (default value is OmmQos::RealTimeEnum) |
[in] | rate | added OmmQos::rate (default value is OmmQos::TickByTickEnum) |
OmmArray& refinitiv::ema::access::OmmArray::addReal | ( | Int64 | mantissa, |
OmmReal::MagnitudeType | magnitudeType | ||
) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | mantissa | added OmmReal::mantissa |
[in] | magnitudeType | added OmmReal::magnitudeType |
OmmArray& refinitiv::ema::access::OmmArray::addRealFromDouble | ( | double | value, |
OmmReal::MagnitudeType | magnitudeType = OmmReal::Exponent0Enum |
||
) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | added double to be converted to OmmReal |
[in] | magnitudeType | OmmReal::magnitudeType used for the conversion (default value is OmmReal::Exponent0Enum) |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::addState | ( | 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 OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[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') |
OmmArray& refinitiv::ema::access::OmmArray::addTime | ( | 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 OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmOutOfRangeException | if passed in OmmTime is invalid |
[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 OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
[in] | value | specifies added UInt64 |
Adds a specific simple type of OMM data to the OmmArray.
OmmInvalidUsageException | if first addition was of different data type |
OmmArray& refinitiv::ema::access::OmmArray::clear | ( | ) |
const OmmArray& refinitiv::ema::access::OmmArray::complete | ( | ) |
Completes encoding of OmmArray.
Specifies FixedWidth. Setting fixed-width implies each array entry has been populated with the same fixed size, to allow minimizing bandwidth. Setting fixed-width as 0 implies the data contained in the array entries may be of different sizes, to allow the flexibility of different sized encoding;
When using a fixed width, the application still passes in the base primitive type when encoding (e.g., if encoding fixed width DataType::IntEnum types, an Int is passed in regardless of fixed width). When encoding buffer types as fixed width: Any content that exceeds fixedWidth will be truncated. Any content that is shorter than fixedWidth will be padded with the \0 (NULL) character.
Only specific types are allowed as fixed-width encodings. Here lists supported fixed widths and allowable data ranges: DataType::IntEnum supports one byte(-2^7 to 2^7-1), two byte(-2^15 to 2^15-1), four byte((-2^31 to 2^31-1), or eight byte((-2^63 to 2^63-1). DataType::UIntEnum supports one byte(0 to 2^8-1), two byte(0 to 2^16-1), four byte(0 to 2^32-1), or eight byte(0 to 2^64-1). DataType::FloatEnum supports four byte, floating point type that represents the same range of values allowed by the system float type. Follows the IEEE 754 specification. DataType::DoubleEnum supports eight byte, floating point type that represents the same range of values allowed by the system double type. Follows the IEEE 754 specification. DataType::DateEnum supports four byte(year, month, day). DataType::TimeEnum supports: three byte(hour, minute, second); five byte(hour, minute, second, millisec); seven byte(hour, minute, second, millisec, microsec); eight byte(hour, minute, second, millisec, microsec, nanosec). DataType::DateTimeEnum supports: seven byte(year, month, day, hour, minute, second); nine byte(year, month, day, hour, minute, second, millisec); eleven byte(year, month, day, hour, minute, second, millisec, microsec); twelve byte(year, month, day, hour, minute, second, millisec, microsec, nanosec); DataType::EnumEnum supports one byte(0 to 2^8-1) or two byte(0 to 2^16-1). DataType::BufferEnum, DataType::AsciiEnum, DataType::Utf8Enum, and DataType::RmtesEnum support any legal width value.
OmmInvalidUsageException | if an entry was already added |
[in] | width | specifies fixed width value |
bool refinitiv::ema::access::OmmArray::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 OmmArrayEntry& refinitiv::ema::access::OmmArray::getEntry | ( | ) | const |
Returns Entry.
OmmInvalidUsageException | if forth() was not called first |
UInt16 refinitiv::ema::access::OmmArray::getFixedWidth | ( | ) | const |
Returns FixedWidth.
bool refinitiv::ema::access::OmmArray::hasFixedWidth | ( | ) | const |
Indicates presence of FixedWidth.
void refinitiv::ema::access::OmmArray::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::OmmArray::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 |
![]() |
![]() |
|