OnixS C++ CME MDP Premium Market Data Handler 5.11.1
Users' manual and API documentation
Loading...
Searching...
No Matches
FixedDepthBookManagement< BboTracking, Depth > Class Template Reference

#include <OnixS/CME/MDH/BookManagement.h>

Public Member Functions

 FixedDepthBookManagement (const SettingGroup *group=nullptr, Depth defaultDepth=0)
 FixedDepthBookManagement (const FixedDepthBookManagement &other)
 ~FixedDepthBookManagement ()=default
Depth defaultDepth () const
FixedDepthBookManagement & defaultDepth (Depth value)
FixedDepthBookManagement & operator= (const FixedDepthBookManagement &other)
Public Member Functions inherited from BaseBookManagement< BboTracking >
 BaseBookManagement (const SettingGroup *group=nullptr)
 BaseBookManagement (const BaseBookManagement &other)
 ~BaseBookManagement ()=default
bool maintain () const noexcept
BaseBookManagement & maintain (bool value)
const BboTracking & bboTracking () const noexcept
BboTracking & bboTracking () noexcept
BaseBookManagement & operator= (const BaseBookManagement &other)

Friends

class BookManagement

Additional Inherited Members

Protected Member Functions inherited from BaseBookManagement< BboTracking >
const SettingGroup & group () const
void assignNoControl (const BaseBookManagement &other)

Detailed Description

template<class BboTracking, typename Depth>
class OnixS::CME::MDH::FixedDepthBookManagement< BboTracking, Depth >
Template Parameters
BboTrackingBBO tracking settings type used by this book type.
DepthType used to store the book depth.

Definition at line 724 of file BookManagement.h.

Constructor & Destructor Documentation

◆ FixedDepthBookManagement() [1/2]

template<class BboTracking, typename Depth>
FixedDepthBookManagement ( const SettingGroup * group = nullptr,
Depth defaultDepth = 0 )
inline

Initializes fixed-depth book management settings.

Parameters
groupOptional settings group used to validate and control assignments.
defaultDepthDefault depth used when security-specific depth is unavailable.

Definition at line 733 of file BookManagement.h.

◆ FixedDepthBookManagement() [2/2]

template<class BboTracking, typename Depth>
FixedDepthBookManagement ( const FixedDepthBookManagement< BboTracking, Depth > & other)
inline

Copies fixed-depth book-management settings from another instance.

Parameters
otherSource settings.
Note
Assignment-control state is not copied; only setting values are copied.

Definition at line 744 of file BookManagement.h.

◆ ~FixedDepthBookManagement()

template<class BboTracking, typename Depth>
~FixedDepthBookManagement ( )
default

Finalizes the fixed-depth book-management settings.

Member Function Documentation

◆ defaultDepth() [1/2]

template<class BboTracking, typename Depth>
Depth defaultDepth ( ) const
inline

Returns the fallback depth for fixed-depth books.

The fallback is used when a security definition has not been received or does not contain corresponding depth data.

Returns
Default book depth.

Definition at line 760 of file BookManagement.h.

◆ defaultDepth() [2/2]

template<class BboTracking, typename Depth>
FixedDepthBookManagement & defaultDepth ( Depth value)
inline

Sets the fallback depth for fixed-depth books.

Parameters
valueDefault book depth to use when security-specific depth is unavailable.
Returns
Reference to this object.
Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 772 of file BookManagement.h.

◆ operator=()

template<class BboTracking, typename Depth>
FixedDepthBookManagement & operator= ( const FixedDepthBookManagement< BboTracking, Depth > & other)
inline

Copies fixed-depth book-management settings from another instance.

Parameters
otherSource settings.
Returns
Reference to this object.
Note
Assignment-control state is not copied; only setting values are copied.
Exceptions
std::runtime_errorIf the setting belongs to a handler that is processing market data or being configured from another source.

Definition at line 787 of file BookManagement.h.

◆ BookManagement

template<class BboTracking, typename Depth>
friend class BookManagement
friend

Definition at line 798 of file BookManagement.h.