com.serotonin.mango.rt.event.detectors

Class StateDetectorRT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlphanumericStateDetectorRT, BinaryStateDetectorRT, MultistateStateDetectorRT

public abstract class StateDetectorRT
extends TimeDelayedEventDetectorRT

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	eventActive State field.
private org.apache.commons.logging.Log	log
private boolean	stateActive State field.
private long	stateActiveTime
private long	stateInactiveTime

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

vo

Constructor Summary

Constructors

Constructor and Description
StateDetectorRT()

Method Summary

Modifier and Type	Method and Description
private void	changeStateActive()
protected long	getConditionActiveTime()
protected boolean	isActive()
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)
protected abstract boolean	stateDetected(PointValueTime newValue)

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, getMessage, 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

log

private final org.apache.commons.logging.Log log

stateActive

private boolean stateActive

State field. Whether the state has been detected or not. This field is used to prevent multiple events being raised during the duration of a single state detection.

stateActiveTime

private long stateActiveTime

stateInactiveTime

private long stateInactiveTime

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 state detection.

Constructor Detail

StateDetectorRT

public StateDetectorRT()

Method Detail

isActive

protected boolean isActive()

isEventActive

public boolean isEventActive()

changeStateActive

private void changeStateActive()

stateDetected

protected abstract boolean stateDetected(PointValueTime newValue)

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)

Specified by:

setEventActive in class TimeDelayedEventDetectorRT