OrderBook.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/CboeCFE/MarketData/Pitch/ABI.h>
#include <OnixS/CboeCFE/MarketData/Pitch/Defines.h>
#include <OnixS/CboeCFE/MarketData/Pitch/String.h>

#include <vector>
#include <memory>

namespace OnixS
{
    namespace CboeCFE
    {
        namespace MarketData
        {
            namespace Pitch
            {
                struct ONIXS_CBOECFE_PITCH_API OrderInfo
                {
                    OrderInfo() ONIXS_BATS_PITCH_NOTHROW;
                    OrderInfo (OrderId orderId, Quantity quantity) ONIXS_BATS_PITCH_NOTHROW;

                    OrderId orderId_;
                    Quantity quantity_;
                };

                typedef std::vector<OrderInfo> OrderInfos;

                /// Encapsulates price level concept.
                struct ONIXS_CBOECFE_PITCH_API PriceLevel
                {
                    /// Default initialization.
                    PriceLevel();

                    /// Initializes the instances according to specified attributes.
                    explicit
                    PriceLevel (const BinaryPrice& price,
                        Quantity quantity = 0,
                        Quantity numberOfOrders = 0,
                        Time unitTimestamp = 0,
                        Time timeOffset = 0,
                        const OrderInfos& orders = OrderInfos() );

#if defined(ONIXS_BATS_PITCH_COMPILER_CXX_RVALUE_REFERENCES) && ONIXS_BATS_PITCH_COMPILER_CXX_RVALUE_REFERENCES

                        PriceLevel(PriceLevel&&)
                        ONIXS_BATS_PITCH_NOTHROW;

                        PriceLevel&
                        operator=(PriceLevel&& other)
                        ONIXS_BATS_PITCH_NOTHROW;
#endif

#if defined(ONIXS_BATS_PITCH_COMPILER_CXX_DEFAULTED_FUNCTIONS) && ONIXS_BATS_PITCH_COMPILER_CXX_DEFAULTED_FUNCTIONS
                    PriceLevel(const PriceLevel&) = default;
#else
                    PriceLevel(const PriceLevel&);
#endif

                    PriceLevel&
                    operator=(const PriceLevel& other);

                    /// Price8 value.
                    const BinaryPrice& getPrice() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Updates price value.
                    void setPrice (const BinaryPrice& value)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Quantify for the given price.
                    Quantity quantity() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Updates quantity value.
                    void quantity (Quantity value)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Total number of orders of given price.
                    Quantity numberOfOrders() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Updates total number of orders.
                    void numberOfOrders (Quantity value)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Unit timestamp
                    Time unitTimestamp() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    ///
                    void unitTimestamp(Time)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Time offset of Unit timestamp
                    Time timeOffset() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    ///
                    void timeOffset(Time)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// Returns string representation of the instance.
                    std::string toString() const;

                    /// Appends representation of the instance to the string.
                    void toString (std::string&) const;

                    /// swap values
                    void swap (PriceLevel&)
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// returns list of order IDs for the price level
                    const OrderInfos& orders() const
                    ONIXS_BATS_PITCH_NOTHROW;

                    /// add OrderId to the list
                    void addOrderId(OrderId id, Quantity quantity);

                    /// remove OrderId from the list
                    void removeOrderId (OrderId id);

                    /// upate order by Id
                    void updateOrderId(OrderId id, Quantity quantity);

                private:
                    BinaryPrice price_;
                    Quantity qty_;
                    Quantity ordersQty_;
                    Time unitTimestamp_;
                    Time timeOffset_;
                    OrderInfos orders_;
                };

                /// compare
                bool operator== (const PriceLevel& l, const PriceLevel& r)
                ONIXS_BATS_PITCH_NOTHROW;

                /// Indicates whether the instance of PriceLevel is valid.
                bool isValid (const PriceLevel& level)
                ONIXS_BATS_PITCH_NOTHROW;

                /// Returns value of Price8
                const BinaryPrice& getPrice (const PriceLevel& level)
                ONIXS_BATS_PITCH_NOTHROW;

                ONIXS_CBOECFE_PITCH_API
                std::ostream& operator << (std::ostream& stream, const PriceLevel& value);


                /// Miscellaneous traits for PriceLevel class.
                struct ONIXS_CBOECFE_PITCH_API PriceLevelCollections
                {
                    /// Sequential collection of price levels.
                    typedef std::vector<PriceLevel> Array;

                    /// Mutable entry iterator.
                    typedef Array::iterator ArrayEntry;

                    /// Iterator for read-only access.
                    typedef Array::const_iterator ArrayConstEntry;
                };

                /// Sequence of price levels.
                typedef PriceLevelCollections::Array PriceLevels;

