This is a triggering device that can provide your activity with user-controlled, periodic triggering. More...

#include <PeriodicAlarm.hxx>

Inheritance diagram for dueca::PeriodicAlarm:

[legend]

Collaboration diagram for dueca::PeriodicAlarm:

[legend]

Public Member Functions
	PeriodicAlarm (const TimeSpec &ts)
	Constructor.

	PeriodicAlarm ()
	Constructor without parameters.

	~PeriodicAlarm ()
	Destructor.

void	changePeriod (TimeTickType interval)
	Set the requested period.

void	changePeriodAndOffset (const TimeSpec &ts)
	Set the requested period and an offset from a time specification.

const std::string &	getTargetName () const
	get the name of the target

Public Member Functions inherited from dueca::TargetAndPuller
void	addTerm (TriggerPuller &p)
	Add another puller to this (and, or) combination of triggers.

void	addTerm (const boost::intrusive_ptr< TargetAndPuller > &p)
	Add another puller to this combination.

bool	removeTerm (TriggerPuller &p)
	Remove a term from this TriggerAnd or TriggerOr object.

Public Member Functions inherited from dueca::TriggerPuller
const std::string &	getTriggerName () const
	Find a name.

Additional Inherited Members
Protected Types inherited from dueca::TriggerPuller
typedef list< TargetData >	targetlist_type
	Combination of a target, someone to pull if requested, and the index that target needs to identify this puller.

Protected Member Functions inherited from dueca::TargetAndPuller
	TargetAndPuller (const std::string &name=std::string())
	Constructor.

virtual	~TargetAndPuller ()
	Destructor.

Protected Member Functions inherited from dueca::TriggerPuller
void	pull (const DataTimeSpec &ts)
	activate and notify the targets

	TriggerPuller (const std::string &name=std::string())
	Constructor.

virtual	~TriggerPuller ()
	Destructor.

virtual void	addTarget (const boost::intrusive_ptr< TriggerTarget > &target, unsigned id)
	Add a target to this puller, only called by TriggerTarget's setTrigger.

virtual void	removeTarget (const TriggerTarget *target)
	Remove a target from the puller, only called by destructor.

virtual void	setTriggerName ()
	Update the name, used by ConditionAnd and ConditionOr.

Protected Attributes inherited from dueca::TargetAndPuller
unsigned	name_psize
	Number of pullers when name calculated.

Protected Attributes inherited from dueca::TriggerPuller
targetlist_type	targets
	List of targets and indices.

std::bitset< MAX_MANAGERS >	activitylevels
	Index of activitymanager levels.

std::string	name
	Name, for debugging purposes.

Detailed Description

This is a triggering device that can provide your activity with user-controlled, periodic triggering.

Create a periodic alarm, e.g. as one of the objects in your module class.

Triggering will take place at the intervals specified for the alarm. Trigger period can be changed.

Constructor & Destructor Documentation

dueca::PeriodicAlarm::PeriodicAlarm ( const TimeSpec & ts )

Constructor.

Parameters

ts	Time specification for the alarm.

dueca::PeriodicAlarm::PeriodicAlarm ( )

Constructor without parameters.

This produces an alarm that triggers at the time steps of the default clock. See your dueca.cnf file for that value.

void dueca::PeriodicAlarm::changePeriod ( TimeTickType interval )

Set the requested period.

The current period is maintained for one more activation, after this the new period is used.

void dueca::PeriodicAlarm::changePeriodAndOffset ( const TimeSpec & ts )

Set the requested period and an offset from a time specification.

The current period is maintained for one more activation, after this the new period is used.

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