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/iLink3/ABI.h>

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

ONIXS_ILINK3_MESSAGING_NAMESPACE_BEGIN
ONIXS_ILINK3_DATA_PACKING_BEGIN(1)

/// DATA Field.
/// FIX type: data.
ONIXS_ILINK3_LTWT_STRUCT DATA
{
public:
    /// Size of the composite.
    enum { Size = 2 };

    /// Length type.
    typedef UInt16 Length;

    /// VarData type.
    typedef Char VarData;

    /// \return length.
    ONIXS_ILINK3_NODISCARD
    Length length() const
        ONIXS_ILINK3_NOTHROW
    {
        return length_;
    }

    /// Sets the length.
    void length(Length value)
        ONIXS_ILINK3_NOTHROW
    {
        length_ = value;
    }

    /// \return the varData field.
    ONIXS_ILINK3_NODISCARD
    StrRef varData() const
        ONIXS_ILINK3_NOTHROW
    {
        return StrRef(reinterpret_cast<const Char*>(this) + Size, length());
    }

    /// Sets the varData field.
    void varData(StrRef value)
        ONIXS_ILINK3_NOTHROW
    {
        length(static_cast<Length>(value.size()));
        if(value.data())
            std::memcpy(reinterpret_cast<Char*>(this) + Size, value.data(), value.size());
    }

    /// \return Size of SBE-encoded data representing the field.
    ONIXS_ILINK3_NODISCARD
    Length binarySize() const
        ONIXS_ILINK3_NOTHROW
    {
        return Size + length();
    }

private:
    Length length_;
};


/// Repeating group dimensions.
///
/// FIX type: NumInGroup.
ONIXS_ILINK3_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_ILINK3_NODISCARD
    BlockLength blockLength() const
        ONIXS_ILINK3_NOTHROW
    {
        return blockLength_;
    }

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

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

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

private:
    BlockLength blockLength_;
    NumInGroup numInGroup_;
};


/// Repeating group dimensions.
ONIXS_ILINK3_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_ILINK3_NODISCARD
    BlockLength blockLength() const
        ONIXS_ILINK3_NOTHROW
    {
        return blockLength_;
    }

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

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

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

private:
    BlockLength blockLength_;
    NumInGroup numInGroup_;
};


/// Template ID and length of message root.
ONIXS_ILINK3_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_ILINK3_NODISCARD
    BlockLength blockLength() const
        ONIXS_ILINK3_NOTHROW
    {
        return blockLength_;
    }

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

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

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

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

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

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

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

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


typedef MessageHeader MessageHeaderBuilder;

ONIXS_ILINK3_DATA_PACKING_END

/// Optional floating point decimal with int32 mantissa and int8 exponent.
typedef
FloatingPointDecimal
<
    Int32,
    Int8
>
Decimal32NULL;

/// Null values definition for optional Decimal32NULL field.
ONIXS_ILINK3_LTWT_STRUCT NullDecimal32NULL
{
    /// Aliases the type whose null value
    /// traits are exposed by the given class.
    typedef Decimal32NULL Value;

    /// Null value for an optional Mantissa field.
    typedef
    IntegralConstant<Int32, 2147483647>
    NullMantissa;


    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator ==(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return (
           NullMantissa() ==
           other.mantissa());
    }

    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator !=(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return !(*this == other);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    operator Value() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    Value operator()() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    static Value value()
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }
};

/// \return whether the given value is Null.
ONIXS_ILINK3_NODISCARD
inline
bool
isNull(
    const Decimal32NULL& value)
    ONIXS_ILINK3_NOTHROW
{
    return NullDecimal32NULL() == value;
}


/// Optional floating point decimal.
typedef
FloatingPointDecimal
<
    Int64,
    Int8
>
Decimal64NULL;

