ADTF  3.18.2
TriggerBaseabstract

base class representing a trigger More...

Inheritance diagram for TriggerBase:
[legend]

Public Member Functions

virtual ~TriggerBase ()
 Virtual DTOR.
 
virtual a_util::result::Result start ()=0
 Method to start trigger. More...
 
virtual a_util::result::Result stop ()=0
 Method to stop trigger. More...
 
TargetSetgetTargetList ()
 Getter for the list of registered targets. More...
 
a_util::result::Result addTarget (Target *target)
 Method to register a new target. More...
 
a_util::result::Result removeTarget (Target *target)
 Method to deregister a target. More...
 

Protected Attributes

TargetSet _targets
 nodoc
 

Detailed Description

base class representing a trigger

Definition at line 24 of file trigger.h.

Member Function Documentation

◆ addTarget()

a_util::result::Result addTarget ( Target target)

Method to register a new target.

Parameters
[in]targetThe target to add
Return values
a_util::result::SUCCESSEverything went fine

◆ getTargetList()

TargetSet& getTargetList ( )

Getter for the list of registered targets.

Returns
the list of targets

◆ removeTarget()

a_util::result::Result removeTarget ( Target target)

Method to deregister a target.

Parameters
[in]targetThe target to remove
Return values
a_util::result::SUCCESSEverything went fine

◆ start()

virtual a_util::result::Result start ( )
pure virtual

Method to start trigger.

Return values
a_util::result::SUCCESSEverything went fine
ERR_FAILEDError during runtime

Implemented in SignalTrigger, PeriodicTrigger, and DataTrigger.

◆ stop()

virtual a_util::result::Result stop ( )
pure virtual

Method to stop trigger.

Return values
a_util::result::SUCCESSEverything went fine

Implemented in SignalTrigger, PeriodicTrigger, and DataTrigger.