Classes Files

Wombat::MamdaTradeReport

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

Inherits from Wombat.MamdaBasicEvent

Inherited by Wombat.MamdaTradeListener

Public Functions

  Name
MamaPrice getTradePrice()
Return the trade price.
MamdaFieldState getTradePriceFieldState()
Get the field state
string getTradeId()
Return the trade id.
MamdaFieldState getTradeIdFieldState()
Get the field state
long getTradeVolume()
Return the trade volume.
string getSide()
Returns the Aggressor side or TradeSide
MamdaFieldState getSideFieldState()
Get the field state
MamdaFieldState getTradeVolumeFieldState()
Get the field state
string getTradePartId()
Return the participant identifier.
MamdaFieldState getTradePartIdFieldState()
Get the field state
string getTradeQual()
Return the normalized trade qualifier.
MamdaFieldState getTradeQualFieldState()
Get the field state
string getTradeQualNativeStr()
The native, non normalized, trade qualifier. getTradeQual
MamdaFieldState getTradeQualNativeStrFieldState()
Get the field state
string getTradeCondition()
Return the exchange provided trade condition.
MamdaFieldState getTradeConditionFieldState()
Get the field state
long getTradeSellersSaleDays()
Return the seller trade days.
MamdaFieldState getTradeSellersSaleDaysFieldState()
Get the field state
char getTradeStopStock()
Return the stopped stock indicator.
MamdaFieldState getTradeStopStockFieldState()
Get the field state
bool getIsIrregular()
Return whether this is an irregular trade.
MamdaFieldState getIsIrregularFieldState()
Get the field state
char getShortSaleCircuitBreaker()
Get the ShortSaleCircuitBreaker
MamdaFieldState getShortSaleCircuitBreakerFieldState()
Get the field state

Additional inherited members

Public Functions inherited from Wombat.MamdaBasicEvent

  Name
DateTime getSrcTime()
Returns the source time.
MamdaFieldState getSrcTimeFieldState()
Returns the field state.
DateTime getActivityTime()
MamdaFieldState getActivityTimeFieldState()
Returns the field state.
long getEventSeqNum()
MamdaFieldState getEventSeqNumFieldState()
Returns the field state.
DateTime getEventTime()
MamdaFieldState getEventTimeFieldState()
Returns the field state.

Public Functions Documentation

function getTradePrice

MamaPrice getTradePrice()

Return the trade price.

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

Reimplemented by: Wombat::MamdaTradeListener::getTradePrice

function getTradePriceFieldState

MamdaFieldState getTradePriceFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradePriceFieldState

function getTradeId

string getTradeId()

Return the trade id.

Reimplemented by: Wombat::MamdaTradeListener::getTradeId

function getTradeIdFieldState

MamdaFieldState getTradeIdFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeIdFieldState

function getTradeVolume

long getTradeVolume()

Return the trade volume.

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

Reimplemented by: Wombat::MamdaTradeListener::getTradeVolume

function getSide

string getSide()

Returns the Aggressor side or TradeSide

Return:

Reimplemented by: Wombat::MamdaTradeListener::getSide

AggressorSide: 0 : No AggressorSide is currently known/available. 1 or B : Buy 2 or S : Sell

TradeSide: TRADE_SIDE_UNKNOWN TRADE_SIDE_BUY TRADE_SIDE_SELL

function getSideFieldState

MamdaFieldState getSideFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getSideFieldState

function getTradeVolumeFieldState

MamdaFieldState getTradeVolumeFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeVolumeFieldState

function getTradePartId

string getTradePartId()

Return the participant identifier.

Return: Trade participant ID. This is typically an exchange ID or a market maker ID. In the future, we will make this a configurable enumeration.

Reimplemented by: Wombat::MamdaTradeListener::getTradePartId

function getTradePartIdFieldState

MamdaFieldState getTradePartIdFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradePartIdFieldState

function getTradeQual

string getTradeQual()

Return the normalized trade qualifier.

Return: Trade qualifier. A normalized set of qualifiers for the current trade for the security.

Reimplemented by: Wombat::MamdaTradeListener::getTradeQual

This field may contain multiple string values, separated by the colon(:) character. In the future, we will make this a configurable enumeration.

Value Meaning
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  

function getTradeQualFieldState

MamdaFieldState getTradeQualFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeQualFieldState

function getTradeQualNativeStr

string getTradeQualNativeStr()

The native, non normalized, trade qualifier. getTradeQual

Return:

Reimplemented by: Wombat::MamdaTradeListener::getTradeQualNativeStr

function getTradeQualNativeStrFieldState

MamdaFieldState getTradeQualNativeStrFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeQualNativeStrFieldState

function getTradeCondition

string getTradeCondition()

Return the exchange provided trade condition.

Return: Trade condition (a.k.a. “sale condition”). Feed-specific trade qualifier code(s). getTradeQual

Reimplemented by: Wombat::MamdaTradeListener::getTradeCondition

function getTradeConditionFieldState

MamdaFieldState getTradeConditionFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeConditionFieldState

function getTradeSellersSaleDays

long getTradeSellersSaleDays()

Return the seller trade days.

Return: Seller’s sale days. Used when the trade qualifier is “Seller”. Specifies the number of days that may elapse before delivery of the security.

Reimplemented by: Wombat::MamdaTradeListener::getTradeSellersSaleDays

function getTradeSellersSaleDaysFieldState

MamdaFieldState getTradeSellersSaleDaysFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeSellersSaleDaysFieldState

function getTradeStopStock

char getTradeStopStock()

Return the stopped stock indicator.

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

Reimplemented by: Wombat::MamdaTradeListener::getTradeStopStock

function getTradeStopStockFieldState

MamdaFieldState getTradeStopStockFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getTradeStopStockFieldState

function getIsIrregular

bool getIsIrregular()

Return whether this is an irregular trade.

Return: 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.

Reimplemented by: Wombat::MamdaTradeListener::getIsIrregular

function getIsIrregularFieldState

MamdaFieldState getIsIrregularFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getIsIrregularFieldState

function getShortSaleCircuitBreaker

char getShortSaleCircuitBreaker()

Get the ShortSaleCircuitBreaker

Return: 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.

Reimplemented by: Wombat::MamdaTradeListener::getShortSaleCircuitBreaker

function getShortSaleCircuitBreakerFieldState

MamdaFieldState getShortSaleCircuitBreakerFieldState()

Get the field state

Return: Field State

Reimplemented by: Wombat::MamdaTradeListener::getShortSaleCircuitBreakerFieldState


Updated on 2023-03-31 at 15:30:16 +0100