EventFlagsMask Class Reference

The event flags' mask (a set of bit flags) More...

#include <EventFlag.hpp>

Public Member Functions
	EventFlagsMask () noexcept
	Creates an empty event flags mask.
template<Integral MaskType>
	EventFlagsMask (MaskType mask) noexcept
	Create event flags mask by integer value.
template<typename EventFlagIt>
	EventFlagsMask (EventFlagIt begin, EventFlagIt end) noexcept
	Creates event flags mask by iterators of container with flags.
	EventFlagsMask (std::initializer_list< EventFlag > eventFlags) noexcept
	Creates event flags mask by initializer list with flags.
constexpr std::uint32_t	getMask () const noexcept
	Returns an integer representation of event mask.
bool	contains (const EventFlag &flag) const noexcept

Friends
EventFlagsMask	operator| (const EventFlagsMask &eventFlagsMask, const EventFlag &eventFlag) noexcept
	Performs a bit or operation with an event flags' mask and an event flag.
EventFlagsMask	operator& (const EventFlagsMask &eventFlagsMask, const EventFlag &eventFlag) noexcept
	Performs a bit and operation with an event flags' mask and an event flag.

Detailed Description

The event flags' mask (a set of bit flags)

Constructor & Destructor Documentation

EventFlagsMask() [1/3]

template<Integral MaskType>

EventFlagsMask::EventFlagsMask ( MaskType mask )

inlineexplicitnoexcept

Create event flags mask by integer value.

Template Parameters

MaskType

The type of integer mask

Parameters

mask	The integer mask value

EventFlagsMask() [2/3]

template<typename EventFlagIt>

EventFlagsMask::EventFlagsMask ( EventFlagIt begin, EventFlagIt end )

inlinenoexcept

Creates event flags mask by iterators of container with flags.

Template Parameters

EventFlagIt

The iterator type

Parameters

begin	The start position
end	The end position

References EventFlag::getFlag().

EventFlagsMask() [3/3]

EventFlagsMask::EventFlagsMask ( std::initializer_list< EventFlag > eventFlags )

inlinenoexcept

Creates event flags mask by initializer list with flags.

Parameters

eventFlags

The list with flags

Member Function Documentation

contains()

bool EventFlagsMask::contains ( const EventFlag & flag ) const

inlinenoexcept

Parameters

flag	The flag to check.

Returns

true if this mask contains the flag.

References EventFlag::getFlag().

getMask()

std::uint32_t EventFlagsMask::getMask ( ) const

inlineconstexprnoexcept

Returns an integer representation of event mask.

Returns

an integer representation

Referenced by Candle::setEventFlags(), Greeks::setEventFlags(), OrderBase::setEventFlags(), Series::setEventFlags(), TheoPrice::setEventFlags(), and Underlying::setEventFlags().

Friends And Related Symbol Documentation

operator&

EventFlagsMask operator& ( const EventFlagsMask & eventFlagsMask, const EventFlag & eventFlag )

friend

Performs a bit and operation with an event flags' mask and an event flag.

Parameters

eventFlagsMask	The event flags' mask
eventFlag	The event flag

Returns

The result (event flags' mask)

References EventFlag::getFlag().

operator|

EventFlagsMask operator| ( const EventFlagsMask & eventFlagsMask, const EventFlag & eventFlag )

friend

Performs a bit or operation with an event flags' mask and an event flag.

Parameters

eventFlagsMask	The event flags' mask
eventFlag	The event flag

Returns

The result (event flags' mask)

References EventFlag::getFlag().