Composites.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/CME/ConflatedTCP/ABI.h>

#include <OnixS/CME/ConflatedTCP/messaging/Memory.h>
#include <OnixS/CME/ConflatedTCP/messaging/Fields.h>

ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_BEGIN
ONIXS_CONFLATEDTCP_DATA_PACKING_BEGIN(1)

/// Repeating group dimensions.
///
/// FIX type: NumInGroup.
ONIXS_CONFLATEDTCP_LTWT_CLASS GroupSize
{
public:
    /// Size of the composite.
    enum { Size = 3 };

    /// Type alias for the `BlockLength`.
    typedef UInt16 BlockLength;

    /// Type alias for the `NumInGroup`.
    typedef UInt8 NumInGroup;

    /// \return the `blockLength` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    BlockLength blockLength() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return blockLength_;
    }

    /// Sets the `blockLength` field.
    void setBlockLength(BlockLength value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        blockLength_ = value;
    }

    /// \return the `numInGroup` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    NumInGroup numInGroup() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return numInGroup_;
    }

    /// Sets the `numInGroup` field.
    void setNumInGroup(NumInGroup value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        numInGroup_ = value;
    }

private:
    BlockLength blockLength_;
    NumInGroup numInGroup_;
};


/// Repeating group dimensions.
ONIXS_CONFLATEDTCP_LTWT_CLASS GroupSizeEncoding
{
public:
    /// Size of the composite.
    enum { Size = 4 };

    /// Type alias for the `BlockLength`.
    ///
    /// FIX type: Length.
    typedef UInt16 BlockLength;

    /// Type alias for the `NumInGroup`.
    ///
    /// FIX type: NumInGroup.
    typedef UInt16 NumInGroup;

    /// \return the `blockLength` field.
    ///
    /// FIX type: Length.
    ONIXS_CONFLATEDTCP_NODISCARD
    BlockLength blockLength() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return blockLength_;
    }

    /// Sets the `blockLength` field.
    ///
    /// FIX type: Length.
    void setBlockLength(BlockLength value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        blockLength_ = value;
    }

    /// \return the `numInGroup` field.
    ///
    /// FIX type: NumInGroup.
    ONIXS_CONFLATEDTCP_NODISCARD
    NumInGroup numInGroup() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return numInGroup_;
    }

    /// Sets the `numInGroup` field.
    ///
    /// FIX type: NumInGroup.
    void setNumInGroup(NumInGroup value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        numInGroup_ = value;
    }

private:
    BlockLength blockLength_;
    NumInGroup numInGroup_;
};


/// Template ID and length of message root.
ONIXS_CONFLATEDTCP_LTWT_CLASS MessageHeader
{
public:
    /// Size of the composite.
    enum { Size = 8 };

    /// Type alias for the `BlockLength`.
    typedef UInt16 BlockLength;

    /// Type alias for the `TemplateId`.
    typedef UInt16 TemplateId;

    /// Type alias for the `SchemaId`.
    typedef UInt16 SchemaId;

    /// Type alias for the `Version`.
    typedef UInt16 Version;

    /// \return the `blockLength` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    BlockLength blockLength() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return blockLength_;
    }

    /// Sets the `blockLength` field.
    void setBlockLength(BlockLength value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        blockLength_ = value;
    }

    /// \return the `templateId` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    TemplateId templateId() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return templateId_;
    }

    /// Sets the `templateId` field.
    void setTemplateId(TemplateId value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        templateId_ = value;
    }

    /// \return the `schemaId` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    SchemaId schemaId() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return schemaId_;
    }

    /// Sets the `schemaId` field.
    void setSchemaId(SchemaId value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        schemaId_ = value;
    }

    /// \return the `version` field.
    ONIXS_CONFLATEDTCP_NODISCARD
    Version version() const
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        return version_;
    }

    /// Sets the `version` field.
    void setVersion(Version value)
        ONIXS_CONFLATEDTCP_NOTHROW
    {
        version_ = value;
    }

private:
    BlockLength blockLength_;
    TemplateId templateId_;
    SchemaId schemaId_;
    Version version_;
};


typedef MessageHeader MessageHeaderBuilder;

ONIXS_CONFLATEDTCP_DATA_PACKING_END



ONIXS_CONFLATEDTCP_MESSAGING_NAMESPACE_END