BasketRollBroadcast.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/AmendBasketTradeRequest.h"

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

namespace OnixS { namespace Eurex { namespace Trading {

/// Old Basket Data BC Group.
class ONIXS_EUREX_ETI_EXPORT OldBasketDataBCGrp
{
public:
    /// Initialize default instance.
    OldBasketDataBCGrp();

    /// Timestamp of the match event (trade).
    UInt64 transactTime;

    /// System defined Basket ID.
    UInt64 basketTrdMatchId;

    /// System defined Original Basket ID.
    UInt64 origBasketTrdMatchId;

    /// User defined transaction ID. Part of the TES response and TES broadcast.
    std::string tradeReportId;

    /// Month year code for expiry YYYYMM.
    UInt32 maturityMonthYear;

    /// Indicates whether the counterparties have the right for early termination.
    OptionalEarlyTerminationIndicator::Enum optionalEarlyTerminationIndicator;

    /// Basket operation.
    BasketTradeReportType::Enum basketTradeReportType;

    /// User defined text message field.
    std::string basketTradeReportText;

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

private:
    friend class Serializer;
    OldBasketDataBCGrp(const void* data);
};

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

/// New Basket Data BC Group.
class ONIXS_EUREX_ETI_EXPORT NewBasketDataBCGrp
{
public:
    /// Initialize default instance.
    NewBasketDataBCGrp();

    /// Timestamp of the match event (trade).
    UInt64 transactTime;

    /// System defined Basket ID.
    UInt64 basketTrdMatchId;

    /// System defined Original Basket ID.
    UInt64 origBasketTrdMatchId;

    /// User defined transaction ID. Part of the TES response and TES broadcast.
    std::string tradeReportId;

    /// Month year code for expiry YYYYMM.
    UInt32 maturityMonthYear;

    /// Indicates whether the counterparties have the right for early termination.
    OptionalEarlyTerminationIndicator::Enum optionalEarlyTerminationIndicator;

    /// Basket operation.
    BasketTradeReportType::Enum basketTradeReportType;

    /// User defined text message field.
    std::string basketTradeReportText;

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

private:
    friend class Serializer;
    NewBasketDataBCGrp(const void* data);
};

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

/// Old Basket Instrument Match Side Group Element.
class ONIXS_EUREX_ETI_EXPORT OldBasketInstrmtMatchSideGrpElem
{
public:
    /// Initialize default instance.
    OldBasketInstrmtMatchSideGrpElem();

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

    /// Price of this leg fill.
    SInt64 lastPx;

    /// Trade Closure Time, the time when an Off-Book trade was concluded outside the Eurex System.
    UInt64 transBkdTime;

    /// User defined index price.
    SInt64 relatedClosePrice;

    /// Final trade price.
    SInt64 clearingTradePrice;

    /// Identifier for a Trade Entry Service trade, i.e TES trade ID.
    UInt32 packageId;

    /// Product ID.
    SInt32 sideMarketSegmentId;

    /// Sub-type of a trade type.
    SideTrdSubTyp::Enum sideTrdSubTyp;

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

    /// Indicates if a trade should be reported via the market reporting service.
    TradePublishIndicator::Enum tradePublishIndicator;

    /// ID to map element of InstrmtMatchSideGrp and BasketSideAllocGrp.
    UInt8 instrmtMatchSideId;

    /// Transaction effect on a basket.
    EffectOnBasket::Enum effectOnBasket;

    /// User defined text field.
    std::string tradeReportText;

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

private:
    friend class Serializer;
    OldBasketInstrmtMatchSideGrpElem(const void* data);
};

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

/// New Basket Instrument Match Side Group Element.
class ONIXS_EUREX_ETI_EXPORT NewBasketInstrmtMatchSideGrpElem
{
public:
    /// Initialize default instance.
    NewBasketInstrmtMatchSideGrpElem();

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

    /// Price of this leg fill.
    SInt64 lastPx;

    /// Trade Closure Time, the time when an Off-Book trade was concluded outside the Eurex System.
    UInt64 transBkdTime;

    /// User defined index price.
    SInt64 relatedClosePrice;

    /// Final trade price.
    SInt64 clearingTradePrice;

    /// Identifier for a Trade Entry Service trade, i.e TES trade ID.
    UInt32 packageId;

    /// Product ID.
    SInt32 sideMarketSegmentId;

    /// Sub-type of a trade type.
    SideTrdSubTyp::Enum sideTrdSubTyp;

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

