Group.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/ABI.h>
#include <OnixS/Eurex/MarketData/FieldSet.h>

namespace OnixS
{
    namespace Eurex
    {
        namespace MarketData
        {
            ONIXS_EUREX_EMDI_API_DECL (class, Message);
            ONIXS_EUREX_EMDI_API_DECL (class, Group);

            /// Single instance of FIX Repeating Group. Provides access
            /// to the fields of a particular repeating group instance.
            ///
            /// Class behaves like a pointer/reference to a set of FIX
            /// fields. Coping and assignment operations just update reference
            /// to the field-set being pointed, no deep copying is performed.
            class ONIXS_EUREX_EMDI_API GroupInstance : public FieldSet
            {
                public:
                    /// Initializes instance as reference to the other one.
                    GroupInstance (const GroupInstance& other);

                    /// Reinitializes instance as reference of other one.
                    GroupInstance& operator = (const GroupInstance&);

                private:
                    friend class MessageOperator;

                    GroupInstance (const Message*, void*);
            };

            /// Encapsulates operations over FIX Repeating Group.
            ///
            /// Repeating group represents array of repeating group instances,
            /// So, class exposes corresponding services to manipulate array
            /// of repeating group instances. Similar to the OnixS::FIX::GroupInstance
            /// it behaves like a pointer/reference to the underlying data. It's
            /// a light-weight object which just wraps internal data.
            ///
            /// Group remains valid until corresponding field (which defines
            /// size/length of repeating group) from field-set (message or outer
            /// repeating group instance) is updated.
            class ONIXS_EUREX_EMDI_API Group
            {
                public:
                    /// Initializes instance as reference to given repeating group.
                    Group (const Group& other);

                    /// Indicated whether group refers to a valid instance.
                    operator bool() const;

                    /// Return number of instances in repeating group.
                    ///
                    /// @warning Due to performance considerations,
                    /// instance is not checked for validness. Member
                    /// must be used only when instance is in valid state.
                    size_t size() const;

                    /// Accesses to repeating group instance.
                    ///
                    /// @throw std::exception if If index exceeds allowed bounds.
                    ///
                    /// @warning Due to performance considerations,
                    /// instance is not checked for validness. Member
                    /// must be used only when instance is in valid state.
                    const GroupInstance at (size_t index) const;

                    /// Accesses to repeating group instance.
                    ///
                    /// Does NOT check index validness.
                    ///
                    /// @warning Due to performance considerations,
                    /// instance is not checked for validness. Member
                    /// must be used only when instance is in valid state.
                    const GroupInstance operator [] (size_t index) const;

                    /// Reinitializes instance as reference to other one.
                    Group& operator = (const Group& other);


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

                private:
                    friend class MessageOperator;

                    const Message* container_;

                    void* impl_;

                    Group (const Message*, void*);
            };

            template<class Entry>
            class TypedGroup : protected Group
            {
                public:
                    /// Return number of instances in the repeating group.
                    using Group::size;

                    /// Indicates whether set has an entries.
                    bool empty() const
                    {
                        return 0 == size();
                    }

                    /// Accesses to repeating group instance.
                    ///
                    /// @throw std::exception if If index exceeds allowed bounds.
                    const Entry at (size_t index) const
                    {
                        if (index < size() )
                            return Entry (this->Group::operator[] (index) );

                        throw std::out_of_range ("Index");
                    }

                    /// Accesses to repeating group instance.
                    ///
                    /// Does NOT check index validness.
                    Entry operator [] (size_t index) const
                    {
                        return Entry (this->Group::operator[] (index) );
                    }

                protected:
                    explicit
                    TypedGroup (const Group& group)
                        : Group (group)
                    {
                    }
            };
        }
    }
}