OnixS C++ CME MDP Premium Market Data Handler 5.11.1
Users' manual and API documentation
Loading...
Searching...
No Matches
ImpliedBboTracking Class Reference

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

Public Member Functions

 ImpliedBboTracking (const SettingGroup *group=nullptr)
 ImpliedBboTracking (const ImpliedBboTracking &other)
 ~ImpliedBboTracking ()=default
const BboThreshold & price () const noexcept
BboThreshold & price () noexcept
const BboThreshold & quantity () const noexcept
BboThreshold & quantity () noexcept
bool enabled () const noexcept
bool exceeded (const ImpliedPriceLevel &previous, const ImpliedPriceLevel &current) const
ImpliedBboTracking & operator= (const ImpliedBboTracking &other)

Protected Member Functions

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

Friends

template<class>
class BaseBookManagement

Detailed Description

Definition at line 325 of file BookManagement.h.

Constructor & Destructor Documentation

◆ ImpliedBboTracking() [1/2]

ImpliedBboTracking ( const SettingGroup * group = nullptr)
inline

Initializes disabled implied-book BBO tracking.

Parameters
groupOptional settings group used to validate and control assignments.

Definition at line 332 of file BookManagement.h.

◆ ImpliedBboTracking() [2/2]

ImpliedBboTracking ( const ImpliedBboTracking & other)
inline

Copies implied-book BBO tracking settings from another instance.

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

Definition at line 343 of file BookManagement.h.

◆ ~ImpliedBboTracking()

~ImpliedBboTracking ( )
default

Finalizes the tracking settings.

Member Function Documentation

◆ assignNoControl()

void assignNoControl ( const ImpliedBboTracking & other)
inlineprotected

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

Definition at line 442 of file BookManagement.h.

◆ enabled()

bool enabled ( ) const
inlinenoexcept

Indicates whether any implied-book BBO threshold is enabled.

Returns
True when price or quantity tracking is enabled.

Definition at line 392 of file BookManagement.h.

◆ exceeded()

bool exceeded ( const ImpliedPriceLevel & previous,
const ImpliedPriceLevel & current ) const
inline

Checks whether the configured implied-book thresholds are exceeded.

Parameters
previousPrevious best price level.
currentCurrent best price level.
Returns
True when an enabled threshold is exceeded.

Definition at line 403 of file BookManagement.h.

◆ group()

const SettingGroup & group ( ) const
inlineprotected

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

Definition at line 435 of file BookManagement.h.

◆ operator=()

ImpliedBboTracking & operator= ( const ImpliedBboTracking & other)
inline

Copies implied-book BBO tracking 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 420 of file BookManagement.h.

◆ price() [1/2]

const BboThreshold & price ( ) const
inlinenoexcept

Returns read-only price tracking settings.

Returns
Price threshold settings.

Definition at line 356 of file BookManagement.h.

◆ price() [2/2]

BboThreshold & price ( )
inlinenoexcept

Returns mutable price tracking settings.

Returns
Price threshold settings.

Definition at line 365 of file BookManagement.h.

◆ quantity() [1/2]

const BboThreshold & quantity ( ) const
inlinenoexcept

Returns read-only quantity tracking settings.

Returns
Quantity threshold settings.

Definition at line 374 of file BookManagement.h.

◆ quantity() [2/2]

BboThreshold & quantity ( )
inlinenoexcept

Returns mutable quantity tracking settings.

Returns
Quantity threshold settings.

Definition at line 383 of file BookManagement.h.

◆ BaseBookManagement

template<class>
friend class BaseBookManagement
friend

Lets grouping and value assignment control functioning.

Definition at line 430 of file BookManagement.h.