PeriodicTrigger

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

Inheritance diagram for PeriodicTrigger:

Public Member Functions
	PeriodicTrigger (IMappingEnvironment &env, const std::string &trigger_name, double period)
	CTOR. More...
	~PeriodicTrigger ()
	DTOR.
a_util::result::Result	create ()
	Creates and initializes the periodic trigger.
a_util::result::Result	start ()
	Method to start trigger. More...
a_util::result::Result	stop ()
	Method to stop trigger. More...
Public Member Functions inherited from TriggerBase
virtual	~TriggerBase ()
	Virtual DTOR.
TargetSet &	getTargetList ()
	Getter for the list of registered targets. More...
a_util::result::Result	addTarget (Target *target)
	Method to register a new target. More...
a_util::result::Result	removeTarget (Target *target)
	Method to deregister a target. More...

Additional Inherited Members
Protected Attributes inherited from TriggerBase
TargetSet	_targets
	nodoc
Private Member Functions inherited from IPeriodicListener
virtual	~IPeriodicListener ()
	DTOR.
virtual void	onTimer (timestamp_t now)=0
	onTimer is to be called by the mapping environment periodically. More...

Detailed Description

PeriodicTrigger implements a concrete periodic trigger in the runtime.

Definition at line 24 of file periodic_trigger.h.

Constructor & Destructor Documentation

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

Member Function Documentation

start()

a_util::result::Result start ( )

virtual

Method to start trigger.

Return values

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

Implements TriggerBase.

stop()

a_util::result::Result stop ( )

virtual

Method to stop trigger.

Return values

a_util::result::SUCCESS

Everything went fine

Implements TriggerBase.