EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Friends
thomsonreuters::ema::access::Attrib Class Reference

Attrib conveys message attribute information. 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 ~Attrib ()
 

Friends

class Msg
 

Detailed Description

Attrib is used to provide item identification information. This information is provided as an addition to the item name, service, quality of service and domain type. Attrib contains objects of complex type.

The following code snippet shows extracting of Attrib and its content while processing RefreshMsg.

class AppClient : public OmmConsumerClient
{
...
void onRefreshMsg( const RefreshMsg& , const OmmConsumerEvent& );
};
void AppClient::onRefreshMsg( const RefreshMsg& refreshMsg, const OmmConsumerEvent& )
{
...
const Attrib& attrib = refreshMsg.getAttrib();
switch ( attrib.getDataType() )
{
decode( attrib.getFieldList() );
break;
decode( attrib.getMap() );
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 Attrib 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 107 of file Attrib.h.

Constructor & Destructor Documentation

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

Destructor.

Member Function Documentation

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

Returns the complex type based on the DataType.

Returns
ComplexType class reference to contained object
DataType::DataTypeEnum thomsonreuters::ema::access::Attrib::getDataType ( ) const

Returns the DataType of the contained data.

Remarks
return of DataType::NoDataEnum signifies no data present in Attrib
return of DataType::OmmErrorEnum signifies error while extracting content of Attrib
Returns
data type of the contained object
const ElementList& thomsonreuters::ema::access::Attrib::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::Attrib::getError ( ) const

Returns Error.

Exceptions
OmmInvalidUsageExceptionif contained object is not OmmError
Returns
OmmError class reference to contained object
const FieldList& thomsonreuters::ema::access::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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::Attrib::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 Msg
friend

Definition at line 237 of file Attrib.h.