Package jmri.jmrix.rps

Class RpsSensor

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSensor

jmri.jmrix.rps.RpsSensor

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, PropertyChangeProvider, DigitalIO, MeasurementListener, NamedBean, Sensor

public class RpsSensor
extends AbstractSensor
implements MeasurementListener

Extend jmri.AbstractSensor for RPS systems.

System names are "RSpppp", where ppp is a representation of the region, for example "RS(0,0,0);(1,0,0);(1,1,0);(0,1,0)".

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Nested classes/interfaces inherited from interface jmri.Sensor

Sensor.PullResistance

Field Summary

Fields

Modifier and Type	Field	Description
(package private) java.util.ArrayList<java.lang.Integer>	contents
(package private) Region	region

Fields inherited from class jmri.implementation.AbstractSensor

_inverted, _knownState, _rawState, r, sensorDebounceGoingActive, sensorDebounceGoingInActive, thr, useDefaultTimerSettings

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.DigitalIO

OFF, ON

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Sensor

ACTIVE, INACTIVE, MAX_DEBOUNCE, PROPERTY_ACTIVE_TIMER, PROPERTY_GLOBAL_TIMER, PROPERTY_INACTIVE_TIMER, PROPERTY_SENSOR_INVERTED

Constructor Summary

Constructors

Constructor	Description
RpsSensor(java.lang.String systemName, java.lang.String prefix)
RpsSensor(java.lang.String systemName, java.lang.String userName, java.lang.String prefix)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
(package private) java.util.List<java.lang.Integer>	getContents()
(package private) Region	getRegion()
void	notify(Measurement r)
(package private) void	notifyArriving(java.lang.Integer id)	Notify parameter listeners that a device has entered the region covered by this sensor
(package private) void	notifyInRegion(java.lang.Integer id)
(package private) void	notifyLeaving(java.lang.Integer id)	Notify parameter listeners that a device has left the region covered by this sensor
(package private) void	notifyOutOfRegion(java.lang.Integer id)
void	requestUpdateFromLayout()	Request an update from the layout soft/hardware.
void	setOwnState(int state)	Set our internal state information, and notify bean listeners.

Methods inherited from class jmri.implementation.AbstractSensor

canInvert, describeState, getBeanType, getInverted, getKnownState, getPullResistance, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, setKnownState, setPullResistance, setReporter, setSensorDebounceGoingActiveTimer, setSensorDebounceGoingInActiveTimer, setState, setUseDefaultTimerSettings, stateChangeCheck

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Sensor

getCommandedState, isConsistentState, setCommandedState

Field Detail

region

transient Region region

contents

java.util.ArrayList<java.lang.Integer> contents

Constructor Detail

RpsSensor

public RpsSensor(java.lang.String systemName,
                 java.lang.String prefix)

RpsSensor

public RpsSensor(java.lang.String systemName,
                 java.lang.String userName,
                 java.lang.String prefix)

Method Detail

notify

public void notify(Measurement r)

Specified by:

notify in interface MeasurementListener

setOwnState

public void setOwnState(int state)

Description copied from class: AbstractSensor

Set our internal state information, and notify bean listeners.

Overrides:

setOwnState in class AbstractSensor

Parameters:

state - the new state

getRegion

Region getRegion()

getContents

java.util.List<java.lang.Integer> getContents()

notifyInRegion

void notifyInRegion(java.lang.Integer id)

notifyOutOfRegion

void notifyOutOfRegion(java.lang.Integer id)

notifyLeaving

void notifyLeaving(java.lang.Integer id)

Notify parameter listeners that a device has left the region covered by this sensor

Parameters:

id - Number of region being left

notifyArriving

void notifyArriving(java.lang.Integer id)

Notify parameter listeners that a device has entered the region covered by this sensor

Parameters:

id - Number of region being entered

dispose

public void dispose()

Description copied from class: AbstractNamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

Specified by:

dispose in interface Sensor

Overrides:

dispose in class AbstractSensor

requestUpdateFromLayout

public void requestUpdateFromLayout()

Description copied from interface: DigitalIO

Request an update from the layout soft/hardware. May not even happen, and if it does it will happen later; listen for the result.

Specified by:

requestUpdateFromLayout in interface DigitalIO