MapTriggerBase

cMapTrigger forms a base class for a trigger contained in the configuration More...

Inheritance diagram for MapTriggerBase:

Public Member Functions
	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
virtual bool	isEqual (const MapTriggerBase &other) const =0
	Polymorphic comparison method.
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
virtual MapTriggerBase *	clone () const =0
	Polymorphic clone method.

Private Member Functions
a_util::result::Result	writeToDOM (a_util::xml::DOMElement &dom_element) const
	Export trigger to a XML dom element. More...
a_util::result::Result	setSourceDependency (const std::string &new_name)
	Change name for source signal. More...

Static Private Member Functions
static a_util::result::Result	createFromDOM (MapConfiguration *config, const a_util::xml::DOMElement &dom_element, MapTriggerBase *&destination)
	creates a polymorphic trigger instance from a trigger-dom element More...

Detailed Description

cMapTrigger forms a base class for a trigger contained in the configuration

Definition at line 29 of file map_trigger.h.

Member Function Documentation

checkTriggerReferences()

a_util::result::Result checkTriggerReferences

(

)

const

Checks the configuration for consistency of a new trigger.

Return values

ERR_INVALID_ARG	Reference not found in Configuration
a_util::result::SUCCESS	Everything went fine

checkValidity()

bool checkValidity

(

)

Check Trigger validity and set validity flag.

Return values

validity

flag

createFromDOM()

static a_util::result::Result createFromDOM ( MapConfiguration *  config, const a_util::xml::DOMElement &  dom_element, MapTriggerBase *&  destination  )

staticprivate

creates a polymorphic trigger instance from a trigger-dom element

Parameters

[in]	config	The configuration
[in]	dom_element	The dom element from which to import
[out]	destination	The Trigger object to fill

Return values

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

setSourceDependency()

a_util::result::Result setSourceDependency ( const std::string &  new_name )

private

Change name for source signal.

Parameters

[in]

new_name

The new name for the source signal

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