iox::popo::UserTrigger🔗

An event based trigger which can be used by the application developer directly. If you would like to trigger a WaitSet/Listener through an event of your class you should use the Trigger class. #include <iceoryx_posh/popo/user_trigger.hpp>

Public Functions🔗

	Name
	UserTrigger()
	UserTrigger(const UserTrigger & rhs)
	UserTrigger(UserTrigger && rhs)
UserTrigger &	operator=(const UserTrigger & rhs)
UserTrigger &	operator=(UserTrigger && rhs)
void	trigger() If it is attached it will trigger otherwise it will do nothing.
bool	hasTriggered() const Checks if the UserTrigger was triggered.

Friends🔗

	Name
class	NotificationAttorney

Public Functions Documentation🔗

function UserTrigger🔗

UserTrigger()

function UserTrigger🔗

UserTrigger(
    const UserTrigger & rhs
)

function UserTrigger🔗

UserTrigger(
    UserTrigger && rhs
)

function operator=🔗

UserTrigger & operator=(
    const UserTrigger & rhs
)

function operator=🔗

UserTrigger & operator=(
    UserTrigger && rhs
)

function trigger🔗

void trigger()

If it is attached it will trigger otherwise it will do nothing.

Note: a user trigger cannot be triggered when it is not attached

function hasTriggered🔗

bool hasTriggered() const

Checks if the UserTrigger was triggered.

Return: true if the UserTrigger is trigger, otherwise false.

Note: The hasTrigger state will be reset after it was handled by a WaitSet/Listener

Friends🔗

friend NotificationAttorney🔗

friend class NotificationAttorney;

Updated on 18 December 2023 at 13:11:43 CET