OrderExecutedWithPriceMsg.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/SgxTitan/MarketData/Itch/BinaryMessage.h>
#include <OnixS/SgxTitan/MarketData/Itch/IncomingMessage.h>
#include <OnixS/SgxTitan/MarketData/Itch/Price.h>

ONIXS_SGXTITAN_ITCH_NAMESPACE_BEGIN

    /// This message is sent in the relatively rare event
    /// when an order on the book is executed in whole or
    /// in part with a price different than the initial
    /// display price.
    struct ONIXS_SGXTITAN_ITCH_API OrderExecutedWithPriceMsg : public IncomingMessage
    {
        /// Nanoseconds portion of the timestamp
        UInt32 nanoseconds() const
        {
            return ordinary<UInt32>(1);
        }

        /// The order ID is associated with the executed order
        OrderId orderId() const
        {
            return ordinary<UInt64>(5);
        }

        /// The Order Book ID
        OrderBookId orderBookId() const
        {
            return ordinary<UInt32>(13);
        }

        /// The type of order being added
        Side::Enum side() const
        ONIXS_SGXTITAN_ITCH_NOTHROW
        {
            return enumeration<Side>(17);
        }

        /// The quantity being executed
        Quantity executedQuantity() const
        {
            return ordinary<UInt64>(18);
        }

        /// Assigned by the system to each match executed
        UInt64 matchId() const
        {
            return ordinary<UInt64>(26);
        }

        /// Used to group Combination Order Book executions
        /// and the trades in the constituent Order Books
        /// together
        UInt32 comboGroupId() const
        {
            return ordinary<UInt32>(34);
        }

        /// 
        StrRef reserved1() const
        ONIXS_SGXTITAN_ITCH_NOTHROW
        {
            return fixedStr<7>(38);
        }

        /// 
        StrRef reserved2() const
        ONIXS_SGXTITAN_ITCH_NOTHROW
        {
            return fixedStr<7>(45);
        }

        /// Trade Price
        Price tradePrice() const
        {
            return Price(ordinary<Int32>(52));
        }

        /// Occurred at Cross
        OccurredAtCross::Enum occurredAtCross() const
        ONIXS_SGXTITAN_ITCH_NOTHROW
        {
            return enumeration<OccurredAtCross>(56);
        }

        /// Indicates if the trade should be included in trade
        /// tickers and volume calculations
        Printable::Enum printable() const
        ONIXS_SGXTITAN_ITCH_NOTHROW
        {
            return enumeration<Printable>(57);
        }

        /// Total message size.
        static ONIXS_SGXTITAN_ITCH_CONST_OR_CONSTEXPR MessageSize messageSize_ = 58;

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

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

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

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

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

ONIXS_SGXTITAN_ITCH_NAMESPACE_END