fesa-core  5.0.1
fesa::EventElementImpl Class Referenceabstract

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

#include <EventElementImpl.h>

Inheritance diagram for fesa::EventElementImpl:
fesa::EventElement fesa::CustomEventElementImpl fesa::OnDemandEventElementImpl fesa::OnSubscriptionEventElementImpl fesa::TimerEventElementImpl fesa::TimingEventElementImpl

Public Member Functions

const std::string & getSourceTypeSpecificData (const std::string &dataTag)=0
 returns data as string. If dataTag is not found, an exception is thrown More...
 
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...
 

Protected Member Functions

 EventElementImpl (const std::string &className, const std::string &logicalEventName, const EventSourceType sourceType, const std::string &xpath, boost::shared_ptr< ElementXML > eventElement)
 

Protected Attributes

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 Event-specific Information which comes from the Instantiation-File. This class is Abstract.

Constructor & Destructor Documentation

fesa::EventElementImpl::EventElementImpl ( const std::string &  className,
const std::string &  logicalEventName,
const EventSourceType  sourceType,
const std::string &  xpath,
boost::shared_ptr< ElementXML eventElement 
)
protected
Parameters
classNameName of the class, which hosts this event
logicalEventNameName of the logical-event, which uses this concrete-event
sourceTypefilled by the child-classes, according to their concrete type#
xpathxml-path as string on which the eventElement is located
eventElementobject which allows easy access to "xpath"

Member Function Documentation

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

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

Parameters
nameof the device to connect

Implements fesa::EventElement.

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

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

Returns
the name of the class

Implements fesa::EventElement.

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

Returns the name of the concrete-event.

Returns
the name of the concrete-event

Implements fesa::EventElement.

std::vector< std::string > fesa::EventElementImpl::getDeviceCollection ( ) const
virtual

Returns all devices which are connected to this concrete event.

Returns
the name of all connected devices

Implements fesa::EventElement.

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

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

Returns
the name of the event-source

Implements fesa::EventElement.

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

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

Returns
the type of the event-source

Implements fesa::EventElement.

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

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

Returns
the logical event name

Implements fesa::EventElement.

const std::string& fesa::EventElementImpl::getSourceTypeSpecificData ( const std::string &  dataTag)
pure virtual

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

Parameters
dataTagused to identify a specific data-string
Returns
the requested data as string

Implements fesa::EventElement.

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


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