FilterEntry represents an entry of FilterList.
More...
FilterEntry associates entry's id, action, permission info, data and its data type.
{
while ( fList.forth() )
{
const FilterEntry& filterEntry = fList.getEntry();
...
}
}
- See also
- Data, ComplexType ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError, EmaBuffer, EmaString
Definition at line 88 of file FilterEntry.h.
◆ FilterAction
An enumeration representing filter entry action.
Enumerator |
---|
UpdateEnum | Indicates a partial change of the current Omm data.
|
SetEnum | Indicates to specify or replace the current Omm data.
|
ClearEnum | Indicates to unset the current Omm data.
|
Definition at line 95 of file FilterEntry.h.
◆ getAckMsg()
const AckMsg& refinitiv::ema::access::FilterEntry::getAckMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- AckMsg class reference to contained object
◆ getAction()
FilterAction refinitiv::ema::access::FilterEntry::getAction |
( |
| ) |
const |
Returns the current action on the OMM data.
- Returns
- FilterAction
◆ getAnsiPage()
const OmmAnsiPage& refinitiv::ema::access::FilterEntry::getAnsiPage |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmAnsiPage class reference to contained object
◆ getElementList()
const ElementList& refinitiv::ema::access::FilterEntry::getElementList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ElementList class reference to contained object
◆ getError()
const OmmError& refinitiv::ema::access::FilterEntry::getError |
( |
| ) |
const |
Returns Error.
- Exceptions
-
- Returns
- OmmError class reference to contained object
◆ getFieldList()
const FieldList& refinitiv::ema::access::FilterEntry::getFieldList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FieldList class reference to contained object
◆ getFilterActionAsString()
const EmaString& refinitiv::ema::access::FilterEntry::getFilterActionAsString |
( |
| ) |
const |
Returns the FilterAction value as a string format.
- Returns
- EmaString containing string representation of FilterAction
◆ getFilterId()
UInt8 refinitiv::ema::access::FilterEntry::getFilterId |
( |
| ) |
const |
Returns FilterId.
- Returns
- filter id
◆ getFilterList()
const FilterList& refinitiv::ema::access::FilterEntry::getFilterList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FilterList class reference to contained object
◆ getGenericMsg()
const GenericMsg& refinitiv::ema::access::FilterEntry::getGenericMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- GenericMsg class reference to contained object
◆ getLoad()
const Data& refinitiv::ema::access::FilterEntry::getLoad |
( |
| ) |
const |
Returns the contained Data based on the DataType.
- Returns
- Data class reference to contained object
◆ getLoadType()
Returns the DataType of the entry's load.
- Returns
- data type of the contained object
◆ getMap()
const Map& refinitiv::ema::access::FilterEntry::getMap |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Map class reference to contained object
◆ getOpaque()
const OmmOpaque& refinitiv::ema::access::FilterEntry::getOpaque |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmOpaque class reference to contained object
◆ getPermissionData()
const EmaBuffer& refinitiv::ema::access::FilterEntry::getPermissionData |
( |
| ) |
const |
Returns PermissionData.
- Exceptions
-
- Returns
- EmaBuffer containing permission information
◆ getPostMsg()
const PostMsg& refinitiv::ema::access::FilterEntry::getPostMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- PostMsg class reference to contained object
◆ getRefreshMsg()
const RefreshMsg& refinitiv::ema::access::FilterEntry::getRefreshMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- RefreshMsg class reference to contained object
◆ getReqMsg()
const ReqMsg& refinitiv::ema::access::FilterEntry::getReqMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ReqMsg class reference to contained object
◆ getSeries()
const Series& refinitiv::ema::access::FilterEntry::getSeries |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Series class reference to contained object
◆ getStatusMsg()
const StatusMsg& refinitiv::ema::access::FilterEntry::getStatusMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- StatusMsg class reference to contained object
◆ getUpdateMsg()
const UpdateMsg& refinitiv::ema::access::FilterEntry::getUpdateMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- UpdateMsg class reference to contained object
◆ getVector()
const Vector& refinitiv::ema::access::FilterEntry::getVector |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Vector class reference to contained object
◆ getXml()
const OmmXml& refinitiv::ema::access::FilterEntry::getXml |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmXml class reference to contained object
◆ hasPermissionData()
bool refinitiv::ema::access::FilterEntry::hasPermissionData |
( |
| ) |
const |
Indicates presence of PermissionData.
- Returns
- true if permission data is set; false otherwise
◆ toString()
const EmaString& refinitiv::ema::access::FilterEntry::toString |
( |
| ) |
const |
Returns a string representation of the class instance.
- Returns
- string representation of the class instance