ADTF  3.18.2
MapSignalTrigger

implementation of a signal trigger in the configuration api More...

Inheritance diagram for MapSignalTrigger:
[legend]

Public Member Functions

 MapSignalTrigger (MapConfiguration *config)
 CTOR. More...
 
virtual std::string getSourceDependency () const
 Overrides MapTriggerBase.
 
const std::string & getVariable () const
 Returns the source signal.
 
a_util::result::Result setVariable (const std::string &signal_name)
 Set the source signal. More...
 
bool isEqual (const MapTriggerBase &other) const
 Polymorphic comparison method (impl. More...
 
- Public Member Functions inherited from MapTriggerBase
 MapTriggerBase (MapConfiguration *config)
 CTOR.
 
virtual ~MapTriggerBase ()
 DTOR.
 
bool isValid () const
 Returns the validity for the current description.
 
bool checkValidity ()
 Check Trigger validity and set validity flag. More...
 
a_util::result::Result checkTriggerReferences () const
 Checks the configuration for consistency of a new trigger. More...
 

Protected Member Functions

MapTriggerBaseclone () const
 Polymorphic clone method.
 

Private Member Functions

a_util::result::Result loadFromDom (const a_util::xml::DOMElement &dom_element)
 creates a trigger instance from a trigger-dom element More...
 
a_util::result::Result writeToDOM (a_util::xml::DOMElement &dom_element) const
 Export trigger to a XML dom element. More...
 
a_util::result::Result setVariableNoTypeCheck (const std::string &signal_name)
 Set the source signal. More...
 

Detailed Description

implementation of a signal trigger in the configuration api

Definition at line 168 of file map_trigger.h.

Constructor & Destructor Documentation

◆ MapSignalTrigger()

CTOR.

Parameters
[in]configThe configuration

Member Function Documentation

◆ isEqual()

bool isEqual ( const MapTriggerBase other) const
virtual

Polymorphic comparison method (impl.

from MapTriggerBase)

Parameters
[in]otherThe other instance
Returns
True if both are equal

Implements MapTriggerBase.

◆ loadFromDom()

a_util::result::Result loadFromDom ( const a_util::xml::DOMElement dom_element)
private

creates a trigger instance from a trigger-dom element

Parameters
[in]dom_elementThe dom element from which to import
Return values
ERR_INVALID_ARGMissing attribute
a_util::result::SUCCESSEverything went fine

◆ setVariable()

a_util::result::Result setVariable ( const std::string &  signal_name)

Set the source signal.

Parameters
[in]signal_nameThe source signal name
Return values
ERR_INVALID_ARGMissing attribute
a_util::result::SUCCESSEverything went fine

◆ setVariableNoTypeCheck()

a_util::result::Result setVariableNoTypeCheck ( const std::string &  signal_name)
private

Set the source signal.

Parameters
[in]signal_nameThe source signal name
Return values
ERR_INVALID_ARGMissing attribute
a_util::result::SUCCESSEverything went fine

◆ writeToDOM()

a_util::result::Result writeToDOM ( a_util::xml::DOMElement dom_element) const
private

Export trigger to a XML dom element.

Parameters
[in]dom_elementThe dom element from which to import
Return values
a_util::result::SUCCESSEverything went fine