ddl::mapping::rt::PeriodicTrigger Class Reference

PeriodicTrigger implements a concrete periodic trigger in the runtime. More...

#include <periodic_trigger.h>

Inherits ddl::mapping::rt::TriggerBase, and ddl::mapping::rt::IPeriodicListener.

Public Member Functions
	PeriodicTrigger (IMappingEnvironment &env, const std::string &trigger_name, double period)
	~PeriodicTrigger ()
a_util::result::Result	create ()
a_util::result::Result	start ()
a_util::result::Result	stop ()
Public Member Functions inherited from ddl::mapping::rt::TriggerBase
virtual	~TriggerBase ()
TargetSet &	getTargetList ()
a_util::result::Result	addTarget (Target *target)
a_util::result::Result	removeTarget (Target *target)

Additional Inherited Members
Protected Attributes inherited from ddl::mapping::rt::TriggerBase
TargetSet	_targets
	nodoc

Detailed Description

PeriodicTrigger implements a concrete periodic trigger in the runtime.

Constructor & Destructor Documentation

PeriodicTrigger()

ddl::mapping::rt::PeriodicTrigger::PeriodicTrigger	(	IMappingEnvironment &	env,
		const std::string &	trigger_name,
		double	period )

CTOR

Parameters

[in]	env	The mapping environment
[in]	trigger_name	The name of the trigger
[in]	period	The period of the trigger

~PeriodicTrigger()

ddl::mapping::rt::PeriodicTrigger::~PeriodicTrigger

(

)

DTOR

Member Function Documentation

create()

a_util::result::Result ddl::mapping::rt::PeriodicTrigger::create

(

)

Creates and initializes the periodic trigger

start()

a_util::result::Result ddl::mapping::rt::PeriodicTrigger::start ( )

virtual

Method to start trigger

Return values

a_util::result::SUCCESS	Everything went fine
ERR_FAILED	Error during runtime

Implements ddl::mapping::rt::TriggerBase.

stop()

a_util::result::Result ddl::mapping::rt::PeriodicTrigger::stop ( )

virtual

Method to stop trigger

Return values

a_util::result::SUCCESS

Everything went fine

Implements ddl::mapping::rt::TriggerBase.

---

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

• include/ddl/mapping/legacy/engine/periodic_trigger.h