Package jmri.jmrix.can.cbus
Class CbusLight
- java.lang.Object
-
- jmri.implementation.AbstractNamedBean
-
- jmri.implementation.AbstractLight
-
- jmri.jmrix.can.cbus.CbusLight
-
- All Implemented Interfaces:
java.lang.Comparable<NamedBean>
,java.util.EventListener
,PropertyChangeProvider
,DigitalIO
,AbstractMRListener
,CanListener
,CbusEventInterface
,Light
,NamedBean
public class CbusLight extends AbstractLight implements CanListener, CbusEventInterface
Light implementation for CBUS connections.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.NamedBean
NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException
-
-
Field Summary
-
Fields inherited from class jmri.implementation.AbstractLight
lightControlList, mActive, mCurrentIntensity, mEnabled, mMaxIntensity, mMinIntensity, mState
-
Fields inherited from class jmri.implementation.AbstractNamedBean
listenerRefs, mSystemName, register
-
Fields inherited from interface jmri.Light
FAST_CLOCK_CONTROL, INTERMEDIATE, NO_CONTROL, SENSOR_CONTROL, TIMED_ON_CONTROL, TRANSITIONING, TRANSITIONINGHIGHER, TRANSITIONINGLOWER, TRANSITIONINGTOFULLOFF, TRANSITIONINGTOFULLON, TURNOUT_STATUS_CONTROL, TWO_SENSOR_CONTROL
-
Fields inherited from interface jmri.NamedBean
DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CbusLight(java.lang.String prefix, java.lang.String address, TrafficController tc)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
Deactivate this object, so that it releases as many resources as possible and no longer effects others.protected void
doNewState(int oldState, int newState)
Handle a request to change state by sending CBUS events.CanMessage
getAddrOff()
Get a CanMessage for the Off Light Address.CanMessage
getAddrOn()
Get a CanMessage for the On Light Address.CanMessage
getBeanOffMessage()
Get event for primary Bean Off Action.CanMessage
getBeanOnMessage()
Get event for primary Bean On Action.void
message(CanMessage f)
Called when an outgoing message is sent to the CAN Network.void
reply(CanReply origf)
Called when an incoming CanFrame is received from the CAN Network.void
requestUpdateFromLayout()
Request an update from the layout soft/hardware.-
Methods inherited from class jmri.implementation.AbstractLight
activateLight, addLightControl, clearLightControls, deactivateLight, describeState, getBeanType, getEnabled, getLightControlList, getState, getUsageReport, notifyStateChange, notifyTargetIntensityChange, setEnabled, setState
-
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.Light
getCommandedState, getKnownState, isConsistentState, setCommandedState
-
Methods inherited from interface jmri.NamedBean
addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Constructor Detail
-
CbusLight
protected CbusLight(java.lang.String prefix, java.lang.String address, TrafficController tc)
-
-
Method Detail
-
doNewState
protected void doNewState(int oldState, int newState)
Handle a request to change state by sending CBUS events.- Overrides:
doNewState
in classAbstractLight
- Parameters:
oldState
- old statenewState
- new state
-
requestUpdateFromLayout
public void requestUpdateFromLayout()
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 interfaceDigitalIO
- Specified by:
requestUpdateFromLayout
in interfaceLight
-
message
public void message(CanMessage f)
Called when an outgoing message is sent to the CAN Network.- Specified by:
message
in interfaceCanListener
- Parameters:
f
- the CanMessage being sent.
-
reply
public void reply(CanReply origf)
Called when an incoming CanFrame is received from the CAN Network.- Specified by:
reply
in interfaceCanListener
- Parameters:
origf
- the CanReply being received.
-
getAddrOn
public CanMessage getAddrOn()
Get a CanMessage for the On Light Address.- Returns:
- CanMessage for Light ON
-
getAddrOff
public CanMessage getAddrOff()
Get a CanMessage for the Off Light Address.- Returns:
- CanMessage for Light OFF
-
getBeanOnMessage
public CanMessage getBeanOnMessage()
Get event for primary Bean On Action. e.g. without inversion, Light On.- Specified by:
getBeanOnMessage
in interfaceCbusEventInterface
- 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 interfaceCbusEventInterface
- Returns:
- Event for the Action, may be null
-
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 interfaceNamedBean
- Overrides:
dispose
in classAbstractNamedBean
-
-