FieldEntry represents an entry of FieldList.
More...
FieldEntry associates entry's field id, name, data and its data type.
{
while ( fList.forth() )
{
const FieldEntry& fieldEntry = fList.getEntry();
Int32 fieldId = fieldEntry.getFieldId();
...
}
}
int Int32
represents 32-bit signed integer
- 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 98 of file FieldEntry.h.
◆ getAckMsg()
const AckMsg& refinitiv::ema::access::FieldEntry::getAckMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- AckMsg class reference to contained object
◆ getAnsiPage()
const OmmAnsiPage& refinitiv::ema::access::FieldEntry::getAnsiPage |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmAnsiPage class reference to contained object
◆ getArray()
const OmmArray& refinitiv::ema::access::FieldEntry::getArray |
( |
| ) |
const |
Returns current OMM data represented as an OmmArray.
- Exceptions
-
- Returns
- OmmArray class reference to contained object
◆ getAscii()
const EmaString& refinitiv::ema::access::FieldEntry::getAscii |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- EmaString
◆ getBuffer()
const EmaBuffer& refinitiv::ema::access::FieldEntry::getBuffer |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- EmaBuffer
◆ getCode()
Returns the Code of the entry's load. The code indicates a special state of a Data.
- Returns
- data code of the contained object
◆ getDate()
const OmmDate& refinitiv::ema::access::FieldEntry::getDate |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- OmmDate class reference to contained object
◆ getDateTime()
const OmmDateTime& refinitiv::ema::access::FieldEntry::getDateTime |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- OmmDateTime class reference to contained object
◆ getDouble()
double refinitiv::ema::access::FieldEntry::getDouble |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- double
◆ getElementList()
const ElementList& refinitiv::ema::access::FieldEntry::getElementList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ElementList class reference to contained object
◆ getEnum()
UInt16 refinitiv::ema::access::FieldEntry::getEnum |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- UInt16
◆ getEnumDisplay()
const EmaString& refinitiv::ema::access::FieldEntry::getEnumDisplay |
( |
| ) |
const |
Returns the display value for the OmmEnum type. Calling this method must be preceded by a call to hasEnumDisplay().
- Exceptions
-
- Returns
- EmaString containing the display value
◆ getError()
const OmmError& refinitiv::ema::access::FieldEntry::getError |
( |
| ) |
const |
Returns Error.
- Exceptions
-
- Returns
- OmmError class reference to contained object
◆ getFieldId()
Int16 refinitiv::ema::access::FieldEntry::getFieldId |
( |
| ) |
const |
Returns FieldId.
- Returns
- field id
◆ getFieldList()
const FieldList& refinitiv::ema::access::FieldEntry::getFieldList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FieldList class reference to contained object
◆ getFilterList()
const FilterList& refinitiv::ema::access::FieldEntry::getFilterList |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- FilterList class reference to contained object
◆ getFloat()
float refinitiv::ema::access::FieldEntry::getFloat |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- float
◆ getGenericMsg()
const GenericMsg& refinitiv::ema::access::FieldEntry::getGenericMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- GenericMsg class reference to contained object
◆ getInt()
Int64 refinitiv::ema::access::FieldEntry::getInt |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- Int64
◆ getLoad()
const Data& refinitiv::ema::access::FieldEntry::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::FieldEntry::getMap |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Map class reference to contained object
◆ getName()
const EmaString& refinitiv::ema::access::FieldEntry::getName |
( |
| ) |
const |
Returns acronym field name associated to the FieldId from the field dictionary.
- Returns
- EmaString containing name of the entry
◆ getOpaque()
const OmmOpaque& refinitiv::ema::access::FieldEntry::getOpaque |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmOpaque class reference to contained object
◆ getPostMsg()
const PostMsg& refinitiv::ema::access::FieldEntry::getPostMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- PostMsg class reference to contained object
◆ getQos()
const OmmQos& refinitiv::ema::access::FieldEntry::getQos |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- OmmQos class reference to contained object
◆ getReal()
const OmmReal& refinitiv::ema::access::FieldEntry::getReal |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- OmmReal class reference to contained object
◆ getRefreshMsg()
const RefreshMsg& refinitiv::ema::access::FieldEntry::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::FieldEntry::getReqMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- ReqMsg class reference to contained object
◆ getRippleTo()
Int16 refinitiv::ema::access::FieldEntry::getRippleTo |
( |
Int16 |
fieldId = 0 | ) |
const |
Returns a ripple FieldId if the current entry has a ripple field. A subsequent call using the former non-zero return value as a formal parameter, returns the next ripple field in a ripple sequence.
- Parameters
-
- Returns
- ripple field id; zero if no ripple field or the final ripple field of a ripple sequence.
◆ getRippleToName()
const EmaString& refinitiv::ema::access::FieldEntry::getRippleToName |
( |
Int16 |
fieldId = 0 | ) |
const |
Returns a ripple field name if the current entry has a ripple field. A subsequent call using the former non-zero return value as a formal parameter, returns the next ripple field in a ripple sequence.
- Parameters
-
- Returns
- ripple field name; empty string if no ripple field or the final ripple field of a ripple sequence.
◆ getRmtes()
const RmtesBuffer& refinitiv::ema::access::FieldEntry::getRmtes |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- RmtesBuffer
◆ getSeries()
const Series& refinitiv::ema::access::FieldEntry::getSeries |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- Series class reference to contained object
◆ getState()
const OmmState& refinitiv::ema::access::FieldEntry::getState |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- OmmState class reference to contained object
◆ getStatusMsg()
const StatusMsg& refinitiv::ema::access::FieldEntry::getStatusMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- StatusMsg class reference to contained object
◆ getTime()
const OmmTime& refinitiv::ema::access::FieldEntry::getTime |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- ommTime class reference to contained object
◆ getUInt()
UInt64 refinitiv::ema::access::FieldEntry::getUInt |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- UInt64
◆ getUpdateMsg()
const UpdateMsg& refinitiv::ema::access::FieldEntry::getUpdateMsg |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- UpdateMsg class reference to contained object
◆ getUtf8()
const EmaBuffer& refinitiv::ema::access::FieldEntry::getUtf8 |
( |
| ) |
const |
Returns the current OMM data represented as a specific simple type.
- Exceptions
-
- Returns
- EmaBuffer
◆ getVector()
const Vector& refinitiv::ema::access::FieldEntry::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::FieldEntry::getXml |
( |
| ) |
const |
Returns the current OMM data represented as a specific complex type.
- Exceptions
-
- Returns
- OmmXml class reference to contained object
◆ hasEnumDisplay()
bool refinitiv::ema::access::FieldEntry::hasEnumDisplay |
( |
| ) |
const |
Indicates presence of the display value for the OmmEnum type.
- Returns
- true if the display value exists; false otherwise
◆ toString()
const EmaString& refinitiv::ema::access::FieldEntry::toString |
( |
| ) |
const |
Returns a string representation of the class instance.
- Returns
- string representation of the class instance