fesa::AbstractServerAction Class Reference

This is the based class for all the server actions in the system which will be executed when a property is requested. TODO discuss the DataType parameter. More...

#include <AbstractServerAction.h>

Inheritance diagram for fesa::AbstractServerAction:

List of all members.

Public Member Functions
	AbstractServerAction (ServerActionConfig &actionConfig, const AbstractServiceLocator serviceLocator, const std::map< std::string, const AbstractServiceLocator > serviceLocatorRelatedClasses)
virtual	~AbstractServerAction ()
virtual void	execute (RequestEvent *evt, AbstractDevice &dev, const rdaData &filter, rdaData &data, IOType ioType, RequestType reqType)=0
	This method is executed by a property when it's requested and it isn't global.
virtual bool	needFilter ()
virtual void	performCommit (MultiplexingContext &transactionCtxt, AbstractDevice *transactionDevice)=0
virtual void	performRollback (MultiplexingContext &transactionCtxt, AbstractDevice *transactionDevice)=0
const std::string &	getName ()
virtual void	printConfig (FesaStream *configStream)
	this method prints the action configuration into the stream passed by argument
virtual void	printState (FesaStream *fesaStream, double elapsedTime)
	this method prints the actual state of the action (frequency of the completed actions) into the stream passed by argument
Static Public Member Functions
static void	releaseStaticObjects ()
Protected Member Functions
void	checkInvalidatingFields (AbstractDevice device, MultiplexingContext ctx)
	this function is supposed to throw the exception when any of the invalidating fault-fields or alarm-fields is raised (set to true)
void	notify (MultiplexingContext &transactionCtxt, AbstractDevice &device, RequestType reqType=GET)
	this method notifies the properties in the server action
Protected Attributes
std::vector< std::string >	notifiedPropertiesCol_
std::vector< std::string >	disablingFieldNamesCol_
std::vector< std::string >	disablingGlobalFieldNamesCol_
bool	partialSetIsAllowed_
	true if the property can be partially set
bool	needFilter_
	true if the action contains filter
bool	autoNotification_
bool	transactionalSetIsAllowed_
bool	defaultImpl_
	true if the server action has a default implementation
AbstractDevice *	pGlobalDevice_
	Pointer to the Global Device.
NotificationProducer *	theNotificationProducer_
	the notification producer is used to send properties' notifications to the server side

Detailed Description

This is the based class for all the server actions in the system which will be executed when a property is requested. TODO discuss the DataType parameter.

Definition at line 81 of file AbstractServerAction.h.

Constructor & Destructor Documentation

fesa::AbstractServerAction::AbstractServerAction	(	ServerActionConfig &	actionConfig,
		const AbstractServiceLocator *	serviceLocator,
		const std::map< std::string, const AbstractServiceLocator * >	serviceLocatorRelatedClasses
	)

Parameters:

actionConfig

which contains all the attributes to create the action

Definition at line 22 of file AbstractServerAction.cpp.

References fesa::NotificationProducer::getInstance(), and theNotificationProducer_.

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

Definition at line 33 of file AbstractServerAction.cpp.

Member Function Documentation

void fesa::AbstractServerAction::checkInvalidatingFields	(	AbstractDevice *	device,
		MultiplexingContext *	ctx
	)			`[protected]`

this function is supposed to throw the exception when any of the invalidating fault-fields or alarm-fields is raised (set to true)

Definition at line 43 of file AbstractServerAction.cpp.

References disablingFieldNamesCol_, disablingGlobalFieldNamesCol_, FesaErrorActionDisabledByFaultField, fesa::FaultField< DataType >::getDescription(), fesa::AbstractServerEquipment::getDeviceClassFromDeviceName(), fesa::DataStore::getField(), fesa::AbstractServerEquipment::getInstance(), fesa::AbstractDevice::getName(), fesa::FaultField< DataType >::isRaised(), and pGlobalDevice_.

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

virtual void fesa::AbstractServerAction::execute	(	RequestEvent *	evt,
		AbstractDevice &	dev,
		const rdaData &	filter,
		rdaData &	data,
		IOType	ioType,
		RequestType	reqType
	)			`[pure virtual]`