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

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

#include <map_trigger.h>

Inherits ddl::mapping::MapTriggerBase.

Public Member Functions

 MapPeriodicTrigger (MapConfiguration *config)
 
double getPeriod () const
 
a_util::result::Result setPeriod (const std::string &period, const std::string &unit)
 
bool isEqual (const MapTriggerBase &other) const
 
- Public Member Functions inherited from ddl::mapping::MapTriggerBase
 MapTriggerBase (MapConfiguration *config)
 
virtual ~MapTriggerBase ()
 
bool isValid () const
 
virtual std::string getSourceDependency () const
 
bool checkValidity ()
 
a_util::result::Result checkTriggerReferences () const
 

Protected Member Functions

MapTriggerBaseclone () const
 

Detailed Description

implementation of a periodic trigger in the configuration api

Constructor & Destructor Documentation

◆ MapPeriodicTrigger()

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

CTOR

Parameters
[in]configThe configuration

Member Function Documentation

◆ clone()

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

Polymorphic clone method

Implements ddl::mapping::MapTriggerBase.

◆ getPeriod()

double ddl::mapping::MapPeriodicTrigger::getPeriod ( ) const

Returns the period of the trigger in ms

◆ isEqual()

bool ddl::mapping::MapPeriodicTrigger::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.

◆ setPeriod()

a_util::result::Result ddl::mapping::MapPeriodicTrigger::setPeriod ( const std::string & period,
const std::string & unit )

Set the period

Parameters
[in]periodThe period as integer
[in]unitThe unit ("us", "ms" or "s")

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