Implementation of pure virtual class ClassElement. More...

#include <ClassElementImpl.h>

Inheritance diagram for fesa::ClassElementImpl:

Public Member Functions
const std::vector < boost::shared_ptr < LogicalEventElement > > &	getLogicalElementCol () const
	returns all logical event-elements of this class More...

const std::string &	getClassName () const
	returns name of the class, presented by this class-element More...

const EventMap &	getActiveEventMap () const
	returns a map of all logical events, and their connected, active events More...

std::vector< EventElementPointer >	getActiveEvents (const std::string &logicalEventName) const
	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...

DeviceElementCol	getDeviceElementCol () const
	returns the collection of device-elements of this class More...

bool	isDeviceElement (const std::string &deviceName) const
	method to check if a specific device-element exists More...

boost::shared_ptr< DeviceElement >	getDeviceElement (const std::string &deviceName) const
	returns the desired device-element, or throws exception, if not found More...

boost::shared_ptr< DeviceElement >	getGlobalDeviceElement () const
	returns the global device-element More...

DomainStoreElementCol	getDomainStoreElementCol () const
	returns the collection of domain store elements of this class More...

bool	isDomainStoreElement (const std::string &domainStoreName) const
	method to check if a specific domain-store-element exists More...

boost::shared_ptr < DataStoreElement >	getDomainStoreElement (const std::string &domainStoreName) const
	returns the desired domainStore-element, or throws exception, if not found More...

int32_t	getMultiplexingRollingBufferDepth () const
	return size of the rolling buffer More...

Detailed Description

Implementation of pure virtual class ClassElement.

Member Function Documentation

const ClassElement::EventMap & fesa::ClassElementImpl::getActiveEventMap ( ) const

virtual

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

Returns: map of active logical events

Implements fesa::ClassElement.

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

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

logicalEventName The logical event name

Returns: The vector of active logical events

Implements fesa::ClassElement.

const std::string & fesa::ClassElementImpl::getClassName ( ) const

virtual

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

Returns: name of the class

Implements fesa::ClassElement.

boost::shared_ptr< DeviceElement > fesa::ClassElementImpl::getDeviceElement ( const std::string & deviceName ) const

virtual

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

Parameters

deviceName name of the device to get

Returns: the device element as shared pointer

Implements fesa::ClassElement.

ClassElement::DeviceElementCol fesa::ClassElementImpl::getDeviceElementCol ( ) const

virtual

returns the collection of device-elements of this class

Returns: collection of device-elements

Implements fesa::ClassElement.

boost::shared_ptr< DataStoreElement > fesa::ClassElementImpl::getDomainStoreElement ( const std::string & domainStoreName ) const

virtual

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

Parameters

domainStoreName name of the domainStore to get

Returns: the domainStore element as shared pointer

Implements fesa::ClassElement.

ClassElement::DomainStoreElementCol fesa::ClassElementImpl::getDomainStoreElementCol ( ) const

virtual

returns the collection of domain store elements of this class

Returns: the collection

Implements fesa::ClassElement.

boost::shared_ptr< DeviceElement > fesa::ClassElementImpl::getGlobalDeviceElement ( ) const

virtual

returns the global device-element

Returns: the global device-element as shared pointer

Implements fesa::ClassElement.

const std::vector< boost::shared_ptr< LogicalEventElement > > & fesa::ClassElementImpl::getLogicalElementCol ( ) const

virtual

returns all logical event-elements of this class

Returns: all logical event-elements of this class

Implements fesa::ClassElement.

int32_t fesa::ClassElementImpl::getMultiplexingRollingBufferDepth ( ) const

virtual

return size of the rolling buffer

Returns: the size

Implements fesa::ClassElement.

bool fesa::ClassElementImpl::isDeviceElement ( const std::string & deviceName ) const

virtual

method to check if a specific device-element exists

Parameters

deviceName name of the device to check

Returns: true, if it exists

Implements fesa::ClassElement.

bool fesa::ClassElementImpl::isDomainStoreElement ( const std::string & domainStoreName ) const

virtual

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

Parameters

domainStoreName name of the domainStore to check

Returns: true, if it exists

Implements fesa::ClassElement.

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

ClassElementImpl.h
ClassElementImpl.cpp

Public Member Functions

Detailed Description

Member Function Documentation