OpenMAMA
Wombat::MamdaBasicRecap Class Reference

MamdaBasicRecap is an interface that provides access to recap related fields. More...

#include <MamdaBasicRecap.h>

Inheritance diagram for Wombat::MamdaBasicRecap:
Wombat::MamdaAuctionRecap Wombat::MamdaBookAtomicLevel Wombat::MamdaBookAtomicLevelEntry Wombat::MamdaCurrencyRecap Wombat::MamdaFundamentals Wombat::MamdaOrderImbalanceRecap Wombat::MamdaQuoteRecap Wombat::MamdaSecStatusRecap Wombat::MamdaTradeRecap

Public Member Functions

virtual const char * getSymbol () const =0
 Get the string symbol for the instrument.
virtual MamdaFieldState getSymbolFieldState () const =0
 Get the string symbol field state for the instrument.
virtual const char * getPartId () const =0
 Get the participant identifier.
virtual MamdaFieldState getPartIdFieldState () const =0
 Get the participant identifier field state.
virtual const MamaDateTime & getSrcTime () const =0
 Get the source time of the update.
virtual MamdaFieldState getSrcTimeFieldState () const =0
 Get the source time field state.
virtual const MamaDateTime & getActivityTime () const =0
 Get the activity time of the update.
virtual MamdaFieldState getActivityTimeFieldState () const =0
 Get the activity time field state.
virtual const MamaDateTime & getLineTime () const =0
 Get the line time of the update.
virtual MamdaFieldState getLineTimeFieldState () const =0
 Get the line time field state.
virtual const MamaDateTime & getSendTime () const =0
 Get the send time of the update.
virtual MamdaFieldState getSendTimeFieldState () const =0
 Get the send time field state.
virtual ~MamdaBasicRecap ()
 Destructor.

Detailed Description

MamdaBasicRecap is an interface that provides access to recap related fields.

Constructor & Destructor Documentation

virtual Wombat::MamdaBasicRecap::~MamdaBasicRecap ( )
virtual

Destructor.

{};

Member Function Documentation

virtual const char* Wombat::MamdaBasicRecap::getSymbol ( ) const
pure virtual

Get the string symbol for the instrument.

Returns
Symbol. This is the "well-known" symbol for the security, including any symbology mapping performed by the publisher.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getSymbolFieldState ( ) const
pure virtual

Get the string symbol field state for the instrument.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaQuoteListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual const char* Wombat::MamdaBasicRecap::getPartId ( ) const
pure virtual

Get the participant identifier.

Returns
Participant ID. This may be an exchange identifier, a market maker ID, etc., or NULL (if this is not related to any specific participant).

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getPartIdFieldState ( ) const
pure virtual

Get the participant identifier field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaQuoteListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual const MamaDateTime& Wombat::MamdaBasicRecap::getSrcTime ( ) const
pure virtual

Get the source time of the update.

Returns
Source time. Typically, the exchange generated feed time stamp. This is often the same as the "event time", because many feeds do not distinguish between the actual event time and when the exchange sent the message.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getSrcTimeFieldState ( ) const
pure virtual
virtual const MamaDateTime& Wombat::MamdaBasicRecap::getActivityTime ( ) const
pure virtual

Get the activity time of the update.

Returns
Activity time. A feed handler generated time stamp representing when the data item was last updated.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getActivityTimeFieldState ( ) const
pure virtual
virtual const MamaDateTime& Wombat::MamdaBasicRecap::getLineTime ( ) const
pure virtual

Get the line time of the update.

Returns
Line time. A feed handler (or similar publisher) time stamp representing the time that such publisher received the update message pertaining to the event. If clocks are properly synchronized and the source time (see above) is accurate enough, then the difference between the source time and line time is the latency between the data source and the feed handler.

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getLineTimeFieldState ( ) const
pure virtual
virtual const MamaDateTime& Wombat::MamdaBasicRecap::getSendTime ( ) const
pure virtual

Get the send time of the update.

Returns
Send time. A feed handler (or similar publisher) time stamp representing the time that such publisher sent the current message. The difference between the line time and send time is the latency within the feed handler itself. Also, if clocks are properly synchronized then the difference between the send time and current time is the latency within the market data distribution framework (i.e. MAMA and the underlying middleware). See MAMA API: MamaDateTime::currentTime()).

Implemented in Wombat::MamdaTradeListener, Wombat::MamdaBookAtomicListener, Wombat::MamdaQuoteListener, Wombat::MamdaSecStatusListener, Wombat::MamdaFundamentalListener, Wombat::MamdaCurrencyListener, and Wombat::MamdaAuctionListener.

virtual MamdaFieldState Wombat::MamdaBasicRecap::getSendTimeFieldState ( ) const
pure virtual

The documentation for this class was generated from the following file:


© 2012 Linux Foundation