Package jmri.jmrix.roco.z21

Class Z21RMBusSensor

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSensor

jmri.jmrix.roco.z21.Z21RMBusSensor

All Implemented Interfaces:

Comparable<NamedBean>, EventListener, PropertyChangeProvider, DigitalIO, AbstractMRListener, Z21Listener, NamedBean, Sensor

public class Z21RMBusSensor
extends AbstractSensor
implements Z21Listener

Extend jmri.AbstractSensor for RocoMotion (RM) bus sensors on the Roco Z21.

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
protected Z21TrafficController	tc

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
Z21RMBusSensor(String systemName, String userName, Z21TrafficController controller, String prefix)
Z21RMBusSensor(String systemName, Z21TrafficController controller, 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) int	getModuleAddress()	Package protected routine to get the Sensor Base Address.
(package private) int	getNumber()	Package protected routine to get the Sensor Number.
(package private) void	initmessage(Z21Reply l)	initmessage is a package protected class which allows the Manger to send a feedback message at initialization without changing the state of the sensor with respect to whether or not a feedback request was sent.
void	message(Z21Message l)	Listen for the messages to the Z21.
void	reply(Z21Reply l)	Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.
void	requestUpdateFromLayout()	Request an update on status by sending an Z21 message.

Methods inherited from class jmri.implementation.AbstractSensor

canInvert, describeState, getBeanType, getInverted, getKnownState, getPullResistance, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, setKnownState, setOwnState, 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 Details

tc

protected Z21TrafficController tc

Constructor Details

Z21RMBusSensor

public Z21RMBusSensor(String systemName,
 String userName,
 Z21TrafficController controller,
 String prefix)

Z21RMBusSensor

public Z21RMBusSensor(String systemName,
 Z21TrafficController controller,
 String prefix)

Method Details

requestUpdateFromLayout

public void requestUpdateFromLayout()

Request an update on status by sending an Z21 message.

Specified by:

requestUpdateFromLayout in interface DigitalIO

initmessage

void initmessage(Z21Reply l)

initmessage is a package protected class which allows the Manger to send a feedback message at initialization without changing the state of the sensor with respect to whether or not a feedback request was sent. This is used only when the sensor is created by on layout feedback.

Parameters:

l - the feedback message to send

reply

public void reply(Z21Reply l)

Description copied from interface: Z21Listener

Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.

Specified by:

reply in interface Z21Listener

Parameters:

l - The received z21 reply. Note that this same object may be presented to multiple users. It should not be modified here.

message

public void message(Z21Message l)

Listen for the messages to the Z21.

Specified by:

message in interface Z21Listener

Parameters:

l - The received z21 message. Note that this same object may be presented to multiple users. It should not be modified here.

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

getNumber

int getNumber()

Package protected routine to get the Sensor Number.

Returns:

Sensor number

getModuleAddress

int getModuleAddress()

Package protected routine to get the Sensor Base Address.

Returns:

address for this module.