MulticastChannelGroups.h

Go to the documentation of this file.

/**
 * \file
 * \brief Declare internal `OnixS::ICE::iMpact::MarketData::MulticastChannelGroups` message structure
 * \attention DO NOT EDIT! This file was generated!
 */
/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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

// Project specific headers
#include "../Enumerations.h"
#include "../Export.h"
#include "../Types.h"

// Standard headers
#include <iosfwd>
#include <string>
#include <vector>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// This class represents the Multicast Channel Groups Message.
struct ONIXS_ICEMDH_EXPORT MulticastChannelGroups
{
    /// Message type constant
    enum
    {
        messageType = 'X'
    };

    /// This nested class represents channel group definition.
    struct ChannelGroup
    {
        /// The ID for this Channel Group as found in the ICE Multicast
        /// Connectivity Guide.
        short id;

        /// The name of this Channel Group, as found in the ICE Multicast
        /// Connectivity Guide.
        std::string name;

        /// Indicates the type of this channel group.
        MulticastChannelGroupType::Enum type;

        /// Multicast IP address for the Full Order Depth Live Updates Channel.
        /// Blank if none exists.
        std::string fodLiveUpdateIPAddress;

        /// Multicast Port for the Full Order Depth Live Updates Channel. `0` if
        /// none exists.
        short fodLiveUpdatePort;

        /// Multicast IP address for the Full Order Depth Snapshots Updates
        /// Channel. Blank if none exists.
        std::string fodSnapshotIPAddress;

        /// Multicast Port for the Full Order Depth Snapshots Updates Channel. `0`
        /// if none exists.
        short fodSnapshotPort;

        /// Multicast IP address for the Price Level Live Updates Channel. Blank
        /// if none exists.
        std::string plLiveUpdateIPAddress;

        /// Multicast Port for the Price Level Live Updates Channel. `0` if none
        /// exists.
        short plLiveUpdatePort;

        /// Multicast IP address for the Price Level Snapshots Updates Channel.
        /// Blank if none exists.
        std::string plSnapshotIPAddress;

        /// Multicast Port for the Price Level Snapshots Updates Channel. `0` if
        /// none exists.
        short plSnapshotPort;

        /// Number of price levels on this channel.
        char numberOfPriceLevels;

        /// Alias for collection of MarketTypes.
        typedef std::vector<MarketType> MarketTypes;

        /// Collection of MarketTypes.
        MarketTypes marketTypes;

        /// Default constructor.
        ChannelGroup();

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

    /// Alias for collection of ChannelGroups.
    typedef std::vector<ChannelGroup> ChannelGroups;

    /// Collection of ChannelGroups.
    ChannelGroups channelGroups;

    /// This nested class represents market type mapping definition.
    struct MarketTypeMapping
    {
        /// The ID for this Market Type as found in Appendix C.
        MarketType marketTypeId;

        /// The length of the market type name to follow.
        short marketTypeNameLength;

        /// The name of the market type. See MarketTypeNameLength for the number
        /// of characters.
        std::string marketTypeName;

        /// Default constructor.
        MarketTypeMapping();

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

    /// Alias for collection of MarketTypeMappings.
    typedef std::vector<MarketTypeMapping> MarketTypeMappings;

    /// Collection of MarketTypeMappings.
    MarketTypeMappings marketTypeMappings;

    /// Default constructor.
    MulticastChannelGroups();

    /// Initialize from raw message data.
    MulticastChannelGroups(const char* data, std::size_t dataSize);

    /// Deserialize from raw data.
    void deserialize(const char* data, std::size_t dataSize);

    /// Reset all fields to default values.
    void reset();

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

/// Make it printable using C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const MulticastChannelGroups&);

}}}} // namespace OnixS::ICE::iMpact::MarketData