fesa-core  7.0.0
fesa::ClassElement Class Referenceabstract

Used to store all class-related Information from the Instantiation-File. More...

#include <ClassElement.h>

Inheritance diagram for fesa::ClassElement:
fesa::ClassElementImpl

Public Member Functions

virtual const std::vector
< boost::shared_ptr
< LogicalEventElement > > & 
getLogicalElementCol () const =0
 returns all logical event-elements of this class More...
 
virtual const std::string & getClassName () const =0
 returns name of the class, presented by this class-element More...
 
virtual const EventMap & getActiveEventMap () const =0
 returns a map of all logical events, and their connected, active events More...
 
virtual std::vector
< EventElementPointer > 
getActiveEvents (const std::string &logicalEventName) const =0
 Return a vector of all active events connected to a single logical event. \ If the logical event is optional, the returned vector may be empty. More...
 
virtual DeviceElementCol getDeviceElementCol () const =0
 returns the collection of device-elements of this class More...
 
virtual bool isDeviceElement (const std::string &deviceName) const =0
 method to check if a specific device-element exists More...
 
virtual boost::shared_ptr
< DeviceElement
getDeviceElement (const std::string &deviceName) const =0
 returns the desired device-element, or throws exception, if not found More...
 
virtual boost::shared_ptr
< DeviceElement
getGlobalDeviceElement () const =0
 returns the global device-element More...
 
virtual DomainStoreElementCol getDomainStoreElementCol () const =0
 returns the collection of domain store elements of this class More...
 
virtual bool isDomainStoreElement (const std::string &domainStoreName) const =0
 method to check if a specific domain-store-element exists More...
 
virtual boost::shared_ptr
< DataStoreElement
getDomainStoreElement (const std::string &domainStoreName) const =0
 returns the desired domainStore-element, or throws exception, if not found More...
 
virtual int32_t getMultiplexingRollingBufferDepth () const =0
 return size of the rolling buffer More...
 
virtual std::vector
< EventElementPointer > 
getForwardedEventElementCol (const std::string &eventConfigurationName) const =0
 return all events from the forwarded event configuration More...
 
virtual void resolveConfiguration (const std::string &logicalEventName) const =0
 resolves the forwarded events of a logical event More...
 

Detailed Description

Used to store all class-related Information from the Instantiation-File.

Member Function Documentation

virtual const EventMap& fesa::ClassElement::getActiveEventMap ( ) const
pure virtual

returns a map of all logical events, and their connected, active events

Returns
map of active logical events

Implemented in fesa::ClassElementImpl.

virtual std::vector<EventElementPointer> fesa::ClassElement::getActiveEvents ( const std::string &  logicalEventName) const
pure virtual

Return a vector of all active events connected to a single logical event. \ If the logical event is optional, the returned vector may be empty.

Parameters
logicalEventNameThe logical event name
Returns
The vector of active logical events

Implemented in fesa::ClassElementImpl.

virtual const std::string& fesa::ClassElement::getClassName ( ) const
pure virtual

returns name of the class, presented by this class-element

Returns
name of the class

Implemented in fesa::ClassElementImpl.

virtual boost::shared_ptr<DeviceElement> fesa::ClassElement::getDeviceElement ( const std::string &  deviceName) const
pure virtual

returns the desired device-element, or throws exception, if not found

Parameters
deviceNamename of the device to get
Returns
the device element as shared pointer

Implemented in fesa::ClassElementImpl.

virtual DeviceElementCol fesa::ClassElement::getDeviceElementCol ( ) const
pure virtual

returns the collection of device-elements of this class

Returns
collection of device-elements

Implemented in fesa::ClassElementImpl.

virtual boost::shared_ptr<DataStoreElement> fesa::ClassElement::getDomainStoreElement ( const std::string &  domainStoreName) const
pure virtual

returns the desired domainStore-element, or throws exception, if not found

Parameters
domainStoreNamename of the domainStore to get
Returns
the domainStore element as shared pointer

Implemented in fesa::ClassElementImpl.

virtual DomainStoreElementCol fesa::ClassElement::getDomainStoreElementCol ( ) const
pure virtual

returns the collection of domain store elements of this class

Returns
the collection

Implemented in fesa::ClassElementImpl.

virtual std::vector<EventElementPointer> fesa::ClassElement::getForwardedEventElementCol ( const std::string &  eventConfigurationName) const
pure virtual

return all events from the forwarded event configuration

Parameters
eventConfigurationNamename of the event configuration forwarded
Returns
the vector of events

Implemented in fesa::ClassElementImpl.

virtual boost::shared_ptr<DeviceElement> fesa::ClassElement::getGlobalDeviceElement ( ) const
pure virtual

returns the global device-element

Returns
the global device-element as shared pointer

Implemented in fesa::ClassElementImpl.

virtual const std::vector<boost::shared_ptr<LogicalEventElement> >& fesa::ClassElement::getLogicalElementCol ( ) const
pure virtual

returns all logical event-elements of this class

Returns
all logical event-elements of this class

Implemented in fesa::ClassElementImpl.

virtual int32_t fesa::ClassElement::getMultiplexingRollingBufferDepth ( ) const
pure virtual

return size of the rolling buffer

Returns
the size

Implemented in fesa::ClassElementImpl.

virtual bool fesa::ClassElement::isDeviceElement ( const std::string &  deviceName) const
pure virtual

method to check if a specific device-element exists

Parameters
deviceNamename of the device to check
Returns
true, if it exists

Implemented in fesa::ClassElementImpl.

virtual bool fesa::ClassElement::isDomainStoreElement ( const std::string &  domainStoreName) const
pure virtual

method to check if a specific domain-store-element exists

Parameters
domainStoreNamename of the domainStore to check
Returns
true, if it exists

Implemented in fesa::ClassElementImpl.

virtual void fesa::ClassElement::resolveConfiguration ( const std::string &  logicalEventName) const
pure virtual

resolves the forwarded events of a logical event

Parameters
logicalEventNamename of the logical event to process

Implemented in fesa::ClassElementImpl.


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