Delegate classes

Collection of delegates serving as interface between messages and their receivers.

Classes

	Name
struct	allpix::DelegateTypes Container of the different delegate types.
class	allpix::BaseDelegate Base for all delegates.
class	allpix::ModuleDelegate Base for all delegates operating on modules.
class	allpix::StoreDelegate Delegate to store the message in memory for fetching the history.
class	allpix::FilterDelegate Delegate for filtering messages using a function.
class	allpix::FilterAllDelegate Delegate for invoking a filter listening to all messages also getting the name.
class	allpix::SingleBindDelegate Delegate for binding a single message.
class	allpix::VectorBindDelegate Delegate for binding multiple message to a vector.

Types

	Name
enum class uint32_t	MsgFlags { NONE = 0, REQUIRED = (1 « 0), ALLOW_OVERWRITE = (1 « 1), IGNORE_NAME = (1 « 2), UNNAMED_ONLY = (1 « 3)} Flags to change the behaviour of delegates.

Functions

	Name
MsgFlags	**[operator
MsgFlags	operator&(MsgFlags f1, MsgFlags f2) Give the set of flags present in both sets of message flags.

Types Documentation

enum MsgFlags

Enumerator	Value	Description
NONE	0	No enabled flags.
REQUIRED	(1 « 0)	Require a message before running a module.
ALLOW_OVERWRITE	(1 « 1)	Allow overwriting a previous message.
IGNORE_NAME	(1 « 2)	Listen to all ignoring message name (equal to * as a input configuration parameter)
UNNAMED_ONLY	(1 « 3)	Listen to all messages without explicit name (equal to ? as configuration parameter)

Flags to change the behaviour of delegates.

All flags are distinct and can be combined using the | (OR) operator. The flags should be passed to the Messenger when registering a filter or when binding either a single or multiple messages. It depends on the delegate which combination of flags is valid.

Functions Documentation

function operator|

inline MsgFlags operator|(
    MsgFlags f1,
    MsgFlags f2
)

Combine two sets of message flags.

Parameters:

• f1 First set of flag
• f2 Second set of flag

Return: New set of flag representing the combination of the two given sets

function operator&

inline MsgFlags operator&(
    MsgFlags f1,
    MsgFlags f2
)

Give the set of flags present in both sets of message flags.

Parameters:

• f1 First flag
• f2 Second flag

Return: New flag representing the flags present in both sets of flags

---

Updated on 2024-12-13 at 08:31:37 +0000