FilterList is a heterogeneous container of complex data type entries. More...
Public Member Functions | |
Constructor | |
FilterList () | |
More... | |
Destructor | |
virtual | ~FilterList () |
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 | hasTotalCountHint () const |
More... | |
UInt32 | getTotalCountHint () const |
More... | |
bool | forth () const |
More... | |
bool | forth (UInt8 filterId) const |
More... | |
const FilterEntry & | getEntry () const |
More... | |
void | reset () const |
More... | |
![]() | |
virtual | ~ComplexType () |
More... | |
![]() | |
const EmaString & | getCodeAsString () const |
More... | |
operator const char * () const | |
More... | |
virtual | ~Data () |
More... | |
Operations | |
FilterList & | clear () |
More... | |
FilterList & | totalCountHint (UInt32 totalCountHint) |
More... | |
FilterList & | add (UInt8 filterId, FilterEntry::FilterAction action, const ComplexType &value, const EmaBuffer &permissionData=EmaBuffer()) |
More... | |
FilterList & | add (UInt8 filterId, FilterEntry::FilterAction action, const EmaBuffer &permissionData=EmaBuffer()) |
More... | |
const FilterList & | complete () |
More... | |
Additional Inherited Members | |
![]() | |
enum | DataCode { NoCodeEnum = 0 , BlankEnum = 1 } |
![]() | |
ComplexType () | |
![]() | |
Data () | |
FilterList entries are identified by Filter Id. For the source directory information, the Filter Ids are defined in the RDM (see also EmaRdm.h file).
FilterList 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 pre populated containers to FilterList.
The following code snippet shows addition of clear containers to FilterList. The added containers are populated right after addition.
The following code snippet shows extracting data from FilterList.
Definition at line 133 of file FilterList.h.
refinitiv::ema::access::FilterList::FilterList | ( | ) |
Constructs FilterList.
|
virtual |
Destructor.
FilterList& refinitiv::ema::access::FilterList::add | ( | UInt8 | filterId, |
FilterEntry::FilterAction | action, | ||
const ComplexType & | value, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds a complex type of OMM data to the FilterList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | filterId | specifies filter id for the added FilterEntry |
[in] | action | specifies action for the added FilterEntry |
[in] | value | specifies load for the added FilterEntry |
[in] | permissionData | specifies permissions for the added FilterEntry |
FilterList& refinitiv::ema::access::FilterList::add | ( | UInt8 | filterId, |
FilterEntry::FilterAction | action, | ||
const EmaBuffer & | permissionData = EmaBuffer() |
||
) |
Adds no payload to the FilterList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
[in] | filterId | specifies filter id for the added FilterEntry |
[in] | action | specifies action for the added FilterEntry |
[in] | permissionData | specifies permissions for the added FilterEntry |
FilterList& refinitiv::ema::access::FilterList::clear | ( | ) |
Clears the FilterList.
const FilterList& refinitiv::ema::access::FilterList::complete | ( | ) |
Completes encoding of FilterList.
OmmInvalidUsageException | if an error is detected (exception will specify the cause of the error) |
bool refinitiv::ema::access::FilterList::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::FilterList::forth | ( | UInt8 | filterId | ) | const |
Iterates through a list of Data having matched actual filterId with the one passed in. Typical usage is to extract the entry during each iteration via getEntry().
[in] | filterId | looked up filter id |
|
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 FilterEntry& refinitiv::ema::access::FilterList::getEntry | ( | ) | const |
Returns Entry.
OmmInvalidUsageException | if forth() was not called first |
UInt32 refinitiv::ema::access::FilterList::getTotalCountHint | ( | ) | const |
Returns TotalCountHint.
OmmInvalidUsageException | if hasTotalCountHint() returns false |
bool refinitiv::ema::access::FilterList::hasTotalCountHint | ( | ) | const |
Indicates presence of TotalCountHint.
void refinitiv::ema::access::FilterList::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::FilterList::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 |
FilterList& refinitiv::ema::access::FilterList::totalCountHint | ( | UInt32 | totalCountHint | ) |
Specifies TotalCountHint.
OmmInvalidUsageException | if this method is called after adding an entry to FilterList. |
[in] | totalCountHint | specifies estimated total number of entries |
![]() |
![]() |
|