OpenMAMA
Wombat::MamdaTradeReport Class Referenceabstract

MamdaTradeReport is an interface that provides access to fields related to a trade report. More...

#include <MamdaTradeReport.h>

Inheritance diagram for Wombat::MamdaTradeReport:
Wombat::MamdaBasicEvent Wombat::MamdaTradeListener

Public Member Functions

virtual const MamaPrice & getTradePrice () const =0
 Get the trade price. More...
 
virtual mama_quantity_t getTradeVolume () const =0
 Get the volume of shares in the trade. More...
 
virtual const char * getTradePartId () const =0
 Get the participant identifier for the trade. More...
 
virtual const char * getTradeQual () const =0
 Get the NYSE Technologies normalized trade qualifier. More...
 
virtual const char * getTradeQualNative () const =0
 Get the native feed trade qualifier. More...
 
virtual const char * getSide () const =0
 
virtual MamdaFieldState getSideFieldState () const =0
 The TradeSide or AggressorSide Field State. More...
 
virtual mama_u32_t getTradeSellersSaleDays () const =0
 Get the trade sellers sale days. More...
 
virtual char getTradeStopStock () const =0
 Get the trade stop stock indicator. More...
 
virtual bool getIsIrregular () const =0
 Get whether the trade is irregular. More...
 
virtual mama_u64_t getOrderId () const =0
 Get the order id, if available. More...
 
virtual const char * getUniqueId () const =0
 Get the unique ID. More...
 
virtual const char * getTradeAction () const =0
 Get the trade action. More...
 
virtual const char * getTradeId () const =0
 Get the trade id. More...
 
virtual char getShortSaleCircuitBreaker () const =0
 get the ShortSaleCircuitBreaker More...
 
virtual MamdaFieldState getTradePriceFieldState () const =0
 The trade price Field State. More...
 
virtual MamdaFieldState getTradeVolumeFieldState () const =0
 The trade volume Field State. More...
 
virtual MamdaFieldState getTradePartIdFieldState () const =0
 The trade part ID Field State. More...
 
virtual MamdaFieldState getTradeQualFieldState () const =0
 The trade qual Field State. More...
 
virtual MamdaFieldState getTradeQualNativeFieldState () const =0
 The trade quality native Field State. More...
 
virtual MamdaFieldState getTradeSellersSaleDaysFieldState () const =0
 The trade sellers sale days Field State. More...
 
virtual MamdaFieldState getTradeStopStockFieldState () const =0
 The trade stop stock Field State. More...
 
virtual MamdaFieldState getIsIrregularFieldState () const =0
 The isIrregular Field State. More...
 
virtual MamdaFieldState getOrderIdFieldState () const =0
 The order ID Field State. More...
 
virtual MamdaFieldState getUniqueIdFieldState () const =0
 The unique ID Field State. More...
 
virtual MamdaFieldState getTradeActionFieldState () const =0
 The trade action Field State. More...
 
virtual MamdaFieldState getTradeIdFieldState () const =0
 The trade ID Field State. More...
 
virtual MamdaFieldState getShortSaleCircuitBreakerFieldState () const =0
 
virtual ~MamdaTradeReport ()
 
- Public Member Functions inherited from Wombat::MamdaBasicEvent
virtual const char * getSymbol () const =0
 Get the instruments string symbol. More...
 
virtual MamdaFieldState getSymbolFieldState () const =0
 Get the string symbol field state. More...
 
virtual const char * getPartId () const =0
 Get the participant identifier. More...
 
virtual MamdaFieldState getPartIdFieldState () const =0
 Get the participant identifier field state. More...
 
virtual mama_seqnum_t getEventSeqNum () const =0
 Get the event sequence number. More...
 
virtual MamdaFieldState getEventSeqNumFieldState () const =0
 Get the event sequence number field state. More...
 
virtual const MamaDateTime & getEventTime () const =0
 Get the event time. More...
 
virtual MamdaFieldState getEventTimeFieldState () const =0
 Get the event time field state. More...
 
virtual const MamaDateTime & getSrcTime () const =0
 Get the source time. More...
 
virtual MamdaFieldState getSrcTimeFieldState () const =0
 Get the source time field state. More...
 
virtual const MamaDateTime & getActivityTime () const =0
 Get the activity time. More...
 
virtual MamdaFieldState getActivityTimeFieldState () const =0
 Get the activity time field state. More...
 
virtual const MamaDateTime & getLineTime () const =0
 Get the line time. More...
 
virtual MamdaFieldState getLineTimeFieldState () const =0
 Get the line time of the update. More...
 
virtual const MamaDateTime & getSendTime () const =0
 Get the send time. More...
 
