fesa-core  5.0.1
fesa::DeviceElement Class Referenceabstract

Used to store all device-specific Information which comes from the Instantiation-File. More...

#include <DeviceElement.h>

Inheritance diagram for fesa::DeviceElement:
fesa::DataStoreElementImpl fesa::DataStoreElement fesa::DeviceElementImpl

Public Member Functions

virtual void connectEventConfigRefs (LogicalEventElementVector &globalLogEventCol)=0
 connects all event-config-ref-elements on class level, according to the XML-links in the events-mapping of this device More...
 
virtual std::vector< std::string > getExtraMultiplexingCriterionCol () const =0
 returns the ExtraMultiplexingCriterionCol, if defined More...
 
virtual
DevLogicalEventElementVector 
getLogicalEventElementCol () const =0
 getter for the member logicalEventElementCol_ More...
 
virtual boost::shared_ptr
< DeviceLogicalEventElement
getDeviceLogicalEventElement (const std::string &logicalEventName) const =0
 returns a pointer to a specific DeviceLogicalEventElement More...
 
- Public Member Functions inherited from fesa::DataStoreElementImpl
 DataStoreElementImpl (const std::string &xpath, boost::shared_ptr< ElementXML > dataStoreElement, const ParserElementFactory &parserElementFactory)
 
const std::string & getDataStoreName () const
 returns name of the data store, presented by this data-store-element More...
 
bool isFieldElement (const std::string &fieldName) const
 returns true, if a field-element of the name "fieldName" was defined for this data-store in the instantiation-file More...
 
boost::shared_ptr< FieldElement > getFieldElement (const std::string &fieldName) const
 returns the requested field-element, if available. Throws an exception if the FieldElement is not found More...
 

Protected Member Functions

 DeviceElement (const std::string &xpath, boost::shared_ptr< ElementXML > deviceElement, const ParserElementFactory &parserElementFactory)
 
 DeviceElement ()
 used for mocking
 
- Protected Member Functions inherited from fesa::DataStoreElementImpl
 DataStoreElementImpl ()
 used for mocking
 

Additional Inherited Members

- Protected Attributes inherited from fesa::DataStoreElementImpl
std::string name_
 name of the data-store, which is represented by this element
 
boost::optional< int64_t > id_
 

Detailed Description

Used to store all device-specific Information which comes from the Instantiation-File.

Constructor & Destructor Documentation

fesa::DeviceElement::DeviceElement ( const std::string &  xpath,
boost::shared_ptr< ElementXML deviceElement,
const ParserElementFactory &  parserElementFactory 
)
inlineprotected
Parameters
xpathxpath which leads to the DeviceElement in the XML-tree
deviceElementhere the device related information comes from
parserElementFactoryfactory to create sub-classes of the class-tree

Member Function Documentation

virtual void fesa::DeviceElement::connectEventConfigRefs ( LogicalEventElementVector &  globalLogEventCol)
pure virtual

connects all event-config-ref-elements on class level, according to the XML-links in the events-mapping of this device

Parameters
globalLogEventColvector of all logical-events which are defined in the global event-mapping

Implemented in fesa::DeviceElementImpl.

virtual boost::shared_ptr<DeviceLogicalEventElement> fesa::DeviceElement::getDeviceLogicalEventElement ( const std::string &  logicalEventName) const
pure virtual

returns a pointer to a specific DeviceLogicalEventElement

Parameters
logicalEventNamename of the element to return
Returns
the requested DeviceLogicalEventElement

Implemented in fesa::DeviceElementImpl.

virtual std::vector<std::string> fesa::DeviceElement::getExtraMultiplexingCriterionCol ( ) const
pure virtual

returns the ExtraMultiplexingCriterionCol, if defined

Returns
ExtraMultiplexingCriterionCol

Implemented in fesa::DeviceElementImpl.

virtual DevLogicalEventElementVector fesa::DeviceElement::getLogicalEventElementCol ( ) const
pure virtual

getter for the member logicalEventElementCol_

Returns
logicalEventElementCol_

Implemented in fesa::DeviceElementImpl.


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