Settlement.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/Numeric.h>
#include <OnixS/Eurex/MarketData/Defines.h>
#include <OnixS/Eurex/MarketData/Message.h>
#include <OnixS/Eurex/MarketData/Group.h>
#include <OnixS/Eurex/MarketData/Tags.h>

namespace OnixS
{
    namespace Eurex
    {
        namespace MarketData
        {
            /// Exposes list of available settlement supplements
            struct ONIXS_EUREX_EMDI_API SettlPriceType
            {
                enum Enum
                {
                    /// Used to identify absence of value.
                    Undefined = -1,

                    ///
                    Final = 0,

                    ///
                    Theoretical = 1,
                };
            };


            /// Settlement
            class ONIXS_EUREX_EMDI_API Settlement : public Message
            {
                public:
                    /// Instrument ID from Eurex Exchange�s new trading architecture
                    SecurityId securityId() const
                    {
                        return getInt64 (Tags::SecurityID);
                    }

                    /// Product ID from Eurex Exchange�s new trading architecture
                    MarketSegmentId marketSegmentId() const
                    {
                        return getUInt32 (Tags::MarketSegmentID);
                    }

                    /// Intraday Settlement Price
                    Decimal mdEntryPx() const
                    {
                        return getGroup (Tags::NoMDEntries).at (0).getDecimal (Tags::MDEntryPx);
                    }

                    /// Settlement Supplement
                    SettlPriceType::Enum settlPriceType() const
                    {
                        return getIntEnumFieldValue<SettlPriceType>(getGroup(Tags::NoMDEntries).at(0), Tags::SettlPriceType);
                    }

                    /// Time of entry (nanoseconds)
                    UInt64 mdEntryTime() const
                    {
                        return getGroup (Tags::NoMDEntries).at (0).getUInt64 (Tags::MDEntryTime);
                    }

                private:
                    friend class SettlementWrapper;

                    Settlement (const void* impl)
                        : Message (impl)
                    {
                    }
            };
        }
    }
}