Dev Essential  1.6.3
Loading...
Searching...
No Matches
ddl::mapping::rt::TriggerBase Class Referenceabstract

base class representing a trigger More...

#include <trigger.h>

Inherited by ddl::mapping::rt::DataTrigger, ddl::mapping::rt::PeriodicTrigger, and ddl::mapping::rt::SignalTrigger.

Public Member Functions

virtual ~TriggerBase ()
 
virtual a_util::result::Result start ()=0
 
virtual a_util::result::Result stop ()=0
 
TargetSetgetTargetList ()
 
a_util::result::Result addTarget (Target *target)
 
a_util::result::Result removeTarget (Target *target)
 

Protected Attributes

TargetSet _targets
 nodoc
 

Detailed Description

base class representing a trigger

Constructor & Destructor Documentation

◆ ~TriggerBase()

virtual ddl::mapping::rt::TriggerBase::~TriggerBase ( )
virtual

Virtual DTOR

Member Function Documentation

◆ addTarget()

a_util::result::Result ddl::mapping::rt::TriggerBase::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 & ddl::mapping::rt::TriggerBase::getTargetList ( )

Getter for the list of registered targets

Returns
the list of targets

◆ removeTarget()

a_util::result::Result ddl::mapping::rt::TriggerBase::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 ddl::mapping::rt::TriggerBase::start ( )
pure virtual

Method to start trigger

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

Implemented in ddl::mapping::rt::DataTrigger, ddl::mapping::rt::PeriodicTrigger, and ddl::mapping::rt::SignalTrigger.

◆ stop()

virtual a_util::result::Result ddl::mapping::rt::TriggerBase::stop ( )
pure virtual

Method to stop trigger

Return values
a_util::result::SUCCESSEverything went fine

Implemented in ddl::mapping::rt::DataTrigger, ddl::mapping::rt::PeriodicTrigger, and ddl::mapping::rt::SignalTrigger.


The documentation for this class was generated from the following file: