DC_DataPoolMonitor Class Reference

#include <DC_DataPoolMonitor.h>

Inheritance diagram for DC_DataPoolMonitor:

List of all members.

Detailed Description

Component to perform a monitoring check on all items in the system data pool.

The system data pool that is subjected to monitoring is loaded from the CC_RootObject class. The data pool monitor is implemented as a form of conditional punctual action. When it is executed, the component iterates over all items in the data pool (using the iteration service offered by the data pool). It retrieves the monitoring profile associated to each item and it uses it to check the current value of the item. If a monitoring violation is detected, the validity status of the item is set to "not valid" and the recovery action associated to the item is executed.

Todo:: change the specification and the implementation of the class to set the status of a data pool item whose monitoring check reports "no deviation from profile" to "valid". At present, the validity status can only go from "valid" to "not valid".

See also:

Author:: Alessandro Pasetti (P&P Software GmbH)

Version:: 1.0

Definition at line 40 of file DC_DataPoolMonitor.h.

Public Member Functions

DC_DataPoolMonitor (void)

Instantiate a data pool monitor component.

Protected Member Functions

virtual bool canExecute (void)

Encapsulate an execution check that always returns "can execute".

virtual TD_ActionOutcome doConditionalAction (void)

Perform the monitoring action on all the items in the data pool.

Constructor & Destructor Documentation

DC_DataPoolMonitor::DC_DataPoolMonitor ( void )

Instantiate a data pool monitor component.
The value of the class identifier is set.
Definition at line 19 of file DC_DataPoolMonitor.cpp.

Member Function Documentation

bool DC_DataPoolMonitor::canExecute ( void ) [protected, virtual]

Encapsulate an execution check that always returns "can execute".

See also:
ConditionalPunctualAction::doAction

Returns:
always returns true.

Implements ConditionalPunctualAction.
Definition at line 23 of file DC_DataPoolMonitor.cpp.

TD_ActionOutcome DC_DataPoolMonitor::doConditionalAction ( void ) [protected, virtual]

Perform the monitoring action on all the items in the data pool.
The data pool is loaded from the CC_RootObject. A pseudo-code implementation of this method is as follows:
pDataPool = CC_RootObject::getDataPool(); for (all items p in pDataPool) { get the value v of p get the monitoring profile m associated to p in pDataPool pass the value v through the monitoring profile m if (monitoring violation detected) { set the validity status of p to "not valid" get the recovery action r associated to p in pDataPool execute r } }
This method always returns: "ACTION_SUCCESS"
See also:
ConditionalPunctualAction::doAction

Returns:
the outcome code of the punctual action

Implements ConditionalPunctualAction.
Definition at line 27 of file DC_DataPoolMonitor.cpp.

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


Public Member Functions
	DC_DataPoolMonitor (void)
	Instantiate a data pool monitor component.
Protected Member Functions
virtual bool	canExecute (void)
	Encapsulate an execution check that always returns "can execute".
virtual TD_ActionOutcome	doConditionalAction (void)
	Perform the monitoring action on all the items in the data pool.