    /// Indicates if a trade should be reported via the market reporting service.
    TradePublishIndicator::Enum tradePublishIndicator;

    /// ID to map element of InstrmtMatchSideGrp and BasketSideAllocGrp.
    UInt8 instrmtMatchSideId;

    /// Transaction effect on a basket.
    EffectOnBasket::Enum effectOnBasket;

    /// User defined text field.
    std::string tradeReportText;

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

private:
    friend class Serializer;
    NewBasketInstrmtMatchSideGrpElem(const void* data);
};

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

/// Old Basket Side Alloc Group Element.
class ONIXS_EUREX_ETI_EXPORT OldBasketSideAllocGrpElem
{
public:
    /// Initialize default instance.
    OldBasketSideAllocGrpElem();

    /// Quantity of the particular trade side in the TES trade.
    SInt64 allocQty;

    /// Unique identifier for a TES trade side.
    UInt32 individualAllocId;

    /// Party sub-type.
    PartySubIdType::Enum partySubIdType;

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

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

    /// ID to map element of InstrmtMatchSideGrp and BasketSideAllocGrp.
    UInt8 instrmtMatchSideId;

    /// Status of an allocation in a Trade Entry Service trade.
    TradeAllocStatus::Enum tradeAllocStatus;

    /// Owning business unit name.
    std::string partyExecutingFirm;

    /// Owning user name.
    std::string partyExecutingTrader;

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

private:
    friend class Serializer;
    OldBasketSideAllocGrpElem(const void* data);
};

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

/// New Basket Side Alloc Group Element.
class ONIXS_EUREX_ETI_EXPORT NewBasketSideAllocGrpElem
{
public:
    /// Initialize default instance.
    NewBasketSideAllocGrpElem();

    /// Quantity of the particular trade side in the TES trade.
    SInt64 allocQty;

    /// Unique identifier for a TES trade side.
    UInt32 individualAllocId;

    /// Party sub-type.
    PartySubIdType::Enum partySubIdType;

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

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

    /// ID to map element of InstrmtMatchSideGrp and BasketSideAllocGrp.
    UInt8 instrmtMatchSideId;

    /// Status of an allocation in a Trade Entry Service trade.
    TradeAllocStatus::Enum tradeAllocStatus;

    /// Owning business unit name.
    std::string partyExecutingFirm;

    /// Owning user name.
    std::string partyExecutingTrader;

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

private:
    friend class Serializer;
    NewBasketSideAllocGrpElem(const void* data);
};

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

/// Basket Roll Broadcast Message.
class ONIXS_EUREX_ETI_EXPORT BasketRollBroadcast : public Message
{
public:
    /// Initialize default instance.
    BasketRollBroadcast();

    /// Message sequence number assigned to a non-order related Eurex ETI data stream.
    UInt64 applSeqNum;

    /// 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;

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

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

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

    /// System generated transaction ID for a Basket transaction.
    UInt32 basketExecId;

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

    /// ID of the Basket profile.
    UInt32 basketProfileId;

    /// Indicates if a trade should be reported via the market reporting service.
    TrdType::Enum trdType;

    /// Identifies the type of trade notification.
    TradeReportType::Enum tradeReportType;

    /// Receiver of a message.
    MessageEventSource::Enum messageEventSource;

    /// Used to indicate anonymized trades in baskets.
    BasketAnonymity::Enum basketAnonymity;

    /// User defined text message field.
    std::string basketTradeReportText;

    /// User defined transaction ID. Part of the TES response and TES broadcast.
    std::string tradeReportId;

    /// Basket Root Party Group.
    std::vector<BasketRootPartyGrpElem> basketRootPartyGrp;

    /// Old Basket Data BC Group.
    OldBasketDataBCGrp oldBasketDataBCGrp;

    /// New Basket Data BC Group.
    NewBasketDataBCGrp newBasketDataBCGrp;

    /// Old Basket Instrument Match Side Group.
    std::vector<OldBasketInstrmtMatchSideGrpElem> oldBasketInstrmtMatchSideGrp;

    /// New Basket Instrument Match Side Group.
    std::vector<NewBasketInstrmtMatchSideGrpElem> newBasketInstrmtMatchSideGrp;

    /// Old Basket Side Alloc Group.
    std::vector<OldBasketSideAllocGrpElem> oldBasketSideAllocGrp;

    /// New Basket Side Alloc Group.
    std::vector<NewBasketSideAllocGrpElem> newBasketSideAllocGrp;

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

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

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

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

}}}