PurgeOrders.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 {

    typedef Binary2 CustomGroupId;

    /// Purge Orders
    struct ONIXS_CBOE_CFE_BOE_API PurgeOrders : public OutgoingMessage
    {
        /// User-defined identifier of the mass cancel or purge request.
        StrRef massCancelId() const
        {
            return massCancelId_;
        }

        /// User-defined identifier of the mass cancel or purge request.
        void massCancelId(StrRef value)
        {
            massCancelId_ = value;
        }

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

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

        /// Product name.
        StrRef productName() const
        {
            return productName_;
        }

        /// Product name.
        void productName(StrRef value)
        {
            productName_ = value;
        }

        /// Corresponds to MassCancelInst (7700) in CFE FIX.
        StrRef massCancelInst() const
        {
            return massCancelInst_;
        }

        /// Corresponds to MassCancelInst (7700) in CFE FIX.
        void massCancelInst(StrRef value)
        {
            massCancelInst_ = 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;
        }

        ///CustomGroupIds.
        const std::vector<CustomGroupId>& customGroupIds() const
        {
            return customGroupIds_;
        }

        ///CustomGroupIds.
        std::vector<CustomGroupId>& customGroupIds()
        {
            return customGroupIds_;
        }

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

        /// 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> massCancelId_;
        Alpha<4> clearingFirm_;
        Text<6> productName_;
        Text<16> massCancelInst_;
        ManualOrderIndicator::Enum manualOrderIndicator_;
        Text<18> oEOID_;
        std::vector<CustomGroupId> customGroupIds_;
    };

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

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

}
}
}
}