OnixS C++ CME Market Data Handler  2.56.0.0
Public Member Functions | List of all members
SecurityDefinition Class Reference

Security Definition. More...

Public Member Functions

 SecurityDefinition (const Message &)
 Initializes instance from given FIX message.
 
Events events () const
 Events entries.
 
bool tradingReferencePrice (Price &price) const
 This value may be the settlement price or closing price of the prior trading day, based on values in tag 5796-TradingReferenceDate and tag 731-SettPriceType. More...
 
bool marketSegmentId (MarketSegmentID &id) const
 Identifies the market segment. Populated for all CME Globex instruments.
 
bool tradingReferenceDate (Date &date) const
 Indicates the date the last update to the settlement price, tag 1150-TradingReferencePrice, was updated in this message in YYYYMMDD format. More...
 
SettlementPriceType settlementPriceType () const
 Settlement price type if available.
 
bool highLimitPrice (Price &price) const
 Upper price threshold for the instrument. More...
 
bool lowLimitPrice (Price &price) const
 Lower price threshold for the instrument. More...
 
StringRef securityGroup () const
 Instrument Group.
 
Symbol symbol () const
 Instrument Symbol.
 
StringRef securityDescription () const
 Instrument Name.
 
bool securityId (SecurityId &id) const
 Unique instrument id (FIX tag 48) as qualified by the exchange per tag 22-SecurityIDSource. More...
 
StringRef cfiCode () const
 Indicates the type of security using ISO 10962 standard, Classification of Financial Instruments (CFI code) values. More...
 
UnderlyingProduct underlyingProduct () const
 Indicates the product complex.
 
StringRef exchange () const
 Exchange used to identify a security.
 
StringRef pricingModel () const
 Indicates which options pricing model is used to convert from volatility quote to premium and corresponding delta for vol-quoted options. More...
 
bool minCabPrice (Price &price) const
 Defines cabinet price for outright options products.
 
ExpirationCycle expirationCycle () const
 Indicates if the instrument expires at the trading session close, or at a specified last eligible trade date. More...
 
bool unitOfMeasureQty (FloatQuantity &qty) const
 This field contains the contract size for each instrument.
 
bool strikePrice (Price &price) const
 Strike Price for an option.
 
Currency strikeCurrency () const
 Currency in which the StrikePrice is denominated.
 
bool minTradeVol (HugeQuantity &volume) const
 The minimum trading volume for a security.
 
bool maxTradeVol (HugeQuantity &volume) const
 The maximum trading volume for a security.
 
Currency currency () const
 Identifies currency used for price. More...
 
Currency settlementCurrency () const
 Identifies currency used for settlement price.
 
MatchAlgorithm matchAlgorithm () const
 Matching Algorithm - CME assigned values.
 
StringRef subType () const
 Strategy type.
 
Underlyings underlyings () const
 Underlying legs that make up the security.
 
bool maxPriceVariation (Price &price) const
 Differential value for price banding.
 
ImpliedMarketIndicator impliedMarketIndicator () const
 Informs the market that an instrument is eligible for implied trading (Implied In & Out). More...
 
InstrumentAttributes instrumentAttributes () const
 Collection of instrument attributes.
 
bool maturityMonthYear (YearMonth &yearMonth) const
 This field provides the actual calendar date for contract maturity - month and year (used for standardized futures and options). More...
 
bool maturityMonthYear (Date &date) const
 This field provides the actual calendar date for contract maturity (overload for a daily products). More...
 
bool minPriceIncrement (Price &increment) const
 Minimum constant tick for the instrument, sent only if instrument is non-VTT (Variable Tick Table) eligible. More...
 
bool lastUpdateTime (TimeSpan &time) const
 Time of when the instrument was deleted.
 
bool displayFactor (PriceFactor &factor) const
 Contains the multiplier to convert the CME Globex display price to the conventional price. More...
 
Legs legs () const
 Collection of legs.
 
bool isUserDefinedInstrument () const
 Identifies user-defined instruments.
 
bool priceRatio (PriceFactor &ratio) const
 Used for price calculation in spread and leg pricing.
 
ContractMultiplierUnit contractMultiplierUnit () const
 Indicates the type of multiplier being applied to the product. More...
 
FlowScheduleType flowScheduleType () const
 The schedule according to which the electricity is delivered in a physical contract, or priced in a financial contract. More...
 
bool contractMultiplier (Quantity &multiplier) const
 Number of deliverable units per instrument, e.g., peak days in maturity month or number of calendar days in maturity month. More...
 
StringRef unitOfMeasure () const
 Unit of measure for the products' original contract size. More...
 
bool originalContractSize (HugeQuantity &size) const
 Fixed contract value assigned to a product.
 
