Dev Essential
Loading...
Searching...
No Matches
ddl::mapping::MapDataTrigger Class Reference

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

#include <map_trigger.h>

Inherits ddl::mapping::MapTriggerBase.

Public Member Functions

 MapDataTrigger (MapConfiguration *config)
 
virtual std::string getSourceDependency () const
 
const std::string & getVariable () const
 
const std::string & getSource () const
 
const std::string & getOperator () const
 
double getValue () const
 
a_util::result::Result setComparison (const std::string &source_element_path, const std::string &comp_operator, const std::string &value)
 
bool isEqual (const MapTriggerBase &other) const
 
- Public Member Functions inherited from ddl::mapping::MapTriggerBase
 MapTriggerBase (MapConfiguration *config)
 
virtual ~MapTriggerBase ()
 
bool isValid () const
 
bool checkValidity ()
 
a_util::result::Result checkTriggerReferences () const
 

Protected Member Functions

MapTriggerBaseclone () const
 

Detailed Description

implementation of a data trigger in the configuration api

Constructor & Destructor Documentation

◆ MapDataTrigger()

ddl::mapping::MapDataTrigger::MapDataTrigger ( MapConfiguration * config)

CTOR

Parameters
[in]configThe configuration

Member Function Documentation

◆ clone()

MapTriggerBase * ddl::mapping::MapDataTrigger::clone ( ) const
protectedvirtual

Polymorphic clone method

Implements ddl::mapping::MapTriggerBase.

◆ getOperator()

const std::string & ddl::mapping::MapDataTrigger::getOperator ( ) const

Returns the operator for the comparison

◆ getSource()

const std::string & ddl::mapping::MapDataTrigger::getSource ( ) const

Returns the source signal

◆ getSourceDependency()

virtual std::string ddl::mapping::MapDataTrigger::getSourceDependency ( ) const
virtual

Overrides MapTriggerBase

Returns
the source dependency name

Reimplemented from ddl::mapping::MapTriggerBase.

◆ getValue()

double ddl::mapping::MapDataTrigger::getValue ( ) const

Returns the value to compare to

◆ getVariable()

const std::string & ddl::mapping::MapDataTrigger::getVariable ( ) const

Returns the variable to compare

Returns
the variable name

◆ isEqual()

bool ddl::mapping::MapDataTrigger::isEqual ( const MapTriggerBase & other) const
virtual

Polymorphic comparison method (impl. from MapTriggerBase)

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

Implements ddl::mapping::MapTriggerBase.

◆ setComparison()

a_util::result::Result ddl::mapping::MapDataTrigger::setComparison ( const std::string & source_element_path,
const std::string & comp_operator,
const std::string & value )

Set the comparison

Parameters
[in]source_element_pathThe path to the element ([SourceSignal].[Element])
[in]comp_operatorThe operator for the comparison
[in]valueThe value to compare to
Return values
ERR_INVALID_ARGMissing attribute
ERR_INVALID_TYPEDefinition is inconsistent with ddl
a_util::result::SUCCESSEverything went fine

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