fesa::RTDiagnosticSetting Class Reference

Diagnostic logging. Switching on/off the diagnostic mode, enabling/disabling diagnostic topics, etc. More...

#include <RTDiagnosticSetting.h>

Inheritance diagram for fesa::RTDiagnosticSetting:

Public Member Functions
	RTDiagnosticSetting (RTActionConfig &rtActionConfig, const AbstractServiceLocator *serviceLocator, const std::map< std::string, const AbstractServiceLocator * > &serviceLocatorRelatedClasses)
	Constructor. More...
	~RTDiagnosticSetting ()
	Destructor.
void	execute (RTEvent *event)
	Modify topics and diagnostic paramters according to the information passed as a payload in the event. More...
void	printConfig (FesaStream *configStream)
	Print the real-time action's configuration into the stream passed as an argument. More...
void	printState (std::ostream &stream, double elapsedTime)
	Print the actual state of the real-time action (frequency of the completed actions) into the stream passed as an argument. More...
Public Member Functions inherited from fesa::AbstractRTAction
	AbstractRTAction (RTActionConfig &rtActionConfig, const AbstractServiceLocator *serviceLocator, const std::map< std::string, const AbstractServiceLocator * > &serviceLocatorRelatedClasses)
	Stores the RT action configuration. More...
virtual	~AbstractRTAction ()
	destructor
void	executeAction (RTEvent *event)
	This method will be called by the scheduler when the event arrives. More...
Public Member Functions inherited from fesa::AbstractAction
void	sendManualNotification (const MultiplexingContext *context) const
	this method sends a manual notification message in order to notify the properties and devices specified in the message
void	resetManualNotification () const
	Clears any registered properties/devices for the manual notification.
void	disableAutomaticNotification ()
void	enableAutomaticNotification ()
bool	isAutomaticNotificationDisabled () const
Public Member Functions inherited from fesa::HasMetrics
	HasMetrics (const std::string &componentName)

Additional Inherited Members
Protected Member Functions inherited from fesa::AbstractRTAction
void	releaseSettingFieldsReadLock ()
Protected Member Functions inherited from fesa::AbstractAction
virtual void	registerManualNotification (const std::string aPropertyName, const std::string aDeviceName)
	Adds a property/device pair for the manual notification.
Protected Member Functions inherited from fesa::HasMetrics
template<typename T >
void	registerMetric (const std::string &name, T &value)
template<typename T >
void	registerMetric (const std::string &name, boost::atomic< T > &value)
Protected Attributes inherited from fesa::AbstractRTAction
std::string	logicalEventName_
	name of the logical-event that fires the action
std::string	concreteEventName_
	name of the concrete-event that fires the action
std::string	selectionCriterion_
	selection criterion to select devices used for notification
std::string	eventSourceName_
	event source name (timing, timingSim, timer, user, <custom-name>)
std::vector< AbstractDevice * >	abstractDeviceCol_
	set of devices to which the real time action has access
DiagnosticsDefs::DiagStateCounter	completedActionCount_
	number of completed actions
uint32_t	abortedActionCount_
	number of real time actions aborted
Protected Attributes inherited from fesa::AbstractAction
std::string	name_
	name of the action
std::string	className_
	name of the FESA-class, which controls this action
NotificationProducer *	theNotificationProducer_
	the notification producer is used to send properties' notifications to the server side
std::set< std::string >	automaticallyNotifiedPropertiesCol_
	list of properties that will be notified automatically, after the action has finished

Detailed Description

Diagnostic logging. Switching on/off the diagnostic mode, enabling/disabling diagnostic topics, etc.

Constructor & Destructor Documentation

fesa::RTDiagnosticSetting::RTDiagnosticSetting	(	RTActionConfig &	rtActionConfig,
		const AbstractServiceLocator *	serviceLocator,
		const std::map< std::string, const AbstractServiceLocator * > &	serviceLocatorRelatedClasses
	)

Constructor.

Parameters

rtActionConfig	Configuration data for the real-time action
serviceLocator	The service locator of this FESA class
serviceLocatorRelatedClasses	The service locators of other FESA classes this class is in relationship with

Member Function Documentation

void fesa::RTDiagnosticSetting::execute ( RTEvent *  event )

virtual

Modify topics and diagnostic paramters according to the information passed as a payload in the event.

Parameters

event

The event that triggers the real-time action

Implements fesa::AbstractRTAction.

void fesa::RTDiagnosticSetting::printConfig ( FesaStream *  configStream )

virtual

Print the real-time action's configuration into the stream passed as an argument.

Parameters

configStream

The stream the information will be printed into

Implements fesa::AbstractRTAction.

void fesa::RTDiagnosticSetting::printState ( std::ostream &  stream, double  elapsedTime  )

virtual

Print the actual state of the real-time action (frequency of the completed actions) into the stream passed as an argument.

Parameters

stateStream	The stream the information will be printed into
elapsedTime

Implements fesa::AbstractRTAction.

---

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

• RTDiagnosticSetting.h
• RTDiagnosticSetting.cpp