fesa::ServerAction< DeviceType, DataType, FilterType > Class Template Reference

#include <ServerAction.h>

Inheritance diagram for fesa::ServerAction< DeviceType, DataType, FilterType >:

List of all members.

Public Member Functions
	ServerAction (ServerActionConfig &actionConfig, const AbstractServiceLocator *serviceLocator, const std::map< std::string, const AbstractServiceLocator * > serviceLocatorRelatedClasses)
	Constructor.
virtual	~ServerAction ()
void	execute (RequestEvent *evt, AbstractDevice &dev, const rdaData &filter, rdaData &data, IOType ioType, RequestType reqType)
	This method is executed by a property when it's requested and it isn't global.
void	performCommit (MultiplexingContext &pTransactionCtxt, AbstractDevice *transactionDevice)
	this method is executed to commit the transaction
void	performRollback (MultiplexingContext &pTransactionCtxt, AbstractDevice *transactionDevice)
	this method is executed to rollback the transaction
Protected Member Functions
virtual void	execute (RequestEvent *evt, DeviceType *device, DataType &data, const FilterType &filter)
	This method has to be implemented by the developer when the property is global.
virtual void	execute (RequestEvent *evt, DeviceType *, DataType &data)
	This method has to be implemented by the developer when the property is global.
virtual void	commit (RequestEvent *, DeviceType *)
	Called when the transaction is committed (only for transactional sets).
virtual void	rollback (RequestEvent *, DeviceType *)
	Called when the transaction is rolled back (only for transactional sets).

---

Detailed Description

template<typename DeviceType, typename DataType, typename FilterType = BasicFilter>
class fesa::ServerAction< DeviceType, DataType, FilterType >

Definition at line 50 of file ServerAction.h.

---

Constructor & Destructor Documentation

template<typename DeviceType , typename DataType , typename FilterType >

fesa::ServerAction< DeviceType, DataType, FilterType >::ServerAction	(	ServerActionConfig &	actionConfig,
		const AbstractServiceLocator *	serviceLocator,
		const std::map< std::string, const AbstractServiceLocator * >	serviceLocatorRelatedClasses
	)			[inline]

Constructor.

Parameters:

actionConfig

which contains all the attributes for the action

Definition at line 120 of file ServerAction.h.

template<typename DeviceType , typename DataType , typename FilterType >

fesa::ServerAction< DeviceType, DataType, FilterType >::~ServerAction

(

)

[inline, virtual]

Definition at line 126 of file ServerAction.h.

---

Member Function Documentation

template<typename DeviceType , typename DataType , typename FilterType = BasicFilter>

virtual void fesa::ServerAction< DeviceType, DataType, FilterType >::commit	(	RequestEvent *	,
		DeviceType *
	)			[inline, protected, virtual]

Called when the transaction is committed (only for transactional sets).

Definition at line 105 of file ServerAction.h.

Referenced by fesa::ServerAction< DeviceType, DataType, FilterType >::performCommit().

template<typename DeviceType , typename DataType , typename FilterType = BasicFilter>

virtual void fesa::ServerAction< DeviceType, DataType, FilterType >::execute	(	RequestEvent *	evt,
		DeviceType *	,
		DataType &	data
	)			[inline, protected, virtual]

This method has to be implemented by the developer when the property is global.

Definition at line 96 of file ServerAction.h.

References FesaErrorPropertyExecuteMethodIsNotImplemented, and fesa::AbstractAction::name_.

template<typename DeviceType , typename DataType , typename FilterType = BasicFilter>

virtual void fesa::ServerAction< DeviceType, DataType, FilterType >::execute	(	RequestEvent *	evt,
		DeviceType *	device,
		DataType &	data,
		const FilterType &	filter
	)			[inline, protected, virtual]

This method has to be implemented by the developer when the property is global.

Definition at line 87 of file ServerAction.h.

References FesaErrorPropertyExecuteMethodIsNotImplemented, and fesa::AbstractAction::name_.

template<typename DeviceType , typename DataType , typename FilterType >

void fesa::ServerAction< DeviceType, DataType, FilterType >::execute	(	RequestEvent *	evt,
		AbstractDevice &	dev,
		const rdaData &	filter,
		rdaData &	data,
		IOType	ioType,
		RequestType	reqType
	)			[inline, virtual]

This method is executed by a property when it's requested and it isn't global.

Parameters:

	evt
	dev
	filter
	data
	ioType
	updateFlags

Implements fesa::AbstractServerAction.

Definition at line 131 of file ServerAction.h.

References fesa::FieldSynchroManager::abortModifiedFieldSynchronization(), fesa::DiagnosticUtils::DiagnosticMessage::action, fesa::AbstractServerAction::checkInvalidatingFields(), fesa::FieldSynchroManager::commitModifiedFieldSynchronization(), fesa::DiagnosticUtils::framework, fesa::GET, fesa::MultiplexingContext::getCycleName(), fesa::MultiplexingContext::getCycleStamp(), fesa::AbstractServerEquipment::getDeviceClassFromDeviceName(), fesa::AbstractEquipment::getDiagnostics(), fesa::AbstractServerEquipment::getInstance(), fesa::PersistencyManager::getInstance(), fesa::FieldSynchroManager::getInstance(), fesa::AbstractEquipment::getInstance(), fesa::AbstractEvent::getMultiplexingContext(), fesa::AbstractDeviceClass::getName(), fesa::AbstractDevice::getName(), fesa::DiagnosticUtils::DiagnosticMessage::msg, fesa::DiagnosticUtils::DiagnosticMessage::name, fesa::AbstractAction::name_, fesa::AbstractServerAction::needFilter_, fesa::AbstractServerAction::notify(), fesa::Output, fesa::AbstractServerAction::partialSetIsAllowed_, fesa::DiagnosticUtils::server, fesa::SET, fesa::DiagnosticUtils::DiagnosticMessage::side, fesa::DiagnosticUtils::DiagnosticMessage::source, fesa::DiagnosticUtils::start, fesa::DiagnosticUtils::stop, fesa::PersistencyManager::trigger(), fesa::AbstractAction::triggerAllAutomaticallyTriggeredOnDemandEventSources(), and fesa::DiagnosticUtils::undefined.

template<typename DeviceType , typename DataType , typename FilterType >

void fesa::ServerAction< DeviceType, DataType, FilterType >::performCommit	(	MultiplexingContext &	pTransactionCtxt,
		AbstractDevice *	transactionDevice
	)			[inline, virtual]

this method is executed to commit the transaction

Implements fesa::AbstractServerAction.

Definition at line 262 of file ServerAction.h.

References fesa::ServerAction< DeviceType, DataType, FilterType >::commit().

template<typename DeviceType , typename DataType , typename FilterType >

void fesa::ServerAction< DeviceType, DataType, FilterType >::performRollback	(	MultiplexingContext &	pTransactionCtxt,
		AbstractDevice *	transactionDevice
	)			[inline, virtual]

this method is executed to rollback the transaction

Implements fesa::AbstractServerAction.

Definition at line 274 of file ServerAction.h.

References fesa::ServerAction< DeviceType, DataType, FilterType >::rollback().

template<typename DeviceType , typename DataType , typename FilterType = BasicFilter>

virtual void fesa::ServerAction< DeviceType, DataType, FilterType >::rollback	(	RequestEvent *	,
		DeviceType *
	)			[inline, protected, virtual]

Called when the transaction is rolled back (only for transactional sets).

Definition at line 112 of file ServerAction.h.

Referenced by fesa::ServerAction< DeviceType, DataType, FilterType >::performRollback().

---

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

• Server/ServerAction.h