TradeShort.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 <vector>

#include <OnixS/CboeCFE/MarketData/Pitch/ABI.h>
#include <OnixS/CboeCFE/MarketData/Pitch/Defines.h>
#include <OnixS/CboeCFE/MarketData/Pitch/Enumerations.h>
#include <OnixS/CboeCFE/MarketData/Pitch/BinaryMessage.h>


namespace OnixS {
namespace CboeCFE {
namespace MarketData {
namespace Pitch {

    /// The Trade message provides information about executions that occur off of the CFE book (such as ECRP / Block trades).
    struct TradeShortMsg : public BinaryMessage
    {
        /// Nanosecond offset from last unit timestamp.
        Binary4 timeOffset() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary4>(2);
        }

        /// Obfuscated Order ID or Order Id of the executed order.
        Binary8 orderId() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary8>(6);
        }

        /// Always Buy Order regardless of resting side.
        SideIndicator::Enum sideIndicator() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return enumeration<SideIndicator>(14);
        }

        /// Incremental number of contracts executed.
        Binary2 quantity() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary2>(15);
        }

        /// Symbol right padded with spaces.
        StrRef symbol() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return fixedStr<6>(17);
        }

        /// The execution price of the order.
        BinaryShortPrice price() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<BinaryShortPrice>(23);
        }

        /// CFE generated day-unique execution identifier of  this trade. Execution Id is also referenced in the
        /// Trade Break message.
        Binary8 executionId() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary8>(25);
        }

        /// Trade Condition
        TradeCondition::Enum tradeCondition() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return enumeration<TradeCondition>(33);
        }

        /// Total message size.
        static ONIXS_BATS_PITCH_CONST_OR_CONSTEXPR MessageSize messageSize_ = 34;

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

        /// Initializes instance over given memory block.
        TradeShortMsg(const void* data, MessageSize size)
        ONIXS_BATS_PITCH_NOTHROW
            : BinaryMessage(data, size)
        {
        }
    };

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

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

}
}
}
}