EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Friends
thomsonreuters::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
 
const ComplexTypegetData () const
 
const ReqMsggetReqMsg () const
 
const RefreshMsggetRefreshMsg () const
 
const UpdateMsggetUpdateMsg () const
 
const StatusMsggetStatusMsg () const
 
const PostMsggetPostMsg () const
 
const AckMsggetAckMsg () const
 
const GenericMsggetGenericMsg () const
 
const FieldListgetFieldList () const
 
const ElementListgetElementList () const
 
const MapgetMap () const
 
const VectorgetVector () const
 
const SeriesgetSeries () const
 
const FilterListgetFilterList () const
 
const OmmOpaquegetOpaque () const
 
const OmmXmlgetXml () const
 
const OmmAnsiPagegetAnsiPage () const
 
const OmmErrorgetError () const
 
Destructor
virtual ~SummaryData ()
 

Friends

class Map
 
class Series
 
class Vector
 

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

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

Destructor.

Member Function Documentation

const AckMsg& thomsonreuters::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
const OmmAnsiPage& thomsonreuters::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
const ComplexType& thomsonreuters::ema::access::SummaryData::getData ( ) const

Returns the complex type based on the DataType.

Returns
ComplexType class reference to the contained object
DataType::DataTypeEnum thomsonreuters::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
const ElementList& thomsonreuters::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
const OmmError& thomsonreuters::ema::access::SummaryData::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained object
const FieldList& thomsonreuters::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
const FilterList& thomsonreuters::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
const GenericMsg& thomsonreuters::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
const Map& thomsonreuters::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
const OmmOpaque& thomsonreuters::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
const PostMsg& thomsonreuters::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
const RefreshMsg& thomsonreuters::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
const ReqMsg& thomsonreuters::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
const Series& thomsonreuters::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
const StatusMsg& thomsonreuters::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
const UpdateMsg& thomsonreuters::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
const Vector& thomsonreuters::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
const OmmXml& thomsonreuters::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

Friends And Related Function Documentation

friend class Map
friend

Definition at line 228 of file SummaryData.h.

friend class Series
friend

Definition at line 229 of file SummaryData.h.

friend class Vector
friend

Definition at line 230 of file SummaryData.h.