bool clearedVolume (Volume &volume) const
 Indicates the total cleared volume of instruments traded during the prior trading session. More...
 
bool openInterestQty (Quantity &qty) const
 Indicates the total open interest for the market at the close of the prior trading session. More...
 
LotTypeRules lotTypeRules () const
 Quantity types.
 
void bookDepths (MarketDepth &direct, MarketDepth &implied) const
 Retrieves depth values for direct and implied book. More...
 
const Messagemessage () const
 The source FIX Security Definition (35=d) message.
 
std::string toString () const
 Returns string representation of an object.
 
void toString (std::string &) const
 Appends string representation of an object.
 

Detailed Description

Security Definition.

Member Function Documentation

void bookDepths ( MarketDepth &  direct,
MarketDepth &  implied 
) const

Retrieves depth values for direct and implied book.

Note
Assigns zero in case of book depth value absence.
StringRef cfiCode ( ) const
inline

Indicates the type of security using ISO 10962 standard, Classification of Financial Instruments (CFI code) values.

ISO 10962 is maintained by ANNA (association of National Numbering Agencies) acting as registration Authority.

bool clearedVolume ( Volume &  volume) const
inline

Indicates the total cleared volume of instruments traded during the prior trading session.

bool contractMultiplier ( Quantity &  multiplier) const
inline

Number of deliverable units per instrument, e.g., peak days in maturity month or number of calendar days in maturity month.

Security Definition for the variable quantity spread will be populated with the value '0' for ContractMultiplier. Security Definition is populated with values for the outright legs for ContractMultiplier and customers must extract this value.

ContractMultiplierUnit contractMultiplierUnit ( ) const
inline

Indicates the type of multiplier being applied to the product.

Optionally used in combination with tag 231-ContractMultiplier.

Currency currency ( ) const
inline

Identifies currency used for price.

Absence of this field is interpreted as the default for the security. It is recommended that systems provide the currency value whenever possible.

bool displayFactor ( PriceFactor factor) const
inline

Contains the multiplier to convert the CME Globex display price to the conventional price.

ExpirationCycle expirationCycle ( ) const
inline

Indicates if the instrument expires at the trading session close, or at a specified last eligible trade date.

FlowScheduleType flowScheduleType ( ) const
inline

The schedule according to which the electricity is delivered in a physical contract, or priced in a financial contract.

Specifies whether the contract is defined according to the Easter Peak, Eastern Off-Peak, Western Peak or Western Off-Peak.

bool highLimitPrice ( Price price) const
inline

Upper price threshold for the instrument.

Orders submitted with prices above the upper limit will be rejected.

Returns 'false' if threshold is absent.

ImpliedMarketIndicator impliedMarketIndicator ( ) const
inline

Informs the market that an instrument is eligible for implied trading (Implied In & Out).

If value is undefined, instrument is non-implied and leg messages are not sent.

bool lowLimitPrice ( Price price) const
inline

Lower price threshold for the instrument.

Orders submitted with prices below the lower limit will be rejected.

Returns 'false' if threshold is absent.

bool maturityMonthYear ( YearMonth yearMonth) const
inline

This field provides the actual calendar date for contract maturity - month and year (used for standardized futures and options).

Note
Cuts off day component for for a daily products whose maturity date represents a full date (YYYYMMDD).
bool maturityMonthYear ( Date date) const
inline

This field provides the actual calendar date for contract maturity (overload for a daily products).

Note
For values in YYYYMM format, returned value represents 1st day of the month defined by the value.
bool minPriceIncrement ( Price increment) const
inline

Minimum constant tick for the instrument, sent only if instrument is non-VTT (Variable Tick Table) eligible.

bool openInterestQty ( Quantity &  qty) const
inline

Indicates the total open interest for the market at the close of the prior trading session.

StringRef pricingModel ( ) const
inline

Indicates which options pricing model is used to convert from volatility quote to premium and corresponding delta for vol-quoted options.

bool securityId ( SecurityId &  id) const
inline

Unique instrument id (FIX tag 48) as qualified by the exchange per tag 22-SecurityIDSource.

Returns 'false' if no data (FIX tag) available in underlying security definition message.

bool tradingReferenceDate ( Date date) const
inline

Indicates the date the last update to the settlement price, tag 1150-TradingReferencePrice, was updated in this message in YYYYMMDD format.

Absence of this field indicates current day, expressed in local time at place or trade.

bool tradingReferencePrice ( Price price) const
inline

This value may be the settlement price or closing price of the prior trading day, based on values in tag 5796-TradingReferenceDate and tag 731-SettPriceType.

StringRef unitOfMeasure ( ) const
inline

Unit of measure for the products' original contract size.

This will be populated for all products listed on CME Globex.