fesa::LogicalEventElement Class Reference

Used to handle and store all Logical-Event-specific Information which comes from the Instantiation-File. More...

#include <LogicalEventElement.h>

List of all members.

Public Member Functions

 LogicalEventElement (boost::shared_ptr< ClassElement > parent)
virtual void initialize (const std::string &xpath, ElementXML *logicalEventElement, ParserElementFactory &parserElementFactory)
 triggers the parsing of the xml-file-structures and initializes the class with all needed information
virtual ~LogicalEventElement ()
virtual boost::shared_ptr
< EventConfigurationElement
getEventConfigurationElementRef (const std::string &eventConfigurationName) const
 returns a reference to a specific event-config-element
virtual AbstractDeviceClassgetClassRef () const
virtual const std::vector
< boost::shared_ptr
< EventConfigurationElement > > & 
getEventConfigurationElementCol () const
virtual std::vector
< boost::shared_ptr
< EventElement > > 
getActiveEventElements () const
 returns all active event-elements which are connected to this logical-event-element
virtual const std::string & getName () const

Protected Member Functions

 LogicalEventElement ()
 To allow easy mocking of this class.

Private Member Functions

void loadEventConfigurationElements (const std::string &xpath, ElementXML *logicalEventElement, ParserElementFactory &parserElementFactory)
 loads the xml-event-configuration-elements of this logical-event-element and stores all info

Private Attributes

std::vector< boost::shared_ptr
< EventConfigurationElement > > 
configurationElementCol_
 list of all event-configuration-elements connected to this object
boost::shared_ptr< ClassElementparentClassElement_
 the parent-element in this linked-tree
std::string logicalEventName_
 name of the logical-event, represented by this object
bool isInitialized_
 true, when initialization of this object was finished successfully

Detailed Description

Used to handle and store all Logical-Event-specific Information which comes from the Instantiation-File.

Definition at line 24 of file LogicalEventElement.h.


Constructor & Destructor Documentation

fesa::LogicalEventElement::LogicalEventElement ( boost::shared_ptr< ClassElement parent  ) 
Parameters:
parent the parent-element in the linked-tree

Definition at line 13 of file LogicalEventElement.cpp.

fesa::LogicalEventElement::~LogicalEventElement (  )  [virtual]

Definition at line 24 of file LogicalEventElement.cpp.

fesa::LogicalEventElement::LogicalEventElement (  )  [protected]

To allow easy mocking of this class.

Definition at line 19 of file LogicalEventElement.cpp.


Member Function Documentation

std::vector< boost::shared_ptr< EventElement > > fesa::LogicalEventElement::getActiveEventElements (  )  const [virtual]

returns all active event-elements which are connected to this logical-event-element

Definition at line 84 of file LogicalEventElement.cpp.

References configurationElementCol_.

AbstractDeviceClass * fesa::LogicalEventElement::getClassRef (  )  const [virtual]

Definition at line 48 of file LogicalEventElement.cpp.

References parentClassElement_.

const std::vector< boost::shared_ptr< EventConfigurationElement > > & fesa::LogicalEventElement::getEventConfigurationElementCol (  )  const [virtual]
boost::shared_ptr< EventConfigurationElement > fesa::LogicalEventElement::getEventConfigurationElementRef ( const std::string &  eventConfigurationName  )  const [virtual]

returns a reference to a specific event-config-element

Definition at line 53 of file LogicalEventElement.cpp.

References configurationElementCol_, FesaErrorTimingMappingNotConform, and logicalEventName_.

const std::string & fesa::LogicalEventElement::getName (  )  const [virtual]
void fesa::LogicalEventElement::initialize ( const std::string &  xpath,
ElementXML logicalEventElement,
ParserElementFactory parserElementFactory 
) [virtual]

triggers the parsing of the xml-file-structures and initializes the class with all needed information

Definition at line 29 of file LogicalEventElement.cpp.

References isInitialized_, loadEventConfigurationElements(), logicalEventName_, and fesa::ElementXML::name_.

void fesa::LogicalEventElement::loadEventConfigurationElements ( const std::string &  xpath,
ElementXML logicalEventElement,
ParserElementFactory parserElementFactory 
) [private]

loads the xml-event-configuration-elements of this logical-event-element and stores all info

Definition at line 36 of file LogicalEventElement.cpp.

References fesa::ElementXML::childList_, configurationElementCol_, and fesa::ParserElementFactory::createEventConfigurationElement().

Referenced by initialize().


Member Data Documentation

list of all event-configuration-elements connected to this object

Definition at line 73 of file LogicalEventElement.h.

Referenced by getActiveEventElements(), getEventConfigurationElementCol(), getEventConfigurationElementRef(), and loadEventConfigurationElements().

true, when initialization of this object was finished successfully

Definition at line 88 of file LogicalEventElement.h.

Referenced by getEventConfigurationElementCol(), getName(), and initialize().

name of the logical-event, represented by this object

Definition at line 83 of file LogicalEventElement.h.

Referenced by getEventConfigurationElementRef(), getName(), and initialize().

the parent-element in this linked-tree

Definition at line 78 of file LogicalEventElement.h.

Referenced by getClassRef().


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

Generated on 18 Jan 2013 for Fesa by  doxygen 1.6.1