Used to handle and store all Timer-Event-specific Information which comes from the Instantiation-File. More...

#include <TimerEventElementImpl.h>

Inheritance diagram for fesa::TimerEventElementImpl:

Public Member Functions
	TimerEventElementImpl (const std::string &className, const std::string &logicalEventName, const std::string &xpath, boost::shared_ptr< ElementXML > eventElement)
	constructor More...

const std::string &	getSourceTypeSpecificData (const std::string &dataTag)
	returns data as string. If dataTag is not found, an exception is thrown More...

const uint64_t	getPeriod () const

Public Member Functions inherited from fesa::EventElementImpl
const std::string &	getLogicalName () const
	Returns the logical event name which is used for this concrete-event. More...

const std::string &	getEventSourceName () const
	Returns the name of the event-source which will fire this concrete event. More...

const EventSourceType &	getEventSourceType () const
	Returns the type of the event-source which will fire this concrete event. More...

const std::string &	getConcreteName () const
	Returns the name of the concrete-event. More...

const std::string &	getClassName () const
	Returns the name of the class which will manage this concrete event. More...

std::vector< std::string >	getDeviceCollection () const
	Returns all devices which are connected to this concrete event. More...

void	addDeviceRef (const std::string &deviceName)
	used in order to add references of the connected devices to this object (according to the mapping in the xml-file) More...

Additional Inherited Members
Protected Member Functions inherited from fesa::EventElementImpl
	EventElementImpl (const std::string &className, const std::string &logicalEventName, const EventSourceType sourceType, const std::string &xpath, boost::shared_ptr< ElementXML > eventElement)

Protected Attributes inherited from fesa::EventElementImpl
std::string	eventSourceName_
	name of the event-source to which this object belongs. Filled by the child-class

std::string	concreteEventName_
	The concrete event-name is build of the event-source-name and a string to make the name unique Filled by the child-class.

std::string	className_
	name of the class which owns this EventElement

std::string	logicalEventName_
	name of the logical event which owns this EventElement

Detailed Description

Used to handle and store all Timer-Event-specific Information which comes from the Instantiation-File.

Constructor & Destructor Documentation

fesa::TimerEventElementImpl::TimerEventElementImpl	(	const std::string &	className,
		const std::string &	logicalEventName,
		const std::string &	xpath,
		boost::shared_ptr< ElementXML >	eventElement
	)

constructor

Parameters

className	Name of the class, which owns this event
logicalEventName	Name of the logical-event, which uses this concrete-event
xpath	xml-path as string on which the eventElement is located
eventElement	object which allows easy access to "xpath"

const uint64_t fesa::TimerEventElementImpl::getPeriod ( ) const

Returns the period, in milliseconds, of this timer event.

const std::string & fesa::TimerEventElementImpl::getSourceTypeSpecificData ( const std::string & dataTag )

virtual

returns data as string. If dataTag is not found, an exception is thrown

Parameters

dataTag used to identify a specific data-string

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