VectorEntry represents an entry of Vector.
More...
VectorEntry associates entry's position, action, permission information, data and its data type.
decodeVector(
const Vector& vector )
{
while ( vector.forth() )
{
const VectorEntry& vectorEntry = vector.getEntry();
...
}
}
- See also
- Data, ComplexType ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError
Definition at line 86 of file VectorEntry.h.
◆ VectorAction
An enumeration representing vector entry action.
Enumerator |
---|
UpdateEnum | Indicates a partial change of the entry
|
SetEnum | Indicates to replace the entry.
|
ClearEnum | Indicates to empty the entry. Contains no data.
|
InsertEnum | Indicates to place the entry in between other entries. Increases any higher-ordered position by one. May leave gaps if previous lower-ordered position is unpopulated. Only valid if sortable() returns true.
|
DeleteEnum | Indicates to remove the entry. Decreases any higher-ordered position by one. Only valid if sortable() returns true. Contains no data.
|
Definition at line 93 of file VectorEntry.h.
◆ getAckMsg()
const AckMsg& refinitiv::ema::access::VectorEntry::getAckMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- AckMsg class reference to contained entry's load object
◆ getAction()
VectorAction refinitiv::ema::access::VectorEntry::getAction |
( |
| ) |
const |
Returns the current action on the OMM data.
- Returns
- VectorEntry Action
◆ getAnsiPage()
const OmmAnsiPage& refinitiv::ema::access::VectorEntry::getAnsiPage |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmAnsiPage class reference to contained entry's load object
◆ getElementList()
const ElementList& refinitiv::ema::access::VectorEntry::getElementList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ElementList class reference to contained entry's load object
◆ getError()
const OmmError& refinitiv::ema::access::VectorEntry::getError |
( |
| ) |
const |
Returns Error.
- Exceptions
-
- Returns
- OmmError class reference to contained entry's load object
◆ getFieldList()
const FieldList& refinitiv::ema::access::VectorEntry::getFieldList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FieldList class reference to contained entry's load object
◆ getFilterList()
const FilterList& refinitiv::ema::access::VectorEntry::getFilterList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FilterList class reference to contained entry's load object
◆ getGenericMsg()
const GenericMsg& refinitiv::ema::access::VectorEntry::getGenericMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- GenericMsg class reference to contained entry's load object
◆ getLoad()
const Data& refinitiv::ema::access::VectorEntry::getLoad |
( |
| ) |
const |
Returns the contained Data based on the DataType.
- Returns
- Data class reference to contained entry's load object
◆ getLoadType()
Returns the DataType of the entry's load.
- Returns
- data type of the contained object
◆ getMap()
const Map& refinitiv::ema::access::VectorEntry::getMap |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Map class reference to contained entry's load object
◆ getOpaque()
const OmmOpaque& refinitiv::ema::access::VectorEntry::getOpaque |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmOpaque class reference to contained entry's load object
◆ getPermissionData()
const EmaBuffer& refinitiv::ema::access::VectorEntry::getPermissionData |
( |
| ) |
const |
Returns PermissionData.
- Exceptions
-
- Returns
- EmaBuffer containing permission information
◆ getPosition()
UInt32 refinitiv::ema::access::VectorEntry::getPosition |
( |
| ) |
const |
Returns position of the entry.
- Returns
- entry's position
◆ getPostMsg()
const PostMsg& refinitiv::ema::access::VectorEntry::getPostMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- PostMsg class reference to contained entry's load object
◆ getRefreshMsg()
const RefreshMsg& refinitiv::ema::access::VectorEntry::getRefreshMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- RefreshMsg class reference to contained entry's load object
◆ getReqMsg()
const ReqMsg& refinitiv::ema::access::VectorEntry::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::VectorEntry::getSeries |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Series class reference to contained entry's load object
◆ getStatusMsg()
const StatusMsg& refinitiv::ema::access::VectorEntry::getStatusMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- StatusMsg class reference to contained entry's load object
◆ getUpdateMsg()
const UpdateMsg& refinitiv::ema::access::VectorEntry::getUpdateMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- UpdateMsg class reference to contained entry's load object
◆ getVector()
const Vector& refinitiv::ema::access::VectorEntry::getVector |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Vector class reference to contained entry's load object
◆ getVectorActionAsString()
const EmaString& refinitiv::ema::access::VectorEntry::getVectorActionAsString |
( |
| ) |
const |
Returns the VectorAction value as a string format.
- Returns
- EmaString containing string representation of VectorAction
◆ getXml()
const OmmXml& refinitiv::ema::access::VectorEntry::getXml |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmXml class reference to contained entry's load object
◆ hasPermissionData()
bool refinitiv::ema::access::VectorEntry::hasPermissionData |
( |
| ) |
const |
Indicates presence of PermissionData.
- Returns
- true if permission data is set; false otherwise
◆ toString()
const EmaString& refinitiv::ema::access::VectorEntry::toString |
( |
| ) |
const |
Returns a string representation of the class instance.
- Returns
- string representation of the class instance