RangeProfile Class Reference

#include <RangeProfile.h>

Inheritance diagram for RangeProfile:

List of all members.

Detailed Description

Base class for monitoring profile components that build a monitoring check as a function of a range interval.

The range interval is characterized by a lower bound and by an upper bound and takes the following form: [lowerBound, upperBound]. The lower and upper bounds are settable parameter. The upper bound is constrained to be greater than the lower bound.

This class is abstract because it does not define any specific monitoring checks. It only provides the services to define the range interval

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

Version:: 1.0

Definition at line 37 of file RangeProfile.h.

Public Member Functions

RangeProfile (void)

Instantiate an range monitoring profile.

void setLowerBound (TD_Float lowerBound)

Set the lower bound.

void setUpperBound (TD_Float upperBound)

Set the upper bound.

TD_Float getLowerBound (void) const

Get the lower bound.

TD_Float getUpperBound (void) const

Get the upper bound.

virtual bool isObjectConfigured (void)

Perform a class-specific configuration check on the range monitoring profile: verify that the lower bound is smaller than the upper bound.

Protected Member Functions

virtual bool doProfileCheck (TD_Integer value)

Version of method doProfileCheck() for monitored variables of type TD_Integer.

virtual bool doProfileCheck (TD_Float value)=0

This method shall be implemented by the derived classes.

Constructor & Destructor Documentation

RangeProfile::RangeProfile ( void )

Instantiate an range monitoring profile.
The lower and upper values are both set to zero to signify that the component is not yet configured.
Definition at line 20 of file RangeProfile.cpp.

Member Function Documentation

bool RangeProfile::doProfileCheck ( TD_Integer value ) [protected, virtual]

Version of method doProfileCheck() for monitored variables of type TD_Integer.
The check is performed by using the "TD_Float" version of doProfileCheck. A pseudo-code implementation for this method is as follows:
return doProfileCheck( (TD_Float)value );

See also:
doProfileCheck

Implements MonitoringProfile.
Definition at line 25 of file RangeProfile.cpp.

TD_Float RangeProfile::getLowerBound ( void ) const [inline]

Get the lower bound.

Returns:
the value of the lower bound

Definition at line 17 of file RangeProfile_inl.h.

TD_Float RangeProfile::getUpperBound ( void ) const [inline]

Get the upper bound.

Returns:
the value of the lower bound

Definition at line 21 of file RangeProfile_inl.h.

bool RangeProfile::isObjectConfigured ( void ) [virtual]

Perform a class-specific configuration check on the range monitoring profile: verify that the lower bound is smaller than the upper bound.

Returns:
true if the monitoring profile is configured, false otherwise.

Reimplemented from CC_RootObject.
Definition at line 38 of file RangeProfile.cpp.

void RangeProfile::setLowerBound ( TD_Float lowerBound )

Set the lower bound.

Parameters:

lowerBound the value of the lower bound

Definition at line 30 of file RangeProfile.cpp.

void RangeProfile::setUpperBound ( TD_Float upperBound )

Set the upper bound.

Parameters:

upperBound the value of the lower bound

Definition at line 34 of file RangeProfile.cpp.

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


Public Member Functions
	RangeProfile (void)
	Instantiate an range monitoring profile.
void	setLowerBound (TD_Float lowerBound)
	Set the lower bound.
void	setUpperBound (TD_Float upperBound)
	Set the upper bound.
TD_Float	getLowerBound (void) const
	Get the lower bound.
TD_Float	getUpperBound (void) const
	Get the upper bound.
virtual bool	isObjectConfigured (void)
	Perform a class-specific configuration check on the range monitoring profile: verify that the lower bound is smaller than the upper bound.
Protected Member Functions
virtual bool	doProfileCheck (TD_Integer value)
	Version of method `doProfileCheck()` for monitored variables of type TD_Integer.
virtual bool	doProfileCheck (TD_Float value)=0
	This method shall be implemented by the derived classes.