OrderBookDirectoryMsg.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] 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 <OnixS/eSpeed/MarketData/Itch/BinaryMessage.h>
#include <OnixS/eSpeed/MarketData/Itch/IncomingMessage.h>

ONIXS_ESPEED_ITCH_NAMESPACE_BEGIN

    /// At the start of each trading day, order book
    /// directory messages are sent for all active US
    /// Treasury securities in the ATS.
    struct ONIXS_ESPEED_ITCH_API OrderBookDirectoryMsg : public IncomingMessage
    {
        /// Timestamp
        UInt64 timestamp() const
        {
            return ordinary<UInt64>(1);
        }

        /// Unique identifier of an Order book. This
        /// identifier will stay constant until this
        OrderBookId orderBookId() const
        {
            return ordinary<UInt32>(9);
        }

        /// UST security symbol in the NFI ATS (e.g. 10Y_UST)
        StrRef symbol() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return fixedStr<20>(13);
        }

        /// Instrument Description
        StrRef securityDescription() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return fixedStr<16>(33);
        }

        /// CUSIP code identifying security
        StrRef cusip() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return fixedStr<9>(49);
        }

        /// Reserved
        UInt8 reserved1() const
        {
            return ordinaryRef<UInt8>(58);
        }

        /// Product type
        ProductType::Enum productType() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<ProductType>(59);
        }

        /// Product Subtype
        ProductSubType::Enum productSubType() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<ProductSubType>(60);
        }

        /// Price type
        PriceType::Enum priceType() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<PriceType>(61);
        }

        /// The number of decimals used in price or yield for
        /// this order book in NFI ATS.
        UInt16 priceDecimals() const
        {
            return ordinary<UInt16>(62);
        }

        /// For securities that do not trade in Yield but will
        /// have yield published, this field describes number
        /// of decimals for yield field.
        UInt16 yieldDecimals() const
        {
            return ordinary<UInt16>(64);
        }

        /// The number of decimals used in the Coupon field.
        /// If Coupon is not used, this field will be set to
        /// -1.
        UInt16 couponDecimals() const
        {
            return ordinary<UInt16>(66);
        }

        /// 1000000 million is the value published for US
        /// Treasury Notes.
        UInt32 quantityMultiplier() const
        {
            return ordinary<UInt32>(68);
        }

        /// 
        UInt16 reserved2() const
        {
            return ordinary<UInt16>(72);
        }

        /// Maturity date
        UInt32 maturity() const
        {
            return ordinary<UInt32>(74);
        }

        /// Coupon Rate
        UInt32 coupon() const
        {
            return ordinary<UInt32>(78);
        }

        /// Dated Date
        UInt32 datedDate() const
        {
            return ordinary<UInt32>(82);
        }

        /// Issue Date
        UInt32 issueDate() const
        {
            return ordinary<UInt32>(86);
        }

        /// Auction Date
        UInt32 auctionDate() const
        {
            return ordinary<UInt32>(90);
        }

        /// Announcement Date
        UInt32 announcementDate() const
        {
            return ordinary<UInt32>(94);
        }

        /// First Coupon Date
        UInt32 firstCouponDate() const
        {
            return ordinary<UInt32>(98);
        }

        /// Settlement Date
        UInt32 settlementDate() const
        {
            return ordinary<UInt32>(102);
        }

        /// Index Reference Rate
        UInt32 index() const
        {
            return ordinary<UInt32>(106);
        }

        /// Spread Rate
        UInt32 spreadRate() const
        {
            return ordinary<UInt32>(110);
        }

        /// Trading Features
        TradingFeatures::Enum tradingFeatures() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return static_cast<TradingFeatures::Enum>(ordinary<TradingFeatures::Base>(114));
        }

        /// The minimum visible quantity of the order allowed
        /// to be added to the book.
        Quantity minimumEntryQuantity() const
        {
            return ordinary<UInt32>(116);
        }

        /// The minimum increment for visible quantity of the
        /// order.
        UInt32 minimumQuantityIncrement() const
        {
            return ordinary<UInt32>(120);
        }

        /// Issued as Benchmark
        IssuedAsBenchmark::Enum issuedAsBenchmark() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return static_cast<IssuedAsBenchmark::Enum>(ordinary<IssuedAsBenchmark::Base>(124));
        }

        /// The price tick for the instrument
        UInt64 priceTickSize() const
        {
            return ordinary<UInt64>(126);
        }

        /// Reserved
        StrRef reserved3() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return fixedStr<12>(134);
        }

        /// Total message size.
        static ONIXS_ESPEED_ITCH_CONST_OR_CONSTEXPR MessageSize messageSize_ = 146;

        /// Check the given size.
        static void validateSize(MessageSize size)
        {
            if (ONIXS_ESPEED_ITCH_CHECK_EXPECT((size < messageSize_), false))
                throwIncorrectSize("OrderBookDirectoryMsg", size, messageSize_);
        }

        /// Initializes instance over given memory block.
        OrderBookDirectoryMsg(const void* data, MessageSize size)
        ONIXS_ESPEED_ITCH_NOTHROW
            : IncomingMessage(data, size)
        {
        }
    };

    /// Serializes object into string.
    ONIXS_ESPEED_ITCH_API void toStr(std::string&, const OrderBookDirectoryMsg&);

    /// Serializes object into string.
    inline std::string toStr(const OrderBookDirectoryMsg& msg)
    {
        std::string str;
        toStr(str, msg);
        return str;
    }

    ///
    inline std::ostream& operator<<(std::ostream& stream, const OrderBookDirectoryMsg& msg)
    {
        stream << toStr(msg);
        return stream;
    }

ONIXS_ESPEED_ITCH_NAMESPACE_END