OpenMAMA
Wombat::MamdaConcreteBasicEvent Class Reference

MamdaConcreteBasicEvent is intended to be used to help implement concrete versions of various classes derived from MamdaBasicEvent. More...

#include <MamdaConcreteBasicEvent.h>

Inheritance diagram for Wombat::MamdaConcreteBasicEvent:
Wombat::MamdaBasicEvent

Public Member Functions

 MamdaConcreteBasicEvent ()
 Constructor. More...
 
virtual ~MamdaConcreteBasicEvent ()
 Destructor. More...
 
virtual const char * getSymbol () const
 Get the instruments string symbol. More...
 
virtual const char * getPartId () const
 Get the participant identifier. More...
 
virtual mama_seqnum_t getEventSeqNum () const
 Get the event sequence number. More...
 
virtual const MamaDateTime & getEventTime () const
 Get the event time. More...
 
virtual const MamaDateTime & getSrcTime () const
 Get the source time. More...
 
virtual const MamaDateTime & getActivityTime () const
 Get the activity time. More...
 
virtual const MamaDateTime & getLineTime () const
 Get the line time. More...
 
virtual const MamaDateTime & getSendTime () const
 Get the send time. More...
 
virtual const MamaMsgQual & getMsgQual () const
 Get the message qualifier. More...
 
virtual MamdaFieldState getSymbolFieldState () const
 Get the string symbol field state. More...
 
virtual MamdaFieldState getPartIdFieldState () const
 Get the participant identifier field state. More...
 
virtual MamdaFieldState getEventSeqNumFieldState () const
 Get the event sequence number field state. More...
 
virtual MamdaFieldState getEventTimeFieldState () const
 Get the event time field state. More...
 
virtual MamdaFieldState getSrcTimeFieldState () const
 Get the source time field state. More...
 
virtual MamdaFieldState getActivityTimeFieldState () const
 Get the activity time field state. More...
 
virtual MamdaFieldState getLineTimeFieldState () const
 Get the line time of the update. More...
 
virtual MamdaFieldState getSendTimeFieldState () const
 Get the send time field state. More...
 
virtual MamdaFieldState getMsgQualFieldState () const
 Get the message qualifier field state. More...
 
virtual void setSymbol (const char *value)
 
virtual void setPartId (const char *value)
 
virtual void setEventSeqNum (mama_seqnum_t value)
 
virtual void setEventTime (const MamaDateTime &value)
 
virtual void setSrcTime (const MamaDateTime &value)
 
virtual void setActivityTime (const MamaDateTime &value)
 
virtual void setLineTime (const MamaDateTime &value)
 
virtual void setSendTime (const MamaDateTime &value)
 
virtual void setMsgQual (const MamaMsgQual &value)
 
- Public Member Functions inherited from Wombat::MamdaBasicEvent
virtual ~MamdaBasicEvent ()
 Destructor. More...
 

Detailed Description

MamdaConcreteBasicEvent is intended to be used to help implement concrete versions of various classes derived from MamdaBasicEvent.

Constructor & Destructor Documentation

Wombat::MamdaConcreteBasicEvent::MamdaConcreteBasicEvent ( )

Constructor.

virtual Wombat::MamdaConcreteBasicEvent::~MamdaConcreteBasicEvent ( )
virtual

Destructor.

Member Function Documentation

virtual const char* Wombat::MamdaConcreteBasicEvent::getSymbol ( ) const
virtual

Get the instruments string symbol.

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

Implements Wombat::MamdaBasicEvent.

virtual const char* Wombat::MamdaConcreteBasicEvent::getPartId ( ) const
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).

Implements Wombat::MamdaBasicEvent.

virtual mama_seqnum_t Wombat::MamdaConcreteBasicEvent::getEventSeqNum ( ) const
virtual

Get the event sequence number.

Returns
Source sequence number. The exchange generated sequence number.

Implements Wombat::MamdaBasicEvent.

virtual const MamaDateTime& Wombat::MamdaConcreteBasicEvent::getEventTime ( ) const
virtual

Get the event time.

Returns
Event time. Typically, when the event actually occurred. This is often the same as the "source time", because many feeds do not distinguish between the actual event time and when the exchange sent the message.

Implements Wombat::MamdaBasicEvent.

virtual const MamaDateTime& Wombat::MamdaConcreteBasicEvent::getSrcTime ( ) const
virtual

Get the source time.

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.

Implements Wombat::MamdaBasicEvent.

virtual const MamaDateTime& Wombat::MamdaConcreteBasicEvent::getActivityTime ( ) const
virtual

Get the activity time.

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

Implements Wombat::MamdaBasicEvent.

virtual const MamaDateTime& Wombat::MamdaConcreteBasicEvent::getLineTime ( ) const
virtual

Get the line time.

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.

Implements Wombat::MamdaBasicEvent.

virtual const MamaDateTime& Wombat::MamdaConcreteBasicEvent::getSendTime ( ) const
virtual

Get the send time.

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()).

Implements Wombat::MamdaBasicEvent.

virtual const MamaMsgQual& Wombat::MamdaConcreteBasicEvent::getMsgQual ( ) const
virtual

Get the message qualifier.

Returns
Message Qualifier. The message qualifier provides information in relation to messages duplicate, delayed or out-of-sequence status.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getSymbolFieldState ( ) const
virtual

Get the string symbol field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getPartIdFieldState ( ) const
virtual

Get the participant identifier field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getEventSeqNumFieldState ( ) const
virtual

Get the event sequence number field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getEventTimeFieldState ( ) const
virtual

Get the event time field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getSrcTimeFieldState ( ) const
virtual

Get the source time field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getActivityTimeFieldState ( ) const
virtual

Get the activity time field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getLineTimeFieldState ( ) const
virtual

Get the line time of the update.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getSendTimeFieldState ( ) const
virtual

Get the send time field state.

Returns
MamdaFieldState. An enumeration representing field state.

Implements Wombat::MamdaBasicEvent.

virtual MamdaFieldState Wombat::MamdaConcreteBasicEvent::getMsgQualFieldState ( ) const
virtual

Get the message qualifier field state.

Returns
Message Qualifier. The message qualifier provides information in relation to messages duplicate, delayed or out-of-sequence status.

Implements Wombat::MamdaBasicEvent.

virtual void Wombat::MamdaConcreteBasicEvent::setSymbol ( const char *  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setPartId ( const char *  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setEventSeqNum ( mama_seqnum_t  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setEventTime ( const MamaDateTime &  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setSrcTime ( const MamaDateTime &  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setActivityTime ( const MamaDateTime &  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setLineTime ( const MamaDateTime &  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setSendTime ( const MamaDateTime &  value)
virtual
virtual void Wombat::MamdaConcreteBasicEvent::setMsgQual ( const MamaMsgQual &  value)
virtual

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


© 2012 Linux Foundation