virtual MamdaFieldState getSendTimeFieldState () const =0
 Get the send time field state. More...
 
virtual const MamaMsgQual & getMsgQual () const =0
 Get the message qualifier. More...
 
virtual MamdaFieldState getMsgQualFieldState () const =0
 Get the message qualifier field state. More...
 
virtual ~MamdaBasicEvent ()
 Destructor. More...
 

Detailed Description

MamdaTradeReport is an interface that provides access to fields related to a trade report.

This class is used for all trade reports, whether those trades qualify as regular or irregular trades. (A regular trade generally qualifies to update the official last price and intraday high/low prices.)

Constructor & Destructor Documentation

virtual Wombat::MamdaTradeReport::~MamdaTradeReport ( )
virtual
469 {};

Member Function Documentation

virtual const MamaPrice& Wombat::MamdaTradeReport::getTradePrice ( ) const
pure virtual

Get the trade price.

Returns
The monetary value of an individual share of the security at the time of the trade.

Implemented in Wombat::MamdaTradeListener.

virtual mama_quantity_t Wombat::MamdaTradeReport::getTradeVolume ( ) const
pure virtual

Get the volume of shares in the trade.

Returns
The number of shares traded in a single transaction for an individual security.

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getTradePartId ( ) const
pure virtual

Get the participant identifier for the trade.

Returns
Trade participant ID. This is typically an exchange ID or a market maker ID.

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getTradeQual ( ) const
pure virtual

Get the NYSE Technologies normalized trade qualifier.

Returns
Trade qualifier. A normalized set of qualifiers for the current trade for the security. This field may contain multiple string values, separated by the colon(:) character.
ValueMeaning
Normal Regular trade. A trade made without stated conditions is deemed regular way for settlement on the third * business day following the transaction * date.
Acquisition A transaction made on the Exchange as a result of an Exchange acquisition.
Bunched A trade representing an aggregate of two or more regular trades in a security occurring at the same price either simultaneously or within the same 60 second period, with no individual trade exceeding 10,000 shares.
Cash A transaction which calls for the delivery of securities and payment on the same day the trade takes place.
Distribution Sale of a large block of stock in such a manner that the price is not adversely affected.
BunchedSold A bunched trade which is reported late
Rule155 To qualify as a 155 print, a specialist arranges for the sale of the block at one "clean-up" price or at the different price limits on his book. If the block is sold at a "clean-up" price, the specialist should execute at the same price all the executable buy orders on his book. The sale qualifier is only applicable for AMEX trades.
SoldLast Sold Last is used when a trade prints in sequence but is reported late or printed in conformance to the One or Two Point Rule.
NextDay A transaction which calls for delivery of securities on the first business day after the trade date.
Opened Indicates an opening transaction that is printed out of sequence or reported late or printed in conformance to the One or Two Point Rule.
PriorRef An executed trade that relates to an obligation to trade at an earlier point in the trading day or that refer to a prior reference price. This may be the result of an order that was lost or misplaced or a SelectNet order that was not executed on a timely basis.
Seller A Seller's option transaction is a special transaction which gives the seller the right to deliver the stock at any time within a specific period, ranging from not less than four calendar days to no more than 60 calendar days.
SplitTrade An execution in two markets when the specialist or Market Maker in the market first receiving the order agrees to execute a portion of it at whatever price is realized in another market to which the balance of the order is forwarded for execution.
FormT See PrePostMkt. Currently, all feed handlers that post Form-T trades - except CTA - send this qualifier for Form-T trades. In the next major release, all fields will use PrePostMkt and FormT will be obsolete.
PrePostMkt A trade reported before or after the normal trade reporting day. This is also known as a Form-T trade. The volume of Form-T trades will be included in the calculation of total volume. The price information in Form-T trades will not be used to update high, low and last sale data for individual securities or Indices since they occur outside of normal trade reporting hours. Currently, all feed handlers that post Form-T trades - except CTA - send the "FormT" qualifier for Fot-T trades. In the next major release, all feed handlers will use PrePostMkt and FormT will be obsolete.
AvPrice A trade where the price reported is based upon an average of the prices for transactions in a security during all or any portion of the trading day.
Sold Sold is used when a trade is printed (reported) out of sequence and at a time different from the actual transaction time.
Adjusted  
Auto A sale condition code that identifies a NYSE trade that has been automatically executed without the potential benefit of price improvement.
Basket  
CashOnly  
NextDayOnly  
SpecTerms  
Stopped  
CATS  
VCT  
Rule127  
BurstBasket A burst basket execution signifies a trade wherein the equity Specialists, acting in the aggregate as a market maker, purchase or sell the component stocks required for execution of a specific basket trade.
OpenDetail Opening trade detail message. Sent by CTS only and is a duplicate report of an earlier trade. Note: since feed handler version 2.14.32, it is configurable whether these detail messages are published.
Detail Trade detail message. Sent by CTS only and is a duplicate report of an earlier trade. Note: since feed handler version 2.14.32, it is configurable whether these detail messages are published.
Reserved  
BasketCross  
BasketIndexOnClose A basket index on close transaction signifies a trade involving paired basket orders,the execution of which is based on the closing value of the index. These trades are reported after the close when the index closing value is determined.
IntermarketSweep Indicates to CTS data recipients that the execution price reflects the order instruction not to send the order to another market that may have a superior price.
YellowFlag Regular trades reported during specific events as out of the ordinary.
MarketCenterOpen  
MarketCenterClose  
Unknown  

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getTradeQualNative ( ) const
pure virtual

