fesa::EventElement Class Reference

Used to handle and store all Event-specific Information which comes from the Instantiation-File. This class is Abstract. More...

#include <EventElement.h>

Inheritance diagram for fesa::EventElement:

Public Member Functions
virtual const std::string &	getSourceTypeSpecificData (const std::string &dataTag)=0
	returns data as string. If dataTag is not found, an exception is thrown More...
virtual const std::string &	getLogicalName () const =0
	Returns the logical event name which is used for this concrete-event. More...
virtual const std::string &	getEventSourceName () const =0
	Returns the name of the event-source which will fire this concrete event. More...
virtual const EventSourceType &	getEventSourceType () const =0
	Returns the type of the event-source which will fire this concrete event. More...
virtual const std::string &	getConcreteName () const =0
	Returns the name of the concrete-event. More...
virtual const std::string &	getClassName () const =0
	Returns the name of the class which will manage this concrete event. More...
virtual std::set< std::string >	getDeviceCollection () const =0
	Returns all devices which are connected to this concrete event. More...
virtual void	addDeviceRef (const std::string &deviceName)=0
	used in order to add references of the connected devices to this object (according to the mapping in the xml-file) More...

Detailed Description

Used to handle and store all Event-specific Information which comes from the Instantiation-File. This class is Abstract.

Member Function Documentation

virtual void fesa::EventElement::addDeviceRef ( const std::string &  deviceName )

pure virtual

used in order to add references of the connected devices to this object (according to the mapping in the xml-file)

Parameters

name	of the device to connect

Implemented in fesa::EventElementImpl.

virtual const std::string& fesa::EventElement::getClassName ( ) const

pure virtual

Returns the name of the class which will manage this concrete event.

Returns

the name of the class

Implemented in fesa::EventElementImpl.

virtual const std::string& fesa::EventElement::getConcreteName ( ) const

pure virtual

Returns the name of the concrete-event.

Returns

the name of the concrete-event

Implemented in fesa::EventElementImpl.

virtual std::set<std::string> fesa::EventElement::getDeviceCollection ( ) const

pure virtual

Returns all devices which are connected to this concrete event.

Returns

the name of all connected devices

Implemented in fesa::EventElementImpl.

virtual const std::string& fesa::EventElement::getEventSourceName ( ) const

pure virtual

Returns the name of the event-source which will fire this concrete event.

Returns

the name of the event-source

Implemented in fesa::EventElementImpl.

virtual const EventSourceType& fesa::EventElement::getEventSourceType ( ) const

pure virtual

Returns the type of the event-source which will fire this concrete event.

Returns

the type of the event-source

Implemented in fesa::EventElementImpl.

virtual const std::string& fesa::EventElement::getLogicalName ( ) const

pure virtual

Returns the logical event name which is used for this concrete-event.

Returns

the logical event name

Implemented in fesa::EventElementImpl.

virtual const std::string& fesa::EventElement::getSourceTypeSpecificData ( const std::string &  dataTag )

pure virtual

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

Parameters

dataTag

used to identify a specific data-string

Returns

the requested data as string

Implemented in fesa::CustomEventElementImpl, fesa::OnSubscriptionEventElementImpl, fesa::TimerEventElementImpl, fesa::TimingEventElementImpl, fesa::OnDemandEventElementImpl, and fesa::EventElementImpl.

---

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

• EventElement.h