MapPeriodicTrigger

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

Inheritance diagram for MapPeriodicTrigger:

Public Member Functions
	MapPeriodicTrigger (MapConfiguration *config)
	CTOR. More...
double	getPeriod () const
	Returns the period of the trigger in ms.
a_util::result::Result	setPeriod (const std::string &period, const std::string &unit)
	Set the period. More...
bool	isEqual (const MapTriggerBase &other) const
	Polymorphic comparison method (impl. More...
Public Member Functions inherited from MapTriggerBase
	MapTriggerBase (MapConfiguration *config)
	CTOR.
virtual	~MapTriggerBase ()
	DTOR.
bool	isValid () const
	Returns the validity for the current description.
virtual std::string	getSourceDependency () const
	returns an optional dependency on a source name
bool	checkValidity ()
	Check Trigger validity and set validity flag. More...
a_util::result::Result	checkTriggerReferences () const
	Checks the configuration for consistency of a new trigger. More...

Protected Member Functions
MapTriggerBase *	clone () const
	Polymorphic clone method.

Private Member Functions
a_util::result::Result	loadFromDom (const a_util::xml::DOMElement &dom_element)
	creates a trigger instance from a trigger-dom element More...
a_util::result::Result	writeToDOM (a_util::xml::DOMElement &dom_element) const
	Export trigger to a XML dom element. More...

Detailed Description

implementation of a periodic trigger in the configuration api

Definition at line 112 of file map_trigger.h.

Constructor & Destructor Documentation

MapPeriodicTrigger()

MapPeriodicTrigger

(

MapConfiguration *

config

)

CTOR.

Parameters

[in]

config

The configuration

Member Function Documentation

isEqual()

bool isEqual ( const MapTriggerBase &  other ) const

virtual

Polymorphic comparison method (impl.

from MapTriggerBase)

Parameters

[in]

other

The other instance

Returns

True if both are equal

Implements MapTriggerBase.

loadFromDom()

a_util::result::Result loadFromDom ( const a_util::xml::DOMElement &  dom_element )

private

creates a trigger instance from a trigger-dom element

Parameters

[in]

dom_element

The dom element from which to import

Return values

ERR_INVALID_ARG	Missing attribute
a_util::result::SUCCESS	Everything went fine

setPeriod()

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

Set the period.

Parameters

[in]	period	The period as integer
[in]	unit	The unit ("us", "ms" or "s")

writeToDOM()

a_util::result::Result writeToDOM ( a_util::xml::DOMElement &  dom_element ) const

private

Export trigger to a XML dom element.

Parameters

[in]

dom_element

The dom element from which to import

Return values

a_util::result::SUCCESS

Everything went fine