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);

            struct ONIXS_EUREX_EMDI_API Field
            {
                Tag tag;

                FieldValueRef value;

                Field()
                    : tag (0)
                {
                }

                Field (Tag fieldTag, const FieldValueRef& fieldValue)
                    : tag (fieldTag), value (fieldValue)
                {
                }
            };

            typedef std::vector<Field> Fields;

            class ONIXS_EUREX_EMDI_API FieldSet
            {
                public:
                    operator bool() const;

                    FieldValueRef get (Tag tag) const;

                    Int32 getInt32 (Tag tag) const;

                    UInt32 getUInt32 (Tag tag) const;

                    Int64 getInt64 (Tag tag) const;

                    UInt64 getUInt64 (Tag tag) const;

                    Decimal getDecimal (Tag tag) const;

                    StringRef getStringRef (Tag tag) const;

                    Timestamp
                    getTimestamp (
                        Tag tag,
                        TimestampFormat::Enum =
                            TimestampFormat::YYYYMMDDHHMMSSNsec) const;

                    Group getGroup (Tag numberOfInstancesTag) const;

                    Group getOptionalGroup (Tag numberOfInstancesTag) const;

                    bool hasFlag (Tag tag) const;

                    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);
            }
        }
    }
}