                /// Iterator to access price levels with write permissions.
                typedef PriceLevelCollections::ArrayEntry PriceLevelsEntry;

                /// Iterator over read-only collection of price levels.
                typedef PriceLevelCollections::ArrayConstEntry PriceLevelsConstEntry;

                /// Order Book.
                /// A set of bid prices and ask prices for the given
                /// security (bids are descending and asks are ascending).
                /// The quantity is provided at each price level.
                class ONIXS_CBOECFE_PITCH_API OrderBook
                {
                    public:
                        // Base initialization.
                        OrderBook ();

                        /// Destruction interface.
                        virtual ~OrderBook() {};

                        /// Symbol
                        StrRef symbol() const;

                        /// Indicates whether book has no bids & asks.
                        bool empty() const
                        ONIXS_BATS_PITCH_NOTHROW;

                        bool bestAsk (BinaryPrice& price, Quantity& quantity) const;

                        bool bestBid (BinaryPrice& price, Quantity& quantity) const;

                        /// String presentation of the book.
                        std::string toString() const;

                        /// String presentation of the book.
                        void toString (std::string&) const;

                        /// Returns brief book info.
                        std::string toShortString() const;

                        /// Appends brief book info to the string.
                        void toShortString (std::string&) const;

                        /// Returns formatted presentation of the book.
                        std::string toFormattedString() const;

                        /// Appends Formatted presentation of the book.
                        void toFormattedString (std::string&) const;

                        /// Returns a set of descending bid prices for the given security.
                        const PriceLevels& asks() const;

                        /// Returns a set of ascending ask prices for the given security.
                        const PriceLevels& bids() const;

                        /// Returns Last Message Seq Num Applied to the Book
                        UInt32 lastMessageSeqNumApplied() const;

                protected:
                    InstrumentId instrumentId() const;

                    private:
                        virtual const PriceLevels& doAsks() const = 0;
                        virtual const PriceLevels& doBids() const = 0;
                        virtual bool doBestAsk (BinaryPrice& price, Quantity& quantity) const = 0;
                        virtual bool doBestBid (BinaryPrice& price, Quantity& quantity) const = 0;
                        virtual InstrumentId doInstrumentID() const = 0;
                        virtual StrRef doSymbol() const = 0;
                        virtual UInt32 doLastMessageSeqNumApplied() const = 0;
                };

                inline const BinaryPrice& PriceLevel::getPrice() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return price_;
                }

                inline void PriceLevel::setPrice (const BinaryPrice& value)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    price_ = value;
                }

                inline Quantity PriceLevel::quantity() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return qty_;
                }

                inline void PriceLevel::quantity (Quantity value)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    qty_ = value;
                }

                inline Quantity PriceLevel::numberOfOrders() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return ordersQty_;
                }

                inline void PriceLevel::numberOfOrders (Quantity value)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    ordersQty_ = value;
                }

                inline const BinaryPrice& getPrice (const PriceLevel& level)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return level.getPrice();
                }

                inline bool isValid (const PriceLevel& level)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return (level.quantity() != 0);
                }

                inline Time PriceLevel::timeOffset() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return timeOffset_;
                }

                inline void PriceLevel::timeOffset(Time offset)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    timeOffset_ = offset;
                }

                inline Time PriceLevel::unitTimestamp() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return unitTimestamp_;
                }

                inline void PriceLevel::unitTimestamp(Time timestamp)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    unitTimestamp_ = timestamp;
                }

                inline bool operator== (const PriceLevel& l, const PriceLevel& r)
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return (l.quantity() == r.quantity() ) && (l.numberOfOrders() == r.numberOfOrders() ) && (l.getPrice() == r.getPrice() );
                }

                inline const PriceLevels& OrderBook::asks() const
                {
                    return doAsks();
                }

                inline const PriceLevels& OrderBook::bids() const
                {
                    return doBids();
                }

                inline bool OrderBook::bestAsk (BinaryPrice& price, Quantity& quantity ) const
                {
                    return doBestAsk (price, quantity);
                }

                inline bool OrderBook::bestBid (BinaryPrice& price, Quantity& quantity ) const
                {
                    return doBestBid (price, quantity);
                }

                inline InstrumentId OrderBook::instrumentId() const
                {
                    return doInstrumentID();
                }

                inline StrRef OrderBook::symbol() const
                {
                    return doSymbol();
                }

                inline bool OrderBook::empty() const
                ONIXS_BATS_PITCH_NOTHROW
                {
                    return bids().empty() && asks().empty();
                }

                inline UInt32 OrderBook::lastMessageSeqNumApplied() const
                {
                    return doLastMessageSeqNumApplied();
                }
            }
        }
    }
}