com.serotonin.mango.rt.event.detectors

Class AnalogHighLimitDetectorRT

java.lang.Object

com.serotonin.mango.rt.event.SimpleEventDetector

com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

com.serotonin.mango.rt.event.detectors.TimeoutDetectorRT

com.serotonin.mango.rt.event.detectors.TimeDelayedEventDetectorRT

com.serotonin.mango.rt.event.detectors.AnalogHighLimitDetectorRT

All Implemented Interfaces:

DataPointListener, EventDetector, TimeoutClient, com.serotonin.util.ILifecycle

public class AnalogHighLimitDetectorRT
extends TimeDelayedEventDetectorRT

The AnalogHighLimitDetector is used to detect occurrences of point values exceeding the given high limit for a given duration. For example, a user may need to have an event raised when a temperature exceeds some value for 10 minutes or more. The configuration fields provided are static for the lifetime of this detector. The state fields vary based on the changing conditions in the system. In particular, the highLimitActive field describes whether the point's value is currently above the high limit or not. The eventActive field describes whether the point's value has been above the high limit for longer than the tolerance duration.

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	eventActive State field.
private boolean	highLimitActive State field.
private long	highLimitActiveTime
private long	highLimitInactiveTime

Fields inherited from class com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

vo

Constructor Summary

Constructors

Constructor and Description
AnalogHighLimitDetectorRT(PointEventDetectorVO vo)

Method Summary

Modifier and Type	Method and Description
private void	changeHighLimitActive() This method is only called when the high limit changes between being active or not, i.e. if the point's value is currently above the high limit, then it should never be called with a value of true.
protected long	getConditionActiveTime()
com.serotonin.web.i18n.LocalizableMessage	getMessage()
boolean	isEventActive()
void	pointChanged(PointValueTime oldValue, PointValueTime newValue) This method is called every time the point gets a value that is different from its previous value (except for its initialization).
void	setEventActive(boolean b) This method is only called when the event changes between being active or not, i.e. if the event currently is active, then it should never be called with a value of true.

Methods inherited from class com.serotonin.mango.rt.event.detectors.TimeDelayedEventDetectorRT

initialize, initializeState, scheduleJob, scheduleTimeoutImpl, unscheduleJob

Methods inherited from class com.serotonin.mango.rt.event.detectors.TimeoutDetectorRT

getDurationDescription, getDurationMS, isJobScheduled, scheduleJob, scheduleTimeout, terminate, unscheduleJob

Methods inherited from class com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

createEventContext, getEventDetectorKey, getEventType, joinTermination, pointBackdated, pointInitialized, pointSet, pointTerminated, pointUpdated, raiseEvent, returnToNormal

Methods inherited from class com.serotonin.mango.rt.event.SimpleEventDetector

addListener, fireEventDetectorStateChanged, fireEventDetectorTerminated, hasListeners, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

highLimitActive

private boolean highLimitActive

State field. Whether the high limit is currently active or not. This field is used to prevent multiple events being raised during the duration of a single high limit exceed.

highLimitActiveTime

private long highLimitActiveTime

highLimitInactiveTime

private long highLimitInactiveTime

eventActive

private boolean eventActive

State field. Whether the event is currently active or not. This field is used to prevent multiple events being raised during the duration of a single high limit exceed.

Constructor Detail

AnalogHighLimitDetectorRT

public AnalogHighLimitDetectorRT(PointEventDetectorVO vo)

Method Detail

getMessage

public com.serotonin.web.i18n.LocalizableMessage getMessage()

Specified by:

getMessage in class PointEventDetectorRT

isEventActive

public boolean isEventActive()

changeHighLimitActive

private void changeHighLimitActive()

This method is only called when the high limit changes between being active or not, i.e. if the point's value is currently above the high limit, then it should never be called with a value of true.

Parameters:

b -

pointChanged

public void pointChanged(PointValueTime oldValue,
                         PointValueTime newValue)

Description copied from interface: DataPointListener

This method is called every time the point gets a value that is different from its previous value (except for its initialization). This includes when the point is set, if the set changes the point's value.

Specified by:

pointChanged in interface DataPointListener

Overrides:

pointChanged in class PointEventDetectorRT

getConditionActiveTime

protected long getConditionActiveTime()

Specified by:

getConditionActiveTime in class TimeDelayedEventDetectorRT

setEventActive

public void setEventActive(boolean b)

This method is only called when the event changes between being active or not, i.e. if the event currently is active, then it should never be called with a value of true. That said, provision is made to ensure that the high limit is active before allowing the event to go active.

Specified by:

setEventActive in class TimeDelayedEventDetectorRT

Parameters:

b -