Enumerations.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/Integral.h>

#include <string>

namespace OnixS
{
    namespace CboeCFE
    {
        namespace MarketData
        {
            namespace Pitch
            {
                /// Order sides.
                struct SideIndicator
                {
                    /// Integral type used as basement for constants. 
                    typedef UInt8 Base;

                    enum Enum
                    {
                        Buy              = 'B',
                        Sell             = 'S',
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, SideIndicator::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(SideIndicator::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }

                struct UpdateAction
                {
                    /// Integral type used as basement for constants.
                    typedef UInt8 Base;

                    enum Enum
                    {
                        Add,
                        Delete,
                        Change
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, UpdateAction::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(UpdateAction::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }
                
                /// Trade Conditions
                struct TradeCondition
                {
                    /// Integral type used as basement for constants. 
                    typedef UInt8 Base;

                    enum Enum
                    {
                        NormalTrade = ' ',
                        OpeningTrade = 'O',
                        SpreadTrade = 'S',
                        BlockTrade = 'B',
                        EcrpTrade = 'E',
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, TradeCondition::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(TradeCondition::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }

                /// Listing states
                struct ListingState
                {
                    /// Integral type used as basement for constants. 
                    typedef UInt8 Base;

                    enum Enum
                    {
                        Active = 'A',
                        Inactive = 'I',
                        Test = 'T',
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, ListingState::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(ListingState::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }

                /// Trading Statuses
                struct TradingStatus
                {
                    /// Integral type used as basement for constants. 
                    typedef UInt8 Base;

                    enum Enum
                    {
                        Suspended = 'S',
                        Queuing = 'Q',
                        Trading = 'T',
                        Halted = 'H',
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, TradingStatus::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(TradingStatus::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }

                /// Issue Types
                struct Issue
                {
                    /// Integral type used as basement for constants. 
                    typedef UInt8 Base;

                    enum Enum
                    {
                        PeriodicIndicativeSettlement = 'i',
                        Initial = 'S',
                        Reissued = 'R',
                        IndicativeSettlement = 'I',
                    };
                };

                /// Appends string presentation of object.
                ONIXS_CBOECFE_PITCH_API void toStr(std::string&, Issue::Enum);

                /// Returns string presentation of object.
                inline std::string toStr(Issue::Enum layout)
                {
                    std::string str;

                    toStr(str, layout);

                    return str;
                }

            }
        }
    }
}