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

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

Public Member Functions

 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)

Protected Member Functions

const SettingGroup & group () const
void assignNoControl (const BaseBookManagement &other)

Friends

class BookManagement

Detailed Description

template<class BboTracking>
class OnixS::CME::MDH::BaseBookManagement< BboTracking >
Template Parameters
BboTrackingBBO tracking settings type used by this book type.

Definition at line 602 of file BookManagement.h.

Constructor & Destructor Documentation

◆ BaseBookManagement() [1/2]

template<class BboTracking>
BaseBookManagement ( const SettingGroup * group = nullptr)
inline

Initializes book management with maintenance disabled.

Parameters
groupOptional settings group used to validate and control assignments.

Definition at line 609 of file BookManagement.h.

◆ BaseBookManagement() [2/2]

template<class BboTracking>
BaseBookManagement ( const BaseBookManagement< BboTracking > & other)
inline

Copies book-management settings from another instance.

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

Definition at line 620 of file BookManagement.h.

◆ ~BaseBookManagement()

template<class BboTracking>
~BaseBookManagement ( )
default

Finalizes the book-management settings.

Member Function Documentation

◆ assignNoControl()

template<class BboTracking>
void assignNoControl ( const BaseBookManagement< BboTracking > & other)
inlineprotected

Re-initializes as a copy of the other instance without involving value assignment control services.

Definition at line 704 of file BookManagement.h.

◆ bboTracking() [1/2]

template<class BboTracking>
const BboTracking & bboTracking ( ) const
inlinenoexcept

Returns read-only BBO tracking settings for this book type.

Returns
BBO tracking settings.

Definition at line 660 of file BookManagement.h.

◆ bboTracking() [2/2]

template<class BboTracking>
BboTracking & bboTracking ( )
inlinenoexcept

Returns mutable BBO tracking settings for this book type.

Returns
BBO tracking settings.

Definition at line 669 of file BookManagement.h.

◆ group()

template<class BboTracking>
const SettingGroup & group ( ) const
inlineprotected

Instance of the group of setting which the given set of settings belongs to.

Definition at line 697 of file BookManagement.h.

◆ maintain() [1/2]

template<class BboTracking>
bool maintain ( ) const
inlinenoexcept

Indicates whether the Handler maintains this book type.

When false, the Handler does not construct this book type and does not process data blocks that are needed only for that book type. Book snapshots are unavailable for book types that are not maintained.

Returns
True when this book type is maintained.
Note
Default value is false.

Definition at line 638 of file BookManagement.h.

◆ maintain() [2/2]

template<class BboTracking>
BaseBookManagement & maintain ( bool value)
inline

Enables or disables maintenance of this book type.

Parameters
valueTrue to maintain this book type.
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 649 of file BookManagement.h.

◆ operator=()

template<class BboTracking>
BaseBookManagement & operator= ( const BaseBookManagement< BboTracking > & other)
inline

Copies 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 682 of file BookManagement.h.

◆ BookManagement

template<class BboTracking>
friend class BookManagement
friend

Lets grouping and value assignment control functioning.

Definition at line 692 of file BookManagement.h.