Field.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/ConflatedUDP/FIX/ValueContainer.h>
#include <OnixS/CME/ConflatedUDP/FIX/ValueConverters.h>

ONIXS_CONFLATEDUDPFIX_NAMESPACE_BEGIN

/// Represents the field in the FIX message. 
/// 
/// Exposes operations to access value 
/// and make a compatible conversion. 
ONIXS_CONFLATEDUDP_LTWT_CLASS Field
{
    ValueContainer value_;
    const ValueConverter* converter_;

protected:
    /// Initializes the field. 
    Field(
        const 
        ValueConverter& converter)
        : value_(), converter_(&converter)
    {
    }

    /// Exposes value storage for further value manipulations. 
    const ValueContainer& value() const
    {
        return value_;
    }

    /// Exposes value storage for further value manipulations. 
    ValueContainer& value()
    {
        return value_;
    }

public:
    /// Initializes the field with no value. 
    Field()
        : value_()
        , converter_
        (
            &NullConverter::
            self()
        )
    {
    }

    /// Initializes as the copy of the other field. 
    Field(
        const Field& other)
        : value_(other.value_)
        , converter_(other.converter_)
    {
    }

    /// Tells whether the field has 
    /// an associated (non-null) value. 
    operator bool() const
    {
        return (
            converter_ != 
            &NullConverter::self()
        );
    }

    /// Casts the stored value to the requested type.
    /// 
    /// The value may be converted into the value of the 
    /// requested type if a conversion is possible. Otherwise, 
    /// an exception is thrown. For example, if the field value 
    /// represents a reference to a string (e.g. instance of the 
    /// StrRef class), then it can be successfully converted into 
    /// a number if the string referred represents a number. 
    template
    <
        class Value
    >
    typename 
    ValueConversion<Value>::Result
    cast() const
    {
        ValueConversion<Value> convert;
        
        return 
            convert
            (
                *converter_, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the StrRef type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        StrRef& str) const
    {
        return 
            converter_->convert
            (
                str, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Char type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Char& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Int8 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Int8& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the UInt8 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        UInt8& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Int16 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Int16& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the UInt16 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        UInt16& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Int32 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Int32& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the UInt32 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        UInt32& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Int64 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Int64& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the UInt64 type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        UInt64& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a
    /// value of the Timestamp type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        Timestamp& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a value
    /// of the MaturityMonthYear type. Returned value 
    /// indicates whether the casting succeeded. 
    bool 
    tryCast(
        MaturityMonthYear& value) const
    {
        return 
            converter_->convert
            (
                value, 
                value_
            );
    }

    /// Tries to cast the stored value into a value
    /// of the given Enumeration type. Returned value 
    /// indicates whether the casting succeeded. 
    template
    <
        class Enumeration
    >
    bool 
    tryCast(
        typename 
        Enumeration::Enum& value) const
    {
        typename 
        Enumeration::Base 
        integral;

        if (converter_->
            convert(
                integral, 
                value_))
        {
            value = 
                static_cast
                <
                    typename 
                    Enumeration::Enum
                >
                (integral);

            return true;
        }

        return false;
    }

    /// Tries to cast the stored value into a value
    /// of the type representing a BitSet. Returned 
    /// value indicates whether the casting succeeded. 
    template
    <
        class BitSet
    >
    bool 
    tryCast(
        BitSet& value, 
        typename BitSet::Bits* = NULL) const
    {
        typename BitSet::Bits bits;
        
        if (converter_->
                convert(
                    bits, 
                    value_))
        {
            value = BitSet(bits);

            return true;
        }

        return false;
    }

    /// Returns the text representation. 
    std::string 
    toStr() const
    {
        std::string str;

        toStr(str);

        return str;
    }

    /// Outputs the text representation into the given string. 
    void  
    toStr(
        std::string& str) const
    {
        converter_->toStr
        (
            str, 
            value_
        );
    }

    /// Re-initializes the field as a copy of the other one. 
    Field&
    operator =( 
        const Field& other) 
    {
        value_ = other.value_;
        converter_ = other.converter_;

        return *this;
    }
};

ONIXS_CONFLATEDUDPFIX_NAMESPACE_END