fesa-core  4.3.1
fesa::CustomEventElementImpl Class Reference

Used to store all custom-event-element Information which comes from the Instantiation-File. More...

#include <CustomEventElementImpl.h>

Inheritance diagram for fesa::CustomEventElementImpl:
fesa::EventElementImpl fesa::EventElement

Public Member Functions

 CustomEventElementImpl (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 std::string & getCustomEventName () 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 store all custom-event-element Information which comes from the Instantiation-File.

Constructor & Destructor Documentation

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

constructor

Parameters
classNameName of the class, which owns this event
logicalEventNameName of the logical-event, which uses this concrete-event
xpathxml-path as string on which the eventElement is located
eventElementobject which allows easy access to "xpath"

Member Function Documentation

const std::string & fesa::CustomEventElementImpl::getCustomEventName ( ) const

Returns the custom event name of this custom event.

const std::string & fesa::CustomEventElementImpl::getSourceTypeSpecificData ( const std::string &  dataTag)
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::EventElementImpl.


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