FieldSet.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/MarketData/FieldValueRef.h>
#include <OnixS/Eurex/MarketData/Numeric.h>
#include <OnixS/Eurex/MarketData/Tag.h>
#include <OnixS/Eurex/MarketData/Timestamp.h>

#include <vector>

namespace OnixS
{
    namespace Eurex
    {
        namespace MarketData
        {

            ONIXS_EUREX_EMDI_API_DECL (class, Group);
            ONIXS_EUREX_EMDI_API_DECL (class, Message);

            /// Field primary attributes (tag and a reference to a value).
            struct ONIXS_EUREX_EMDI_API Field
            {
                /// Field tag.
                Tag tag;

                /// Field value reference.
                FieldValueRef value;

                /// Initializes field which refers to nothing.
                Field()
                    : tag (0)
                {
                }

                /// Initializes all members.
                Field (Tag fieldTag, const FieldValueRef& fieldValue)
                    : tag (fieldTag), value (fieldValue)
                {
                }
            };

            /// Ordered collection of fields.
            typedef std::vector<Field> Fields;

            /// Encapsulates primary operations over collection of FIX
            /// fields like FIX message and repeating group instance are.
            class ONIXS_EUREX_EMDI_API FieldSet
            {
                public:
                    /// Indicates whether instance refers to a valid set of fields.
                    ///
                    /// If given instance doesn't refer to a valid fields set,
                    /// none of other members must be used.
                    operator bool() const;

                    /// Returns reference to a given field value.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    FieldValueRef get (Tag tag) const;

                    /// Returns field value as an OnixS::FIX::Int32 value.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    Int32 getInt32 (Tag tag) const;

                    /// Returns field value as an OnixS::FIX::UInt32 value.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    UInt32 getUInt32 (Tag tag) const;

                    /// Returns field value as an OnixS::FIX::Int64 value.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    Int64 getInt64 (Tag tag) const;

                    /// Returns field value as an OnixS::FIX::UInt64 value.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    UInt64 getUInt64 (Tag tag) const;

                    /// Returns the field value as a decimal number.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    Decimal getDecimal (Tag tag) const;

                    /// Returns reference to a read-only text chain.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    StringRef getStringRef (Tag tag) const;

                    /// Returns the field value as timestamp of requested format.
                    ///
                    /// @throw std::exception if conversion is impossible.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    Timestamp
                    getTimestamp (
                        Tag tag,
                        TimestampFormat::Enum =
                            TimestampFormat::YYYYMMDDHHMMSSNsec) const;

                    /// Returns reference to a repeating group if underlying
                    /// field defines length of repeating group.
                    ///
                    /// @param numberOfInstancesTag Tag number of
                    /// the field that defines the number of instances
                    /// in this repeating group (the NoXXX field).
                    ///
                    /// @throw std::exception if no repeating group
                    /// is associated with given field (tag).
                    ///
                    /// @warning Returned instance remains valid until field is
                    /// modified via any of OnixS::FIX::FieldSet::set members.
                    Group getGroup (Tag numberOfInstancesTag) const;

                    /// Returns reference to a repeating group if underlying
                    /// field defines length of repeating group.
                    ///
                    /// @param numberOfInstancesTag Tag number of
                    /// the field that defines the number of instances
                    /// in this repeating group (the NoXXX field).
                    ///
                    /// @warning Returned instance remains valid until field is
                    /// modified via any of OnixS::FIX::FieldSet::set members.
                    Group getOptionalGroup (Tag numberOfInstancesTag) const;

                    /// Returns true if the given flag is present
                    /// and it equals to "Y", otherwise false.
                    ///
                    /// @warning Due to performance considerations, doesn't
                    /// check whether instance refers to a valid set of fields.
                    /// Use OnixS::FIX::FieldSet::operator bool() to check whether
                    /// instance is in valid state.
                    bool hasFlag (Tag tag) const;

                    /// Retrieve tags and values of all non-empty fields belonged to the given @c FieldSet instance.
                    /// @param fields Object to receive the @c FieldSet content.
                    /// @return Number of fields placed to the @c fields vector.
                    size_t fields (Fields& fields) const;

                    ///
                    void swap(FieldSet&) throw();

                protected:
                    // Message to which given set belongs to.
                    const Message* container_;

                    // Underlying implementation.
                    void* impl_;

                    // Uninitialized set.
                    FieldSet();

                    // Uninitialized set.
                    FieldSet (const Message*, void*);

                    // Clone construction.
                    FieldSet (const FieldSet&);

                    // Destruction available via descendants.
                    ~FieldSet();

                    FieldSet& operator = (const FieldSet&);

                private:
                    friend class Message;
                    friend class GroupInstance;
                    friend class MessageOperator;
            };


            template<typename Enumeration>
            inline typename Enumeration::Enum getIntEnumFieldValue (const FieldSet& fieldSet, Tag tag)
            {
                UInt32 value;
                return (fieldSet.get (tag).toNumber (value) ? static_cast<typename Enumeration::Enum> (value) : Enumeration::Undefined);
            }

            template<typename Enumeration>
            inline typename Enumeration::Enum getNonZeroIntEnumFieldValue (const FieldSet& fieldSet, Tag tag)
            {
                UInt32 value;
                return (fieldSet.get (tag).toNumber (value) ? static_cast<typename Enumeration::Enum> (value + 1) : Enumeration::Undefined);
            }
        }
    }
}