OrderExecReportBroadcast.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 "OnixS/Eurex/Trading/Defines.h"
#include "OnixS/Eurex/Trading/Enumerations.h"
#include "OnixS/Eurex/Trading/Export.h"
#include "OnixS/Eurex/Trading/Message.h"
#include "OnixS/Eurex/Trading/MessageInfo.h"
#include "OnixS/Eurex/Trading/Messages/CLIPExecutionNotification.h"
#include "OnixS/Eurex/Trading/Messages/ModifyOrderComplexRequest.h"
#include "OnixS/Eurex/Trading/Messages/ModifyOrderNRResponse.h"

#include <iosfwd>
#include <string>
#include <vector>

namespace OnixS { namespace Eurex { namespace Trading {

/// Order Exec Report Broadcast Message.
class ONIXS_EUREX_ETI_EXPORT OrderExecReportBroadcast : public Message
{
public:
    /// Initialize default instance.
    OrderExecReportBroadcast();

    /// Matching engine out timestamp.
    UInt64 trdRegTSTimeOut;

    /// Unique ID assigned by the Eurex system during broadcast subscription in order to link broadcasts to the related
    /// subscription.
    UInt32 applSubId;

    /// Is required to define the scope of a Retransmission Request.
    UInt16 partitionId;

    /// Message key assigned to a order/quote event related Eurex ETI data stream.
    Data applMsgId;

    /// Identifier for subscription and retransmission of an ETI data stream.
    ApplId::Enum applId;

    /// Indicates a retransmission message.
    ApplResendFlag::Enum applResendFlag;

    /// Indicates whether this message is the last fragment (part) of a sequence of messages belonging to one dedicated
    /// transaction.
    LastFragment::Enum lastFragment;

    /// Exchange Order ID generated by Eurex System; it remains constant over the lifetime of an order.
    UInt64 orderId;

    /// Unique participant defined order request identifier.
    UInt64 clOrdId;

    /// ClOrdID (11) of the last successfully processed task (request) referring to the specific order; used for client
    /// order ID chaining.
    UInt64 origClOrdId;

    /// The instrument identifier uniquely identifies an instrument in the core system.
    SInt64 securityId;

    /// Transaction timestamp.
    UInt64 execId;

    /// The entry timestamp is the time of the creation of the order.
    UInt64 trdRegTSEntryTime;

    /// Priority timestamp.
    UInt64 trdRegTSTimePriority;

    /// Price.
    SInt64 price;

    /// Remaining quantity of an order.
    SInt64 leavesQty;

    /// Cumulated executed quantity of an order.
    SInt64 cumQty;

    /// Total quantity cancelled for this order.
    SInt64 cxlQty;

    /// Total Order Quantity.
    SInt64 orderQty;

    /// Stop price.
    SInt64 stopPx;

    /// The product identifier uniquely identifies a Eurex product.
    SInt32 marketSegmentId;

    /// Mass order response identifier generated by the exchange.
    UInt32 massOrderReportId;

    /// Date of order expiry.
    UInt32 expireDate;

    /// Self Match Prevention ID.
    UInt32 matchInstCrossId;

    /// Owning Business Unit.
    UInt32 partyIdExecutingUnit;

    /// Identification of a Trading Session provided by Eurex to a certain business unit.
    UInt32 partyIdSessionId;

    /// Owning User ID.
    UInt32 partyIdExecutingTrader;

    /// Entering User ID.
    UInt32 partyIdEnteringTrader;

    /// Code to further qualify the field ExecType (150) of the Execution Report (8) message.
    ExecRestatementReason::Enum execRestatementReason;

    /// Entering Business Unit.
    PartyIdEnteringFirm::Enum partyIdEnteringFirm;

    /// Indicate the instruction for SMP. If MatchInstCrossID (28744) is set then the default value for
    /// SelfMatchPreventionInstruction is 100 (Reject cross on business unit level).
    SelfMatchPreventionInstruction::Enum selfMatchPreventionInstruction;

    /// This field qualifies an instrument type on Eurex.
    ProductComplex::Enum productComplex;

    /// Conveys the current status of an order.
    OrdStatus::Enum ordStatus;

    /// The reason why this message was generated.
    ExecType::Enum execType;

    /// Side of the order.
    Side::Enum side;

    /// Order type.
    OrdType::Enum ordType;

    /// This field designates if the trader is acting in the capacity of agent, trading for its own account or acting as
    /// a market maker.
    TradingCapacity::Enum tradingCapacity;

    /// Execution and trading restriction parameters supported by Eurex.
    TimeInForce::Enum timeInForce;

    /// Instructions for order handling, represented as a bit map.
    ExecInst::Enum execInst;

    /// Marks a a certain order as a closing auction one.
    TradingSessionSubId::Enum tradingSessionSubId;

    /// Indicates if the order is a Lean Order or a Standard (non lean) Order.
    ApplSeqIndicator::Enum applSeqIndicator;

    /// Account to book trades and keep positions on.
    std::string account;

    /// Flex Account information.
    std::string partyIdPositionAccount;

    /// Field is used for Eurex position management purposes and indicates whether the order is submitted to open or
    /// close a position.
    PositionEffect::Enum positionEffect;

    /// Indicates the name of a member institution to which a give-up is designated.
    std::string partyIdTakeUpTradingFirm;

    /// Partner identification at the Korea Exchange is required for orders in KRX products.
    std::string partyIdOrderOriginationFirm;

    /// Mandatory final KRX beneficiary account required for orders in KRX products.
    std::string partyIdBeneficiary;

    /// Country code. Valid characters: 0x01-0x7E.
    std::string partyIdLocationId;

    /// Identifies the source of an order, in accordance with the FIA guidelines for a rate Identifier. The field is for
    /// participant use only. Valid characters: 0x20, 0x22-0x7B, 0x7D, 0x7E.
    CustOrderHandlingInst::Enum custOrderHandlingInst;

    /// This field is used to provide additional regulatory information (according to respective rules and regs,
    /// circulars and bilateral coordination between participant and Trading Surveillance Office).
    std::string complianceText;

    /// First free-format text field for trader-specific or customer-related comments.
    std::string freeText1;

    /// Second free-format text field for trader-specific or customer-related comments.
    std::string freeText2;

    /// Third free-format text field for trader-specific or customer-related comments.
    std::string freeText3;

    /// User defined client order ID.
    std::string fixClOrdId;

    /// Indicates if an order has been previously triggered.
    Triggered::Enum triggered;

    /// Indicates SMP involvement.
    CrossedIndicator::Enum crossedIndicator;

    /// Leg Ord Group.
    std::vector<LegOrdGrpElem> legOrdGrp;

    /// Fills Group.
    std::vector<FillsGrpElem> fillsGrp;

    /// Instrmnt Leg Exec Group.
    std::vector<InstrmntLegExecGrpElem> instrmntLegExecGrp;

    /// Order Event Group.
    std::vector<OrderEventGrpElem> orderEventGrp;

    /// Returns template ID.
    TemplateId::Enum templateId() const;

    /// Returns string representation.
    std::string toString() const;

private:
    friend class Serializer;
    OrderExecReportBroadcast(const void* data, size_t dataSize, MessageInfo& msgInfo);
    void nativeSerializeTo(void* nativeMessage);
};

ONIXS_EUREX_ETI_EXPORT std::ostream& operator<<(std::ostream&, const OrderExecReportBroadcast&);

}}}