jmri.jmrix.can.cbus
Class CbusSensor

java.lang.Object
  jmri.implementation.AbstractNamedBean
      jmri.implementation.AbstractSensor
          jmri.jmrix.can.cbus.CbusSensor

All Implemented Interfaces:

Serializable, EventListener, AbstractMRListener, CanListener, NamedBean, Sensor

public class CbusSensor
extends AbstractSensor
implements CanListener

Extend jmri.AbstractSensor for CBUS controls.

Author:

Bob Jacobsen Copyright (C) 2008

See Also:

Serialized Form

Field Summary

Fields inherited from class jmri.implementation.AbstractSensor

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

Fields inherited from class jmri.implementation.AbstractNamedBean

mSystemName, mUserName

Fields inherited from interface jmri.Sensor

ACTIVE, INACTIVE

Fields inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Constructor Summary

CbusSensor(String systemName)

CbusSensor(String systemName, String userName)

Method Summary

void	dispose() Deactivate this object, so that it releases as many resources as possible and no longer effects others.
void	message(CanMessage f) Track layout status from messages being sent to CAN
void	reply(CanReply f) Track layout status from messages being received from CAN
void	requestUpdateFromLayout() Request an update on status by sending CBUS message.
void	setKnownState(int s) User request to set the state, which means that we broadcast that to all listeners by putting it out on CBUS.

Methods inherited from class jmri.implementation.AbstractSensor

getInverted, getKnownState, getRawState, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, sensorDebounce, setInverted, setOwnState, setSensorDebounceGoingActiveTimer, setSensorDebounceGoingInActiveTimer, setState, useDefaultTimerSettings, useDefaultTimerSettings

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName, updateListenerRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Sensor

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, setComment, setProperty, setUserName, updateListenerRef

Constructor Detail

CbusSensor

public CbusSensor(String systemName,
                  String userName)

CbusSensor

public CbusSensor(String systemName)

Method Detail

requestUpdateFromLayout

public void requestUpdateFromLayout()

Request an update on status by sending CBUS message.

There is no known way to do this, so the request is just ignored.

Specified by:

requestUpdateFromLayout in interface Sensor

setKnownState

public void setKnownState(int s)
                   throws JmriException

User request to set the state, which means that we broadcast that to all listeners by putting it out on CBUS. In turn, the code in this class should use setOwnState to handle internal sets and bean notifies.

Specified by:

setKnownState in interface Sensor

Overrides:

setKnownState in class AbstractSensor

Parameters:

s -

Throws:

JmriException

message

public void message(CanMessage f)

Track layout status from messages being sent to CAN

Specified by:

message in interface CanListener

Parameters:

f -

reply

public void reply(CanReply f)

Track layout status from messages being received from CAN

Specified by:

reply in interface CanListener

Parameters:

f -

dispose

public void dispose()

Description copied from interface: NamedBean

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 AbstractNamedBean