Get the native feed trade qualifier.

Returns
Native trade qualifier (a.k.a. "sale condition"). Feed-specific trade qualifier code(s). This field is provided primarily for completeness and/or troubleshooting.
See also
getTradeQual.

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getSide ( ) const
pure virtual
Returns
the Aggressor Side or TradeSide TradeSide
  • 0 : No TradeSide is currently known/available.
  • 1 or B : Buy
  • 2 or S : Sell
    • 0 : No AggressorSide is currently known/available.
    • 1 or B : Buy
    • 2 or S : Sell

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getSideFieldState ( ) const
pure virtual

The TradeSide or AggressorSide Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual mama_u32_t Wombat::MamdaTradeReport::getTradeSellersSaleDays ( ) const
pure virtual

Get the trade sellers sale days.

Returns
Seller's sale days. Used when the trade qualifier is "Seller". Specifies the number of days that may elapse before delivery of the security.

Implemented in Wombat::MamdaTradeListener.

virtual char Wombat::MamdaTradeReport::getTradeStopStock ( ) const
pure virtual

Get the trade stop stock indicator.

Returns
Stopped stock indicator. Condition related to certain NYSE trading rules. This is not related to a halted security status. (0 == N/A; 1 == Applicable)

Implemented in Wombat::MamdaTradeListener.

virtual bool Wombat::MamdaTradeReport::getIsIrregular ( ) const
pure virtual

Get whether the trade is irregular.

Returns
Whether or not the trade qualifies as an irregular trade. In general, only "regular" trades qualify to update the official last price and high/low prices.

Implemented in Wombat::MamdaTradeListener.

virtual mama_u64_t Wombat::MamdaTradeReport::getOrderId ( ) const
pure virtual

Get the order id, if available.

Returns
The trade message unique order id number (if available).

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getUniqueId ( ) const
pure virtual

Get the unique ID.

Returns
The unique ID

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getTradeAction ( ) const
pure virtual

Get the trade action.

Returns
The trade action

Implemented in Wombat::MamdaTradeListener.

virtual const char* Wombat::MamdaTradeReport::getTradeId ( ) const
pure virtual

Get the trade id.

Returns
the trade id

Implemented in Wombat::MamdaTradeListener.

virtual char Wombat::MamdaTradeReport::getShortSaleCircuitBreaker ( ) const
pure virtual

get the ShortSaleCircuitBreaker

Returns
ShortSaleCircuitBreaker
  • return values:
  • Blank: Short Sale Restriction Not in Effect.
  • A: Short Sale Restriction Activiated.
  • C: Short Sale Restriction Continued.
  • D: Sale Restriction Deactivated.
  • E: Sale Restriction in Effect.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradePriceFieldState ( ) const
pure virtual

The trade price Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeVolumeFieldState ( ) const
pure virtual

The trade volume Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradePartIdFieldState ( ) const
pure virtual

The trade part ID Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeQualFieldState ( ) const
pure virtual

The trade qual Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeQualNativeFieldState ( ) const
pure virtual

The trade quality native Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeSellersSaleDaysFieldState ( ) const
pure virtual

The trade sellers sale days Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeStopStockFieldState ( ) const
pure virtual

The trade stop stock Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getIsIrregularFieldState ( ) const
pure virtual

The isIrregular Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getOrderIdFieldState ( ) const
pure virtual

The order ID Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getUniqueIdFieldState ( ) const
pure virtual

The unique ID Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeActionFieldState ( ) const
pure virtual

The trade action Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getTradeIdFieldState ( ) const
pure virtual

The trade ID Field State.

Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.

virtual MamdaFieldState Wombat::MamdaTradeReport::getShortSaleCircuitBreakerFieldState ( ) const
pure virtual
Returns
MamdaFieldState. An enumeration representing field state.

Implemented in Wombat::MamdaTradeListener.


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


© 2012 Linux Foundation