limits_alarm Class Reference

#include <limits_alarm.h>

Inheritance diagram for limits_alarm:

Inheritance graph
[legend]
Collaboration diagram for limits_alarm:

Collaboration graph
[legend]
List of all members.

Detailed Description

Function Block interface for checking the process value exceeding limits.


Public Member Functions

virtual void get_input (float &x, float &h, float &l, float &eps) const=0
virtual bool get_result () const=0
virtual bool is_high_alert () const=0
virtual bool is_low_alert () const=0
virtual void set_input (const float x, const float h, const float l, const float eps)=0
virtual void set_lower_checker (hysteresis *hyst)=0
virtual void set_upper_checker (hysteresis *hyst)=0


Member Function Documentation

virtual void limits_alarm::get_input ( float &  x,
float &  h,
float &  l,
float &  eps 
) const [pure virtual]

Gets the input values of the function block. Should be called before en().

Parameters:
x - value of x (process value)
h - value of high limit
l - value of low limit
eps - value of eps

Implemented in limits_alarm_impl.

virtual bool limits_alarm::get_result (  )  const [pure virtual]

Delivers the result of the algorithm. Should be called after en(). return true - value exceeds the limit.

Implemented in limits_alarm_impl.

virtual bool limits_alarm::is_high_alert (  )  const [pure virtual]

Is true, if value exceeds the high limit. return true - value exceeds the high limit.

Implemented in limits_alarm_impl.

virtual bool limits_alarm::is_low_alert (  )  const [pure virtual]

Is true, if value exceeds the low limit. return true - value exceeds the low limit.

Implemented in limits_alarm_impl.

virtual void limits_alarm::set_input ( const float  x,
const float  h,
const float  l,
const float  eps 
) [pure virtual]

Sets the input values of the function block. Should be called before en().

Parameters:
x - value of x (process value)
h - value of high limit
l - value of low limit
eps - value of eps

Implemented in limits_alarm_impl.

virtual void limits_alarm::set_lower_checker ( hysteresis hyst  )  [pure virtual]

Sets the interface pointer to an instance for lower checker.

Parameters:
hyst - interface pointer to a hysteresis implementation

Implemented in limits_alarm_impl.

virtual void limits_alarm::set_upper_checker ( hysteresis hyst  )  [pure virtual]

Sets the interface pointer to an instance for upper checker.

Parameters:
hyst - interface pointer to a hysteresis implementation

Implemented in limits_alarm_impl.


The documentation for this class was generated from the following file:
Generated on Mon Jan 1 18:42:46 2007 for 03 by  doxygen 1.5.1