FuturesStrategyDefinition.h

Go to the documentation of this file.

/**
 * \file
 * \brief Declare `OnixS::ICE::iMpact::MarketData::FuturesStrategyDefinition` message structure
 */
/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
 * of this source code or associated reference material to any other location for further reproduction
 * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include "../Enumerations.h"
#include "../Export.h"
#include "../Optional.h"
#include "../Time.h"
#include "../Types.h"

#include <iosfwd>
#include <string>
#include <vector>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// This class represents the Futures Strategy Definition Response Message.
struct ONIXS_ICEMDH_EXPORT FuturesStrategyDefinition
{
    /// Message type constant
    enum
    {
        messageType = 'd'
    };

    /// The original request sequence ID assigned by client, unique per
    /// session.
    int requestSeqId;

    /// See Appendix C for the list of market types and IDs.
    MarketType requestMarketType;

    /// Unique identifier of the market.
    MarketId marketId;

    /// See Naming Convention on Appendix D.
    std::string contractSymbol;

    /// See Appendix A on trading status codes.
    TradingStatus::Enum tradingStatus;

    /// Denominator for the order price fields in this market.
    char orderPriceDenominator;

    /// Minimum increment premium price for this market.
    int incrementPrice;

    /// Minimum increment quantity for this market.
    int incrementQty;

    /// Minimum quantity for this market.
    int minQty;

    /// Contains the Strategy Code for defined market where applicable. See
    /// Appendix E for list of codes.
    SecuritySubType::Enum securitySubType;

    /// Indicates if Market is only tradable via ICE Block Trade. This also
    /// means the screen trading is not allowed for the market.
    bool isBlockOnly;

    /// The number of markets for the given market type.
    int numOfMarkets;

    /// Strategy Symbol.
    std::string strategySymbol;

    /// Indicates if GTC is allowed in the market.
    bool gtAllowed;

    /// Indicates MIFID-II market.
    bool miFIDRegulatedMarket;

    /// Description of the market.
    std::string marketDesc;

    /// 4 digit year.
    short maturityYear;

    /// Month range 1-12.
    short maturityMonth;

    /// Day of the month.
    short maturityDay;

    /// Denominator for the deal price fields in the market. For most markets,
    /// this is the same as `OrderPriceDenominator`.
    char dealPriceDenominator;

    /// The quantity in unit of measurement per lot. For example, it is 1000
    /// barrels per lot for Brent. `UnitQtyDenominator` should be applied to
    /// get correct `UnitQuantity`.
    int unitQuantity;

    /// Only used for `OffExchangeIncrementOptionPrice`.
    char numDecimalsOptionsPrice;

    /// Indicate if the market supports option markets.
    bool allowOptions;

    /// Clearing limit admin related.
    std::string clearedAlias;

    /// Indicate if implication is done for a given spread market and its
    /// given outright leg markets.
    bool allowsImplied;

    /// Minimum Price. `OrderPriceDenominator` should be applied to this
    /// field.
    Price minPrice;

    /// Maximum Price. `OrderPriceDenominator` should be applied to this
    /// field.
    Price maxPrice;

    /// Name of the product that the contract/market is under.
    std::string productName;

    /// Alias of the hub for the contract/market.
    std::string hubAlias;

    /// Name of the strip for the contract/market.
    std::string stripName;

    /// Indicate if the contract is tradable.
    bool isTradable;

    /// Denominator for the settlement price fields in the market. For most
    /// markets, this is the same as `DealPriceDenominator`.
    char settlePriceDenominator;

    /// Market Identifier Code for the market.
    std::string micCode;

    /// Denominator for `UnitQuantity`. This field will be `0` for most of the
    /// markets.
    char unitQtyDenominator;

    /// Indicate if the contract is for hedge only.
    bool hedgeOnly;

    /// Exchange silo code for the market.
    ExchangeSilo::Enum exchangeSilo;

    /// Denominator for `OffExchangeIncrementQty`.
    char offExchangeIncrementQtyDenominator;

    /// Off exchange increment qty. `OffExchangeIncrementQtyDenominator`
    /// should be applied to this field.
    int offExchangeIncrementQty;

    /// Off exchange increment price. `OrderPriceDenominator` should be
    /// applied to this field.
    int offExchangeIncrementPrice;

    /// Off exchange options increment price. `NumDecimalsOptionsPrice` should
    /// be applied to this field.
    int offExchangeIncrementOptionPrice;

    /// ID of the product that the contract/market is under.
    int productId;

    /// ID of the hub for the contract/market.
    int hubId;

    /// ID of the strip for the contract/market.
    int stripId;