/// Null values definition for optional Decimal64NULL field.
ONIXS_ILINK3_LTWT_STRUCT NullDecimal64NULL
{
    /// Aliases the type whose null value
    /// traits are exposed by the given class.
    typedef Decimal64NULL Value;

    /// Null value for an optional Mantissa field.
    typedef
    IntegralConstant<Int64, 9223372036854775807LL>
    NullMantissa;


    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator ==(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return (
           NullMantissa() ==
           other.mantissa());
    }

    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator !=(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return !(*this == other);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    operator Value() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    Value operator()() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    static Value value()
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa(), 0);
    }
};

/// \return whether the given value is Null.
ONIXS_ILINK3_NODISCARD
inline
bool
isNull(
    const Decimal64NULL& value)
    ONIXS_ILINK3_NOTHROW
{
    return NullDecimal64NULL() == value;
}


/// Year, Month and Date.
///
/// FIX type: MonthYear.
ONIXS_ILINK3_LTWT_CLASS MaturityMonthYear
{
public:
    /// Size of the composite.
    enum { Size = 5 };

    /// YYYY.
    typedef UInt16 Year;

    /// Null value for an optional Year field.
    typedef
    IntegralConstant<UInt16, 65535>
    NullYear;

    /// MM.
    typedef UInt8 Month;

    /// Null value for an optional Month field.
    typedef
    IntegralConstant<UInt8, 255>
    NullMonth;

    /// DD.
    typedef UInt8 Day;

    /// Null value for an optional Day field.
    typedef
    IntegralConstant<UInt8, 255>
    NullDay;

    /// WW.
    typedef UInt8 Week;

    /// Null value for an optional Week field.
    typedef
    IntegralConstant<UInt8, 255>
    NullWeek;

    /// Default constructor.
    ///
    /// Initializes fields with appropriate null values.
    ONIXS_ILINK3_CONSTEXPR
    MaturityMonthYear()
        ONIXS_ILINK3_NOTHROW
      : year_(NullYear::value()),
        month_(NullMonth::value()),
        day_(NullDay::value()),
        week_(NullWeek::value())
    {
    }

    /// Initializes fields with provided values
    ONIXS_ILINK3_CONSTEXPR
    MaturityMonthYear(
        Year year,
        Month month,
        Day day,
        Week week)
        ONIXS_ILINK3_NOTHROW
      : year_(year),
        month_(month),
        day_(day),
        week_(week)
    {
    }

    /// \return a human-readable presentation.
    ONIXS_ILINK3_NODISCARD
    std::string
    toString() const;

    /// \private
    /// Init traits.
    struct MemberTraits
    {
        enum { Count = 4 };

        typedef Year FirstArgType;

        typedef Month SecondArgType;

        typedef Day ThirdArgType;

        typedef Week FourthArgType;
    };

    /// Serializes to a data buffer
    void serialize(void* addr) const
        ONIXS_ILINK3_NOTHROW
    {
        assert(addr);

        std::memcpy(addr, &year_, sizeof(year_));
        addr = advanceByBytes(addr, sizeof(year_));

        std::memcpy(addr, &month_, sizeof(month_));
        addr = advanceByBytes(addr, sizeof(month_));

        std::memcpy(addr, &day_, sizeof(day_));
        addr = advanceByBytes(addr, sizeof(day_));

        std::memcpy(addr, &week_, sizeof(week_));
    }

    /// YYYY.
    ONIXS_ILINK3_NODISCARD
    Year year() const
        ONIXS_ILINK3_NOTHROW
    {
        return year_;
    }

    /// YYYY.
    void setYear(Year value)
        ONIXS_ILINK3_NOTHROW
    {
        year_ = value;
    }

    void setYearToNull()
        ONIXS_ILINK3_NOTHROW
    {
        year_ = NullYear();
    }

    /// MM.
    ONIXS_ILINK3_NODISCARD
    bool month(Month& value) const
        ONIXS_ILINK3_NOTHROW
    {
        value = month_;
        return NullMonth() != month_;
    }

    /// MM.
    void setMonth(Month value)
        ONIXS_ILINK3_NOTHROW
    {
        month_ = value;
    }

    void setMonthToNull()
        ONIXS_ILINK3_NOTHROW
    {
        month_ = NullMonth();
    }

    /// DD.
    ONIXS_ILINK3_NODISCARD
    bool day(Day& value) const
        ONIXS_ILINK3_NOTHROW
    {
        value = day_;
        return NullDay() != day_;
    }

    /// DD.
    void setDay(Day value)
        ONIXS_ILINK3_NOTHROW
    {
        day_ = value;
    }

    void setDayToNull()
        ONIXS_ILINK3_NOTHROW
    {
        day_ = NullDay();
    }

    /// WW.
    ONIXS_ILINK3_NODISCARD
    bool week(Week& value) const
        ONIXS_ILINK3_NOTHROW
    {
        value = week_;
        return NullWeek() != week_;
    }

    /// WW.
    void setWeek(Week value)
        ONIXS_ILINK3_NOTHROW
    {
        week_ = value;
    }

    void setWeekToNull()
        ONIXS_ILINK3_NOTHROW
    {
        week_ = NullWeek();
    }

    /// Compares encoded data
    ONIXS_ILINK3_NODISCARD
    bool
    operator==(
        const MaturityMonthYear& other) const
        ONIXS_ILINK3_NOTHROW ;

    /// Compares encoded data
    ONIXS_ILINK3_NODISCARD
    bool
    operator!=(
        const MaturityMonthYear& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return !(*this == other);
    }

private:
    Year year_;
    Month month_;
    Day day_;
    Week week_;
};


