fesa::AbstractServiceLocator Class Reference

#include <AbstractServiceLocator.h>

Inheritance diagram for fesa::AbstractServiceLocator:

Public Member Functions
	AbstractServiceLocator (AbstractServiceLocatorImplementation *abstractImplementation)
virtual	~AbstractServiceLocator ()
void	runClassSpecificInitRT () const
	Run the specific-init method of the RTDeviceClass.
void	runClassSpecificInitServer () const
	Run the specific-init method of the ServerDeviceClass.
void	runDeployUnitSpecificInitRT () const
	Run the specific-init method of the RT part of the DeployUnit.
void	runDeployUnitSpecificInitServer () const
	Run the specific-init method of the Server part of the Deployunit.
void	enableEventSource (const std::string &eventSourceName) const
	Enable the run of the event source passed in the argument list, if the event-source was already disabled otherwise there is not effect.
void	disableEventSource (const std::string &eventSourceName) const
	Disable the normal run of the event source passed in the argument list, if the event-source was already enabled otherwise there is not effect.
void	enableRTEvent (const std::string &logicalEventName, const std::string &eventSourceName) const
	Enable the trigger of a given real-time event.
void	disableRTEvent (const std::string &logicalEventName, const std::string &eventSourceName) const
	Disable the trigger of a given real-time event.
bool	isEventEnabled (const std::string &logicalEventName, const std::string &eventSourceName) const
	Check if an event is enabled or disabled.
void	synchronizeSettingFields (const MultiplexingContext &context) const
	Triggers the manual synchronization of the Setting fields composed by double buffer.
void	triggerPersistency () const
	Triggers the persistence mechanism.
virtual const std::vector < AbstractDevice * > &	getDeviceCollection () const
	Retrieve the complete collection of devices for a given FESA class.
virtual AbstractDevice *	getDevice (const std::string &deviceName) const
	Retrieve a device based on its name.
virtual AbstractDevice *	getGlobalDevice () const
	Retrieve the global device of the current class.
Protected Attributes
std::string	className_
AbstractServiceLocatorImplementation *	pImplementation_

Detailed Description

Definition at line 19 of file AbstractServiceLocator.h.

Constructor & Destructor Documentation

fesa::AbstractServiceLocator::AbstractServiceLocator ( AbstractServiceLocatorImplementation * abstractImplementation ) [explicit]

Definition at line 9 of file AbstractServiceLocator.cpp.

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

Definition at line 14 of file AbstractServiceLocator.cpp.

References pImplementation_.

Member Function Documentation

void fesa::AbstractServiceLocator::disableEventSource ( const std::string & eventSourceName ) const

Disable the normal run of the event source passed in the argument list, if the event-source was already enabled otherwise there is not effect.

Parameters:

	eventSourceName	the name of the event source to disable
	eventSourceKey	key of the event-source, this parameter is optional and is needed only in case of custom-event-source

Exceptions:

FesaException

Definition at line 44 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::disableEventSource(), and pImplementation_.

void fesa::AbstractServiceLocator::disableRTEvent	(	const std::string &	logicalEventName,
		const std::string &	eventSourceName
	)			const

Disable the trigger of a given real-time event.

Parameters:

	eventName	the name of the event to disable
	eventSourceName	the name of the event source that triggers the event
	eventSourceKey	key of the event-source, this parameter is optional and is needed only in case of custom-event-source

Exceptions:

FesaException

Definition at line 54 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::disableRTEvent(), and pImplementation_.

void fesa::AbstractServiceLocator::enableEventSource ( const std::string & eventSourceName ) const

Enable the run of the event source passed in the argument list, if the event-source was already disabled otherwise there is not effect.

Parameters:

	eventSourceName	the name of the event source to enable
	eventSourceKey	key of the event-source, this parameter is optional and is needed only in case of custom-event-source

Exceptions:

FesaException

Definition at line 39 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::enableEventSource(), and pImplementation_.

void fesa::AbstractServiceLocator::enableRTEvent	(	const std::string &	logicalEventName,
		const std::string &	eventSourceName
	)			const

Enable the trigger of a given real-time event.

Parameters:

	eventName	the name of the event to enable
	eventSourceName	the name of the event source that triggers the event
	eventSourceKey	key of the event-source, this parameter is optional and is needed only in case of custom-event-source

Exceptions:

FesaException

Definition at line 49 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::enableRTEvent(), and pImplementation_.

AbstractDevice * fesa::AbstractServiceLocator::getDevice ( const std::string & deviceName ) const [virtual]

Retrieve a device based on its name.

Parameters:

deviceName

the name of the searched device

Returns:: the searched device as a pointer to AbstractDevice

Exceptions:

FesaException

Reimplemented in fesa::ServiceLocator< GlobalDeviceType, DomainStoreType, DeviceType >.

Definition at line 79 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::getDevice(), and pImplementation_.

const std::vector< AbstractDevice * > & fesa::AbstractServiceLocator::getDeviceCollection ( ) const [virtual]

Retrieve the complete collection of devices for a given FESA class.

Returns:: a std::vector with the collection of the devices as a collection of pointers to AbstractDevice

Exceptions:

FesaException

Definition at line 74 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::getDeviceCollection(), and pImplementation_.

AbstractDevice * fesa::AbstractServiceLocator::getGlobalDevice ( ) const [virtual]

Retrieve the global device of the current class.

Returns:: the global device as a pointer to AbstractDevice

Exceptions:

FesaException

Reimplemented in fesa::ServiceLocator< GlobalDeviceType, DomainStoreType, DeviceType >.

Definition at line 84 of file AbstractServiceLocator.cpp.

References fesa::AbstractServiceLocatorImplementation::getGlobalDevice(), and pImplementation_.

bool fesa::AbstractServiceLocator::isEventEnabled	(	const std::string &	logicalEventName,
		const std::string &	eventSourceName
	)			const

Check if an event is enabled or disabled.

Parameters:

	eventName	the name of the event
	eventSourceName	the name of the event source that triggers the event
	eventSourceKey	key of the event-source, this parameter is optional and is needed only in case of custom-event-source