com.serotonin.mango.rt.event.detectors

Class PositiveCusumDetectorRT

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.PositiveCusumDetectorRT

All Implemented Interfaces:

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

public class PositiveCusumDetectorRT
extends TimeDelayedEventDetectorRT

The PositiveCusumDetector is used to detect occurances of point values exceeding the given CUSUM limit for a given duration. For example, a user may need to have an event raised when a temperature CUSUM exceeds some value for 10 minutes or more.

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private double	cusum State field.
private boolean	eventActive State field.
private boolean	positiveCusumActive State field.
private long	positiveCusumActiveTime
private long	positiveCusumInactiveTime

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

vo

Constructor Summary

Constructors

Constructor and Description
PositiveCusumDetectorRT(PointEventDetectorVO vo)

Method Summary

Modifier and Type	Method and Description
private void	changePositiveCusumActive() This method is only called when the positive CUSUM changes between being active or not, i.e. if the point's CUSUM is currently above the limit, then it should never be called with a value of true.
protected long	getConditionActiveTime()
com.serotonin.web.i18n.LocalizableMessage	getMessage()
boolean	isEventActive()
void	pointUpdated(PointValueTime newValue) This method is called every time the point gets a value from somewhere (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, pointChanged, pointInitialized, pointSet, pointTerminated, 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

cusum

private double cusum

State field. The current positive CUSUM for the point.

positiveCusumActive

private boolean positiveCusumActive

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

positiveCusumActiveTime

private long positiveCusumActiveTime

positiveCusumInactiveTime

private long positiveCusumInactiveTime

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 positive CUSUM exceed.

Constructor Detail

PositiveCusumDetectorRT

public PositiveCusumDetectorRT(PointEventDetectorVO vo)

Method Detail

getMessage

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

Specified by:

getMessage in class PointEventDetectorRT

isEventActive

public boolean isEventActive()

changePositiveCusumActive

private void changePositiveCusumActive()

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

Parameters:

b -

pointUpdated

public void pointUpdated(PointValueTime newValue)

Description copied from interface: DataPointListener

This method is called every time the point gets a value from somewhere (except for its initialization). This includes when the point changes or is set.

Specified by:

pointUpdated in interface DataPointListener

Overrides:

pointUpdated 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 postive CUSUM is active before allowing the event to go active.

Specified by:

setEventActive in class TimeDelayedEventDetectorRT

Parameters:

b -