/// Null values definition for optional MaturityMonthYear field.
ONIXS_ILINK3_LTWT_STRUCT NullMaturityMonthYear
{
    /// Aliases the type whose null value
    /// traits are exposed by the given class.
    typedef MaturityMonthYear Value;

    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator ==(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return (
           MaturityMonthYear::NullYear() ==
           other.year());
    }

    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator !=(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return !(*this == other);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    operator Value() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value();
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    Value operator()() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value();
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    static Value value()
        ONIXS_ILINK3_NOTHROW
    {
        return Value();
    }
};

inline
bool
MaturityMonthYear::operator==(
    const MaturityMonthYear& other) const
    ONIXS_ILINK3_NOTHROW
{
    if((NullMaturityMonthYear() == *this) &&
            (NullMaturityMonthYear() == other))
        return true;

    return
        (this->year_ == other.year_) &&
        (this->month_ == other.month_) &&
        (this->day_ == other.day_) &&
        (this->week_ == other.week_);
}

/// Price with constant exponent -9.
typedef
FixedPointDecimal
<
    Int64,
    IntegralConstant<Int8, -9>
>
PRICE9;

/// Null values definition for optional PRICE9 field.
ONIXS_ILINK3_LTWT_STRUCT NullPRICE9
{
    /// Aliases the type whose null value
    /// traits are exposed by the given class.
    typedef PRICE9 Value;

    /// Null value for an optional Mantissa field.
    typedef
    IntegralConstant<Int64, 9223372036854775807LL>
    NullMantissa;


    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator ==(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return (
           NullMantissa() ==
           other.mantissa());
    }

    /// Compares encoded data to NULL.
    ONIXS_ILINK3_NODISCARD
    bool operator !=(const Value& other) const
        ONIXS_ILINK3_NOTHROW
    {
        return !(*this == other);
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    operator Value() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa());
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    Value operator()() const
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa());
    }

    /// \return the value of the constant.
    ONIXS_ILINK3_CONSTEXPR
    static Value value()
        ONIXS_ILINK3_NOTHROW
    {
        return Value(NullMantissa());
    }
};

/// \return whether the given value is Null.
ONIXS_ILINK3_NODISCARD
inline bool isNull(const PRICE9& value)
    ONIXS_ILINK3_NOTHROW
{
    return NullPRICE9() == value;
}


ONIXS_ILINK3_MESSAGING_NAMESPACE_END