    /// The ISIN of the security this market is associated with. This is
    /// currently only populated for Liffe Equity markets.
    std::string underlyingISIN;

    /// Indicates Test Market.
    bool testMarketIndicator;

    /// Indicates whether leg deals are suppressed.
    bool legDealSuppressed;

    /// This nested class represents leg definition.
    struct ONIXS_ICEMDH_EXPORT Leg
    {
        /// Market Id of the futures leg market.
        MarketId marketId;

        /// Number of futures contracts per increment quantity.
        short ratio;

        /// Leg side.
        Side::Enum side;

        /// The strategy code for the leg. If set, this field can be used to
        /// obtain the next level of granularity of the strategy. If it is not
        /// set, the /c LegMarketID is the most granular level for the market. See
        /// Appendix E for list of codes.
        Optional<short> strategyCode;

        /// The quantity ratio represents the proportion of each of the leg of
        /// interproduct spreads. Using Gas Oil crack as an example. This will be
        /// set to 4 for the Gas oil leg and 3 for the Brent leg.
        Optional<int> ratioQtyNumerator;

        /// The quantity ratio represents the proportion of each of the leg of
        /// interproduct spreads. The Leg ratio denominator will be set to `1` for
        /// most products not but will be used in future product launches.
        Optional<int> ratioQtyDenominator;

        /// The price ratio is the fractional weighted price component per leg in
        /// the strategy. Using a Q4 2017 set as composite strategy as an example,
        /// each leg Oct 2017, Nov 2017 and Dec 2017 will have 1 as the
        /// `LegRatioPriceNumerator`.
        Optional<int> ratioPriceNumerator;

        /// The price ratio is the fractional weighted price component per leg in
        /// the strategy. Using a Q4 2017 set as composite strategy as an example,
        /// each leg Oct 2017, Nov 2017 and Dec 2017 will have 3 as the
        /// `LegRatioPriceDenominator`.
        Optional<int> ratioPriceDenominator;

        /// Default constructor.
        Leg();

        /// Returns string representation.
        std::string toString() const;
    };

    /// Alias for collection of Legs.
    typedef std::vector<Leg> Legs;

    /// Collection of Legs.
    Legs legs;

    /// This nested class represents block details definition.
    struct ONIXS_ICEMDH_EXPORT BlockDetail
    {
        /// Block Type.
        BlockType::Enum blockType;

        /// Trade Type.
        OffMarketTradeType::Enum tradeType;

        /// Minimum Quantity. `OffExchangeIncrementQtyDenominator` should be
        /// applied to this field.
        long long minQty;

        /// Default constructor.
        BlockDetail();

        /// Returns string representation.
        std::string toString() const;
    };

    /// Alias for collection of BlockDetails.
    typedef std::vector<BlockDetail> BlockDetails;

    /// Collection of BlockDetails.
    BlockDetails blockDetails;

    /// Unit Of Measure.
    Optional<std::string> unitOfMeasure;

    /// Hub Name.
    Optional<std::string> hubName;

    /// Sent for customs with StrategyCodes 414, 550, 711, 713, 714, 715, and
    /// 716 and for future use when combos with.
    Optional<std::string> stripType;

    /// Sent for customs with StrategyCodes 414, 550, 711, 713, 714, 715, and
    /// 716.
    Optional<Date> stripBeginDate;

    /// Sent for customs with StrategyCodes 414, 550, 711, 713, 714, 715, and
    /// 716.
    Optional<Date> stripEndDate;

    /// Indicates whether the Block Minimum can be overridden for the market.
    Optional<bool> overrideBlockMin;

    /// Identifies the monetary amount per tick move when calculated from the
    /// Central Limit Order Book.
    Optional<long long> screenTickValue;

    /// Identifies the monetary amount per tick move when calculated for Off-
    /// Exchange trades.
    Optional<long long> blockTickValue;

    /// Denominator for ScreenTickValue and BlockTickValue.
    Optional<char> tickValueDenominator;

    /// Number of cycles (days, hours, MWh, etc) for a contract.
    Optional<int> numOfCycles;

    /// Currency.
    Optional<std::string> currency;

    /// Default constructor.
    FuturesStrategyDefinition();

    /// Initialize from raw message data.
    FuturesStrategyDefinition(const char* data, std::size_t dataSize);

    /// Deserialize from raw data.
    void deserialize(const char* data, std::size_t dataSize);

    /// Reset all fields to default values.
    void reset();

    /// Returns string representation.
    std::string toString() const;
};

/// Make it printable using C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const FuturesStrategyDefinition&);

}}}} // namespace OnixS::ICE::iMpact::MarketData