EMA C++ Edition
List of all members
refinitiv::ema::access::SummaryData Class Reference

SummaryData is used to convey Omm SummaryData information optionally present on Map, Series and Vector. More...

Public Member Functions

Accessors
DataType::DataTypeEnum getDataType () const
  More...
 
const ComplexTypegetData () const
  More...
 
const ReqMsggetReqMsg () const
  More...
 
const RefreshMsggetRefreshMsg () const
  More...
 
const UpdateMsggetUpdateMsg () const
  More...
 
const StatusMsggetStatusMsg () const
  More...
 
const PostMsggetPostMsg () const
  More...
 
const AckMsggetAckMsg () const
  More...
 
const GenericMsggetGenericMsg () const
  More...
 
const FieldListgetFieldList () const
  More...
 
const ElementListgetElementList () const
  More...
 
const MapgetMap () const
  More...
 
const VectorgetVector () const
  More...
 
const SeriesgetSeries () const
  More...
 
const FilterListgetFilterList () const
  More...
 
const OmmOpaquegetOpaque () const
  More...
 
const OmmXmlgetXml () const
  More...
 
const OmmAnsiPagegetAnsiPage () const
  More...
 
const OmmErrorgetError () const
  More...
 

Destructor

class Map
 
class Series
 
class Vector
 
virtual ~SummaryData ()
  More...
 

Detailed Description

SummaryData contains objects of complex type.

The following code snippet shows extracting of SummaryData and its content while getting data from Map.

void decodeMap( const Map& map )
{
...
const SummaryData& summaryData = map.getSummaryData();
switch ( summaryData.getDataType() )
{
decodeFieldList( summaryData.getFieldList() );
break;
decodeElementList( summaryData.getElementList() );
break;
break;
}
...
}
Remarks
Objects of this class are intended to be short lived or rather transitional.
This class is designed to efficiently perform extracting of SummaryData and its content.
Objects of this class are not cache-able.
All methods in this class are Lock-free Method.
See also
ComplexType ReqMsg, RefreshMsg, UpdateMsg, StatusMsg, GenericMsg, PostMsg, AckMsg, FieldList, ElementList, Map, Vector, Series, FilterList, OmmOpaque, OmmXml, OmmAnsiPage, OmmError

Definition at line 98 of file SummaryData.h.

Constructor & Destructor Documentation

◆ ~SummaryData()

virtual refinitiv::ema::access::SummaryData::~SummaryData ( )
virtual

Destructor.

Member Function Documentation

◆ getAckMsg()

const AckMsg& refinitiv::ema::access::SummaryData::getAckMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not AckMsg
Returns
AckMsg class reference to contained object

◆ getAnsiPage()

const OmmAnsiPage& refinitiv::ema::access::SummaryData::getAnsiPage ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmAnsiPage
Returns
OmmAnsiPage class reference to contained object

◆ getData()

const ComplexType& refinitiv::ema::access::SummaryData::getData ( ) const

Returns the complex type based on the DataType.

Returns
ComplexType class reference to the contained object

◆ getDataType()

DataType::DataTypeEnum refinitiv::ema::access::SummaryData::getDataType ( ) const

Returns the DataType of the contained data.

Remarks
return of DataType::NoDataEnum signifies no data present in SummaryData
return of DataType::OmmErrorEnum signifies error while extracting content of SummaryData
Returns
data type of the contained object

◆ getElementList()

const ElementList& refinitiv::ema::access::SummaryData::getElementList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ElementList
Returns
ElementList class reference to contained object

◆ getError()

const OmmError& refinitiv::ema::access::SummaryData::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained object

◆ getFieldList()

const FieldList& refinitiv::ema::access::SummaryData::getFieldList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FieldList
Returns
FieldList class reference to contained object

◆ getFilterList()

const FilterList& refinitiv::ema::access::SummaryData::getFilterList ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not FilterList
Returns
FilterList class reference to contained object

◆ getGenericMsg()

const GenericMsg& refinitiv::ema::access::SummaryData::getGenericMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not GenericMsg
Returns
GenericMsg class reference to contained object

◆ getMap()

const Map& refinitiv::ema::access::SummaryData::getMap ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Map
Returns
Map class reference to contained object

◆ getOpaque()

const OmmOpaque& refinitiv::ema::access::SummaryData::getOpaque ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmOpaque
Returns
OmmOpaque class reference to contained object

◆ getPostMsg()

const PostMsg& refinitiv::ema::access::SummaryData::getPostMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not PostMsg
Returns
PostMsg class reference to contained object

◆ getRefreshMsg()

const RefreshMsg& refinitiv::ema::access::SummaryData::getRefreshMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not RefreshMsg
Returns
RefreshMsg class reference to contained object

◆ getReqMsg()

const ReqMsg& refinitiv::ema::access::SummaryData::getReqMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not ReqMsg
Returns
ReqMsg class reference to contained object

◆ getSeries()

const Series& refinitiv::ema::access::SummaryData::getSeries ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Series
Returns
Series class reference to contained object

◆ getStatusMsg()

const StatusMsg& refinitiv::ema::access::SummaryData::getStatusMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not StatusMsg
Returns
StatusMsg class reference to contained object

◆ getUpdateMsg()

const UpdateMsg& refinitiv::ema::access::SummaryData::getUpdateMsg ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not UpdateMsg
Returns
UpdateMsg class reference to contained object

◆ getVector()

const Vector& refinitiv::ema::access::SummaryData::getVector ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not Vector
Returns
Vector class reference to contained object

◆ getXml()

const OmmXml& refinitiv::ema::access::SummaryData::getXml ( ) const

Returns the current OMM data represented as a specific complex type.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmXml
Returns
OmmXml class reference to contained object