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

namespace OnixS
{
    namespace Eurex
    {
        namespace MarketData
        {
            /// Instrument state change
            class ONIXS_EUREX_EMDI_API InstrumentStateChange : public Message
            {
                public:
                    /// Product identifier.
                    MarketSegmentId marketSegmentId() const
                    {
                        return getUInt32 (Tags::MarketSegmentID);
                    }

                    /// Instrument identifier.
                    SecurityId securityId() const
                    {
                        return getInt64 (Tags::SecurityID);
                    }

                    /// Security Status.
                    SecurityStatus::Enum securityStatus() const
                    {
                        return getIntEnumFieldValue<SecurityStatus> (*this, Tags::SecurityStatus);
                    }

                    /// Defines the security trading status.
                    SecurityTradingStatus::Enum securityTradingStatus() const
                    {
                        return getIntEnumFieldValue<SecurityTradingStatus> (*this, Tags::SecurityTradingStatus);
                    }

                    /// Indicator for stressed market conditions.
                    MarketCondition::Enum marketCondition() const
                    {
                        return getIntEnumFieldValue<MarketCondition>(*this, Tags::MarketCondition);
                    }

                    /// Indicates if product is in the state Fast Market.
                    bool fastMarketIndicator() const
                    {
                        return getUInt32 (Tags::FastMarketIndicator) == 1;
                    }

                    /// Identifies an event related to a securityTradingStatus()
                    SecurityTradingEvent::Enum securityTradingEvent() const
                    {
                        return getIntEnumFieldValue<SecurityTradingEvent> (*this, Tags::SecurityTradingEvent);
                    }

                    /// Identifies the sold out status (applicable for continuous auction trading model only).
                    SoldOutIndicator::Enum soldOutIndicator() const
                    {
                        return getNonZeroIntEnumFieldValue<SoldOutIndicator>(*this, Tags::SoldOutIndicator);
                    }

                    /// Upper boundary price.
                    bool highPx(Decimal& price) const
                    {
                        return get(Tags::HighPx).toNumber(price);
                    }

                    /// Lower boundary price.
                    bool lowPx(Decimal& price) const
                    {
                        return get(Tags::LowPx).toNumber(price);
                    }

                    /// Time when request was processed by the matcher (nanoseconds).
                    UInt64 transactTime() const
                    {
                        return getUInt64(Tags::TransactTime);
                    }

                    /// Defines the TES security status.
                    SecurityStatus::Enum tesSecurityStatus() const
                    {
                        return getIntEnumFieldValue<SecurityStatus> (*this, Tags::TESSecurityStatus);
                    }

                private:
                    friend class InstrumentStateChangeWrapper;

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