PrivilegeNotification.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/FmxUST/MarketData/Bimp/ABI.h>
#include <OnixS/FmxUST/MarketData/Bimp/Defines.h>
#include <OnixS/FmxUST/MarketData/Bimp/Enumerations.h>
#include <OnixS/FmxUST/MarketData/Bimp/BinaryMessage.h>


namespace OnixS {
namespace FmxUST {
namespace MarketData {
namespace Bimp {

    /// Privilege Notification
    struct PrivilegeNotificationMsg : public BinaryMessage
    {
        /// Instrument locate code identifying the instrument.
        Integer4 instrumentLocate() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer4>(1);
        }

        /// Timestamp for this message. Expressed as the number of nanoseconds since Unix Epoch (00:00:00 UTC on
        /// 1 January 1970).
        Integer8 timestamp() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer8>(5);
        }

        /// The unique numeric instrument identification number
        Integer8 instrumentId() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer8>(13);
        }

        /// A number uniquely identifying a privilege
        Integer8 privilegeId() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer8>(21);
        }

        /// Trade Date (YYYYMMDD)
        Integer8 tradeDate() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer8>(29);
        }

        /// Time when privilege ends. Expressed as the number of nanoseconds since Unix Epoch (00:00:00 UTC on 1
        /// January 1970)
        Integer8 expiryTime() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer8>(37);
        }

        /// Privilege State
        PrivilegeState::Enum privilegeState() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return enumeration<PrivilegeState>(45);
        }

        /// For future use
        Integer1 privilegeFlags() const
        ONIXS_FMXUST_BIMP_NOTHROW
        {
            return ordinary<Integer1>(46);
        }

        /// Total message size.
        static ONIXS_FMXUST_BIMP_CONST_OR_CONSTEXPR MessageSize messageSize_ = 47;

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

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

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

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

}
}
}
}