stmm-input-doc  0.17.0
Public Member Functions | Protected Member Functions | List of all members
stmi::CallIf Class Referenceabstract

Base class used to determine whether to send an event to a listener. More...

Inheritance diagram for stmi::CallIf:
Inheritance graph
[legend]

Public Member Functions

virtual ~CallIf () noexcept=default
 
virtual bool operator() (const shared_ptr< const Event > &refEvent) const noexcept=0
 Function that determines whether an event should be sent to a listener. More...
 

Protected Member Functions

 CallIf () noexcept
 

Detailed Description

Base class used to determine whether to send an event to a listener.

See also
DeviceManager::addEventListener(const shared_ptr<EventListener>&, const shared_ptr<CallIf>&)

Constructor & Destructor Documentation

◆ ~CallIf()

virtual stmi::CallIf::~CallIf ( )
virtualdefaultnoexcept

◆ CallIf()

stmi::CallIf::CallIf ( )
inlineprotectednoexcept

Member Function Documentation

◆ operator()()

virtual bool stmi::CallIf::operator() ( const shared_ptr< const Event > &  refEvent) const
pure virtualnoexcept

Function that determines whether an event should be sent to a listener.

Parameters
refEventThe event. Cannot be null.
Returns
true if the event is to be sent to the listener, false otherwise.

Implemented in stmi::CallIfFuction, stmi::CallIfXYEvent, stmi::CallIfEventClass, stmi::CallIfDeviceManagerCapability, stmi::CallIfCapabilityClass, stmi::CallIfCapabilityId, stmi::CallIfDeviceId, stmi::CallIfAccessor, stmi::CallIfNot, stmi::CallIfOr, stmi::CallIfAnd, stmi::CallIfFalse, and stmi::CallIfTrue.