Package jmri.jmrix.can.cbus

Class CbusSensor

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSensor

jmri.jmrix.can.cbus.CbusSensor

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, DigitalIO, AbstractMRListener, CanListener, CbusEventInterface, NamedBean, Sensor

public class CbusSensor
extends AbstractSensor
implements CanListener, CbusEventInterface

Extend jmri.AbstractSensor for CBUS controls.

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 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_STATE, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Sensor

ACTIVE, INACTIVE, MAX_DEBOUNCE

Constructor Summary

Constructors

Constructor	Description
CbusSensor(java.lang.String prefix, java.lang.String address, TrafficController tc)	Create a new CbusSensor.

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	Returns true, can invert.
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
CanMessage	getAddrActive()	Package method returning CanMessage for the Active Sensor Address
CanMessage	getAddrInactive()	Package method returning CanMessage for the Inactive Sensor Address
CanMessage	getBeanOffMessage()	Get event for primary Bean Off Action.
CanMessage	getBeanOnMessage()	Get event for primary Bean On Action.
void	message(CanMessage f)	Track layout status from messages being sent to CAN Called when an outgoing message is sent to the CAN Network.
void	reply(CanReply f)	Event status from messages being received from CAN Called when an incoming CanFrame is received from the CAN Network.
void	requestUpdateFromLayout()	Request an update on status by sending CBUS request message to active address.
void	setKnownState(int s)	User request to set the state.

Methods inherited from class jmri.implementation.AbstractSensor

describeState, getBeanType, getInverted, getKnownState, getPullResistance, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, 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.jmrix.can.CanListener

addTc, addTc, removeTc, removeTc

Methods inherited from interface jmri.jmrix.can.cbus.CbusEventInterface

checkEvent

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, 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

Constructor Detail

CbusSensor

public CbusSensor(java.lang.String prefix,
                  java.lang.String address,
                  TrafficController tc)

Create a new CbusSensor.

Parameters:

prefix - Hardware connection system prefix, excluding the S for Sensor..

address - String form of CbusAddress

tc - System Traffic Controller.

Method Detail

requestUpdateFromLayout

public void requestUpdateFromLayout()

Request an update on status by sending CBUS request message to active address. Sends a query message using the active Sensor address. e.g. for a CBUS address "-7;+5", the query will go to event 7. 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

setKnownState

public void setKnownState(int s)
                   throws JmriException

User request to set the state. 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. Unknown / Inconsistent states do not send a message to CBUS, but do update sensor state. Perform setKnownState(int) for implementations that can't actually do it on the layout. Not intended for use by implementations that can.

Specified by:

setKnownState in interface Sensor

Overrides:

setKnownState in class AbstractSensor

Parameters:

s - the state to set

Throws:

JmriException - if unable to set the state

canInvert

public boolean canInvert()

Returns true, can invert. By default, all implementations based on this can invert

Specified by:

canInvert in interface Sensor

Overrides:

canInvert in class AbstractSensor

Returns:

true if can be inverted; false otherwise

getAddrActive

public CanMessage getAddrActive()

Package method returning CanMessage for the Active Sensor Address

Returns:

CanMessage with the Active CBUS Address

getAddrInactive

public CanMessage getAddrInactive()

Package method returning CanMessage for the Inactive Sensor Address

Returns:

CanMessage with the InActive CBUS Address

getBeanOnMessage

public CanMessage getBeanOnMessage()

Get event for primary Bean On Action. e.g. without inversion, Light On.

Specified by:

getBeanOnMessage in interface CbusEventInterface

Returns:

Event for the Action, may be null

getBeanOffMessage

public CanMessage getBeanOffMessage()

Get event for primary Bean Off Action. e.g. without Inversion Light Off.

Specified by:

getBeanOffMessage in interface CbusEventInterface

Returns:

Event for the Action, may be null

message

public void message(CanMessage f)

Track layout status from messages being sent to CAN Called when an outgoing message is sent to the CAN Network.

Specified by:

message in interface CanListener

Parameters:

f - the CanMessage being sent.

reply

public void reply(CanReply f)

Event status from messages being received from CAN Called when an incoming CanFrame is received from the CAN Network.

Specified by:

reply in interface CanListener

Parameters:

f - the CanReply being received.

dispose

public void dispose()

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