QuoteUpdateOptionUSFutures.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/Trading/BOE/ABI.h>
#include <OnixS/CboeCFE/Trading/BOE/Defines.h>
#include <OnixS/CboeCFE/Trading/BOE/Enumerations.h>
#include <OnixS/CboeCFE/Trading/BOE/OutgoingMessage.h>
#include <OnixS/CboeCFE/Trading/BOE/Messages/Out/QuoteUpdate.Quote.h>


namespace OnixS {
namespace CboeCFE {
namespace Trading {
namespace BOE {

    /// Quote Update
    struct ONIXS_CBOE_CFE_BOE_API QuoteUpdateOptionUSFutures : public OutgoingMessage
    {
        /// Id chosen by the client.
        StrRef quoteUpdateId() const
        {
            return quoteUpdateId_;
        }

        /// Id chosen by the client.
        void quoteUpdateId(StrRef value)
        {
            quoteUpdateId_ = value;
        }

        /// EFID that will clear the trade.
        StrRef clearingFirm() const
        {
            return clearingFirm_;
        }

        /// EFID that will clear the trade.
        void clearingFirm(StrRef value)
        {
            clearingFirm_ = value;
        }

        /// Supplemental identifier.
        StrRef clearingAccount() const
        {
            return clearingAccount_;
        }

        /// Supplemental identifier.
        void clearingAccount(StrRef value)
        {
            clearingAccount_ = value;
        }

        /// CMTA Number of the firm that will clear the trade.
        Binary4 cMTANumber() const
        {
            return cMTANumber_;
        }

        /// CMTA Number of the firm that will clear the trade.
        void cMTANumber(Binary4 value)
        {
            cMTANumber_ = value;
        }

        /// Unique account identifier associated with an order.
        StrRef account() const
        {
            return account_;
        }

        /// Unique account identifier associated with an order.
        void account(StrRef value)
        {
            account_ = value;
        }

        /// Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a list of CustomGroupIds.
        Binary2 customGroupId() const
        {
            return customGroupId_;
        }

        /// Used to group orders for use in mass cancels where multiple orders can be cancelled by specifying a list of CustomGroupIds.
        void customGroupId(Binary2 value)
        {
            customGroupId_ = value;
        }

        /// Capacity.
        Capacity::Enum capacity() const
        {
            return capacity_;
        }

        /// Capacity.
        void capacity(Capacity::Enum value)
        {
            capacity_ = value;
        }

        /// Cti code.
        CtiCode::Enum ctiCode() const
        {
            return ctiCode_;
        }

        /// Cti code.
        void ctiCode(CtiCode::Enum value)
        {
            ctiCode_ = value;
        }

        /// Manual order indicator.
        ManualOrderIndicator::Enum manualOrderIndicator() const
        {
            return manualOrderIndicator_;
        }

        /// Manual order indicator.
        void manualOrderIndicator(ManualOrderIndicator::Enum value)
        {
            manualOrderIndicator_ = value;
        }

        /// Identifies the Order Entry Operator responsible for this message.
        StrRef oEOID() const
        {
            return oEOID_;
        }

        /// Identifies the Order Entry Operator responsible for this message.
        void oEOID(StrRef value)
        {
            oEOID_ = value;
        }

        /// Controls the behavior of the quote OrderQty field.
        SizeModifier::Enum sizeModifier() const
        {
            return sizeModifier_;
        }

        /// Controls the behavior of the quote OrderQty field.
        void sizeModifier(SizeModifier::Enum value)
        {
            sizeModifier_ = value;
        }

        ///Quotes.
        const std::vector<Quote>& quotes() const
        {
            return quotes_;
        }

        ///Quotes.
        std::vector<Quote>& quotes()
        {
            return quotes_;
        }

        /// Returns message type
        MessageType::Enum type() const ONIXS_BATS_BOE_NOEXCEPT ONIXS_BATS_BOE_OVERRIDE { return MessageType::QuoteUpdateOptionUSFutures; };

        /// Validates message data
        /// Throws std::invalid_argument exception if message content is invalid.
        void validate() const ONIXS_BATS_BOE_OVERRIDE;

        /// Returns the text representation
        std::string toString() const ONIXS_BATS_BOE_OVERRIDE;

        /// The text representation
        void toString(std::string& str) const ONIXS_BATS_BOE_OVERRIDE;

    private:
        size_t serializeTo(unsigned char*) const ONIXS_BATS_BOE_NOEXCEPT ONIXS_BATS_BOE_OVERRIDE;

        Text<16> quoteUpdateId_;
        Alpha<4> clearingFirm_;
        Alpha<4> clearingAccount_;
        Binary4 cMTANumber_;
        Text<16> account_;
        Binary2 customGroupId_;
        Capacity::Enum capacity_;
        CtiCode::Enum ctiCode_;
        ManualOrderIndicator::Enum manualOrderIndicator_;
        Text<18> oEOID_;
        SizeModifier::Enum sizeModifier_;
        std::vector<Quote> quotes_;
    };

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

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

}
}
}
}