Statistics.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/EuroTLX/MarketData/GTP/ABI.h>
#include <OnixS/EuroTLX/MarketData/GTP/Defines.h>
#include <OnixS/EuroTLX/MarketData/GTP/Enumerations.h>
#include <OnixS/EuroTLX/MarketData/GTP/BinaryMessage.h>


namespace OnixS {
namespace EuroTLX {
namespace MarketData {
namespace GTP {

    /// 
    struct StatisticsMsg : public BinaryMessage
    {
        /// Time the message was generated.
        UDT timestamp() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return ordinary<UDT>(3);
        }

        /// GTP Instrument identifier.
        UInt64 instrument() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return ordinary<UInt64>(11);
        }

        /// Venue from which market data is received for the instrument.
        SourceVenue::Enum sourceVenue() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return enumeration<SourceVenue>(19);
        }

        /// Cumulative volume of all trades for the trading day.
        Size4 volume() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Size4(ordinary<UInt64>(21));
        }

        /// Cumulative volume for the trading day excluding off-book trades.
        Size4 volumeOnBookOnly() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Size4(ordinary<UInt64>(29));
        }

        /// Volume weighted average price for the day for all trades.
        Price4 vwap() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Price4(ordinary<UInt64>(37));
        }

        /// Volume weighted average price for the day excluding off-book trades.
        Price4 vwapOnBookOnly() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Price4(ordinary<UInt64>(45));
        }

        /// Count of all trades for the day
        UInt32 numberOfTrades() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return ordinary<UInt32>(53);
        }

        /// Count of trades for the day excluding off-book trades.
        UInt32 numberOfTradesOnBookOnly() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return ordinary<UInt32>(57);
        }

        /// Turnover of all trades for the day.
        Price4 turnover() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Price4(ordinary<UInt64>(61));
        }

        /// Turnover for the day excluding off-book trades.
        Price4 turnoverOnBookOnly() const
        ONIXS_EUROTLX_GTP_NOTHROW
        {
            return Price4(ordinary<UInt64>(69));
        }

        /// Total message size.
        static ONIXS_EUROTLX_GTP_CONST_OR_CONSTEXPR MessageSize messageSize_ = 77;

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

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

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

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

}
}
}
}