OpenInterest.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 Open Interest message is sent to communicate a symbol's open interest, usually for the prior trading date.
    struct OpenInterestMsg : public BinaryMessage
    {
        /// Nanosecond offset from last unit timestamp.
        Binary4 timeOffset() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary4>(2);
        }

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

        /// Trade Date for the Open Interest data.
        BinaryDate tradeDate() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<BinaryDate>(12);
        }

        /// Open Interest for this symbol.
        Binary4 openInterest() const
        ONIXS_BATS_PITCH_NOTHROW
        {
            return ordinary<Binary4>(16);
        }

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

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

        /// Initializes instance over given memory block.
        OpenInterestMsg(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 OpenInterestMsg&);

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

}
}
}
}