ModifyOrder.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>


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

    /// Modify Order
    struct ONIXS_CBOE_CFE_BOE_API ModifyOrder : public OutgoingMessage
    {
        /// Unique Id chosen by the client.
        StrRef clOrdId() const
        {
            return clOrdId_;
        }

        /// Unique Id chosen by the client.
        void clOrdId(StrRef value)
        {
            clOrdId_ = value;
        }

        /// The ClOrdId of the original order.
        StrRef origClOrdId() const
        {
            return origClOrdId_;
        }

        /// The ClOrdId of the original order.
        void origClOrdId(StrRef value)
        {
            origClOrdId_ = value;
        }

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

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

        /// Order quantity.
        Binary4 orderQty() const
        {
            return orderQty_;
        }

        /// Order quantity.
        void orderQty(Binary4 value)
        {
            orderQty_ = value;
        }

        /// Limit price.
        BinaryPrice price() const
        {
            return price_;
        }

        /// Limit price.
        void price(BinaryPrice value)
        {
            price_ = value;
        }

        /// Order type.
        OrdType::Enum ordType() const
        {
            return ordType_;
        }

        /// Order type.
        void ordType(OrdType::Enum value)
        {
            ordType_ = value;
        }

        /// CancelOrigOnReject.
        CancelOrigOnReject::Enum cancelOrigOnReject() const
        {
            return cancelOrigOnReject_;
        }

        /// CancelOrigOnReject.
        void cancelOrigOnReject(CancelOrigOnReject::Enum value)
        {
            cancelOrigOnReject_ = value;
        }

        /// Stop price.
        BinaryPrice stopPx() const
        {
            return stopPx_;
        }

        /// Stop price.
        void stopPx(BinaryPrice value)
        {
            stopPx_ = 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;
        }

        /// Supplemental customer identifier used for billing related programs.
        StrRef frequentTraderId() const
        {
            return frequentTraderId_;
        }

        /// Supplemental customer identifier used for billing related programs.
        void frequentTraderId(StrRef value)
        {
            frequentTraderId_ = value;
        }

        /// Execution source code provided during order entry to describe broker service.
        CustOrderHandlingInst::Enum custOrderHandlingInst() const
        {
            return custOrderHandlingInst_;
        }

        /// Execution source code provided during order entry to describe broker service.
        void custOrderHandlingInst(CustOrderHandlingInst::Enum value)
        {
            custOrderHandlingInst_ = value;
        }

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

        /// 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<20> clOrdId_;
        Text<20> origClOrdId_;
        Alpha<4> clearingFirm_;
        Binary4 orderQty_;
        BinaryPrice price_;
        OrdType::Enum ordType_;
        CancelOrigOnReject::Enum cancelOrigOnReject_;
        BinaryPrice stopPx_;
        ManualOrderIndicator::Enum manualOrderIndicator_;
        Text<18> oEOID_;
        Alphanumeric<6> frequentTraderId_;
        CustOrderHandlingInst::Enum custOrderHandlingInst_;
    };

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

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

}
}
}
}