fesa::AbstractRTDeviceClass Class Reference

this class contains the real time data of the FESA class More...

#include <AbstractRTDeviceClass.h>

Inheritance diagram for fesa::AbstractRTDeviceClass:

Public Member Functions
	AbstractRTDeviceClass (const std::string &name, const std::string &version)
	constructor More...
virtual	~AbstractRTDeviceClass ()
	destructor
virtual AbstractRTActionFactory *	getRTActionFactory ()
virtual AbstractEventSourceFactory *	getEventSourceFactory ()
virtual void	initialize ()
	Implementation of the pure virtual baseclass method.
virtual void	addDiagnosticSchedulingUnitInfo (std::vector< RTSchedulingUnitInfo * > &schedulingUnitInfo)
	Used to add diagnostic-events-mapping, hidden from the class-developer TODO: get rid of this, it is very error-pron, neiter transparent, nor flexible. More...
virtual void	addDiagnosticRTActionInfo (RTActionInfoCol &actionInfoCol)
	Used to add diagnostic-events-mapping, hidden from the class-developer TODO: get rid of this, it is very error-pron, neiter transparent, nor flexible.
const boost::shared_ptr < LogicalEvent >	getLogicalEvent (const std::string &logicalEventName)
	Used to retrieve a logical-event, defined for this fesa-class. More...
bool	logicalEventExists (const std::string &logicalEventName) const
	Used to check, if a logical-event is provided by this fesa-class. More...
Public Member Functions inherited from fesa::AbstractDeviceClass
	AbstractDeviceClass (const std::string &fesaClassName, const std::string &version)
	Constructor. More...
virtual	~AbstractDeviceClass ()
	Destructor.
virtual AbstractDeviceFactory *	getDeviceFactory ()
	returns the abstract device factory of the class More...
virtual const std::string &	getName ()
	returns the name of the class as string More...
virtual const std::string &	getVersion ()
	returns the version of the class as string More...
virtual void	specificInit ()=0
	Custom initialization of the class.
virtual boost::shared_ptr < ClassElement >	getInstantiationXMLElement ()
	Getter for the member InstantiationXMLElement_. More...
virtual void	specificShutDown ()
	Method to run code when a clean shutdown occurs. The default implementation is empty. It can be overridden by a FESA class developer in ServerDeviceClass and RTDeviceClass.

Static Public Member Functions
static void	addDiagnosticEvents (boost::shared_ptr< ElementXML > xmlElementClass)
	Used to add diagnostic-events-mapping, hidden from the class-developer TODO: get rid of this, it is very error-pron, neiter transparent, nor flexible.

Protected Member Functions
virtual void	fillRTSchedulingUnitsInfo (std::vector< RTSchedulingUnitInfo * > &schedulingUnitInfo)=0
	fill the scheduling info for the class
virtual void	fillRTActionInfo (RTActionInfoCol &actionInfo)=0
	fill the actions information associated with this class
void	addOnDemandEventProducer (const std::string &className, const std::string &eventSourceName, FwkPart::FwkPart fwkPart)
	Allows the concrete device class to add OD-producers, according to the concrete class-design.

Protected Attributes
AbstractRTActionFactory *	rtActionFactory_
	reference to the action factory
AbstractEventSourceFactory *	eventSourceFactory_
	factory to create the event sources
Protected Attributes inherited from fesa::AbstractDeviceClass
std::string	name_
	name of the abstract device class
std::string	version_
	version of the abstract device class
AbstractDeviceFactory *	deviceFactory_
	reference to the device factory
std::vector < AbstractDeviceClass * >	relatedClassCol_
	list of classes related to this one by means of composition relationship.If the device class doesn't define any composition relationship, this collection is empty
AbstractDeviceClass *	baseClass_
	Defines the base class from which this device class inherits. If the device class does not define any inheritance relationship, the baseClass_ attribute is NULL.
OnDemandEventProducerCollection	onDemandEventProducerCol_
	service to trigger the different on-demand-event sources of this class
boost::shared_ptr< ClassElement >	instantiationXMLElement_
	Used to access the class-specific XML-data of the instantiation-file.

Detailed Description

this class contains the real time data of the FESA class

Constructor & Destructor Documentation

fesa::AbstractRTDeviceClass::AbstractRTDeviceClass	(	const std::string &	name,
		const std::string &	version
	)

constructor

Parameters

name	of the class

Member Function Documentation

void fesa::AbstractRTDeviceClass::addDiagnosticSchedulingUnitInfo ( std::vector< RTSchedulingUnitInfo * > &  schedulingUnitInfo )

virtual

Used to add diagnostic-events-mapping, hidden from the class-developer TODO: get rid of this, it is very error-pron, neiter transparent, nor flexible.

fill in the table with the information

AbstractEventSourceFactory * fesa::AbstractRTDeviceClass::getEventSourceFactory ( )

inlinevirtual

Returns

the event source action factory

const boost::shared_ptr< LogicalEvent > fesa::AbstractRTDeviceClass::getLogicalEvent

(

const std::string &

logicalEventName

)

Used to retrieve a logical-event, defined for this fesa-class.

Parameters

logicalEventName

name of the logical-event

Returns

pointer to the logical-event

AbstractRTActionFactory * fesa::AbstractRTDeviceClass::getRTActionFactory ( )

inlinevirtual

Returns

the RT action factory

bool fesa::AbstractRTDeviceClass::logicalEventExists

(

const std::string &

logicalEventName

)

const

Used to check, if a logical-event is provided by this fesa-class.

Parameters

logicalEventName

name of the logical-event

Returns

true, if logical-event is defined

---

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

• AbstractRTDeviceClass.h
• AbstractRTDeviceClass.cpp