Package jmri.jmrix.bidib

Class BiDiBTurnout

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractTurnout

jmri.jmrix.bidib.BiDiBTurnout

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, DigitalIO, BiDiBNamedBeanInterface, NamedBean, Turnout, VariableControlSpanBean

public class BiDiBTurnout
extends AbstractTurnout
implements BiDiBNamedBeanInterface

BiDiB implementation of the Turnout interface.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) BiDiBAddress	addr
(package private) static java.lang.String[]	modeNames
(package private) static int[]	modeValues

Fields inherited from class jmri.implementation.AbstractTurnout

_activeFeedbackType, _cabLockout, _decoderName, _enableCabLockout, _enablePushButtonLockout, _inverted, _pushButtonLockout, _reportLocked, _validDecoderNames, _validFeedbackModes, _validFeedbackNames, _validFeedbackTypes, binaryOutput, DELAYED_FEEDBACK_INTERVAL, inhibitOperation, myOperator, myTurnoutOperation, r, thr

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.Turnout

CABLOCKOUT, CLOSED, DELAYED, DIRECT, EXACT, INDIRECT, LNALTERNATE, LOCKED, MONITORING, ONESENSOR, PUSHBUTTONLOCKOUT, SIGNAL, THROWN, TWOSENSOR, UNLOCKED

Constructor Summary

Constructors

Constructor	Description
BiDiBTurnout(java.lang.String systemName, BiDiBTurnoutManager mgr)	Create a turnout.

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	Determine if the turnouts can be inverted.
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
void	finishLoad()	Helper function that will be invoked after construction once the type has been set.
protected void	forwardCommandChangeToLayout(int s)	Handle a request to change state, typically by sending a message to the layout in some child class.
BiDiBAddress	getAddr()	Get the BiDiB address instance
void	nodeLost()	called then a node was lost
void	nodeNew()	called then a new node has been discovered
void	requestUpdateFromLayout()	Request an update from the layout soft/hardware.
protected void	sendMessage(boolean closed)	Send a thrown/closed message to BiDiB
void	sendQuery()	Request the state of the accessory from the layout.
protected void	turnoutPushbuttonLockout(boolean _pushButtonLockout)

Methods inherited from class jmri.implementation.AbstractTurnout

canLock, describeState, enableLockOperation, forwardCommandChangeToLayout, getBeanType, getCommandedState, getControlType, getCurrentOperator, getDecoderName, getDivergingLimit, getDivergingSpeed, getFeedbackMode, getFeedbackModeForOperation, getFeedbackModeName, getFirstNamedSensor, getFirstSensor, getInhibitOperation, getInverted, getKnownState, getLeadingTurnout, getLocked, getNumberControlBits, getPossibleLockModes, getReportLocked, getSecondNamedSensor, getSecondSensor, getState, getStraightLimit, getStraightSpeed, getTurnoutOperation, getTurnoutOperator, getUsageReport, getValidDecoderNames, getValidFeedbackModes, getValidFeedbackNames, getValidFeedbackTypes, isCanFollow, isConsistentState, isFollowingCommandedState, leadingTurnoutPropertyChange, newCommandedState, newKnownState, operationPropertyChange, propertyChange, provideFirstFeedbackNamedSensor, provideFirstFeedbackSensor, provideSecondFeedbackNamedSensor, provideSecondFeedbackSensor, sensorPropertyChange, setBinaryOutput, setCommandedState, setCommandedStateAtInterval, setControlType, setDecoderName, setDivergingSpeed, setFeedbackMode, setFeedbackMode, setFollowingCommandedState, setInhibitOperation, setInitialKnownStateFromFeedback, setInverted, setLeadingTurnout, setLeadingTurnout, setLocked, setNumberControlBits, setReportLocked, setState, setStraightSpeed, setTurnoutOperation, stateChangeCheck, statesOk, turnoutPushbuttonLockout, vetoableChange

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

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, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Turnout

provideFeedbackSensor

Field Detail

addr

BiDiBAddress addr

modeNames

static java.lang.String[] modeNames

modeValues

static int[] modeValues

Constructor Detail

BiDiBTurnout

public BiDiBTurnout(java.lang.String systemName,
                    BiDiBTurnoutManager mgr)

Create a turnout.

Parameters:

systemName - to be created

mgr - Turnout Manager, we get the memo object and the type letter (T) from the manager

Method Detail

getAddr

public BiDiBAddress getAddr()

Description copied from interface: BiDiBNamedBeanInterface

Get the BiDiB address instance

Specified by:

getAddr in interface BiDiBNamedBeanInterface

Returns:

BiDiBAddress

finishLoad

public void finishLoad()

Helper function that will be invoked after construction once the type has been set. Used specifically for preventing double initialization when loading turnouts from XML.

Specified by:

finishLoad in interface BiDiBNamedBeanInterface

nodeNew

public void nodeNew()

called then a new node has been discovered

Specified by:

nodeNew in interface BiDiBNamedBeanInterface

nodeLost

public void nodeLost()

called then a node was lost

Specified by:

nodeLost in interface BiDiBNamedBeanInterface

canInvert

public boolean canInvert()

Determine if the turnouts can be inverted. If true, inverted turnouts are supported.

Specified by:

canInvert in interface Turnout

Overrides:

canInvert in class AbstractTurnout

Returns:

invert supported

forwardCommandChangeToLayout

protected void forwardCommandChangeToLayout(int s)

Handle a request to change state, typically by sending a message to the layout in some child class. Public version (used by TurnoutOperator) sends the current commanded state without changing it. Implementing classes will typically check the value of s and send a system specific sendMessage command.

Specified by:

forwardCommandChangeToLayout in class AbstractTurnout

Parameters:

s - new state value

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 interface DigitalIO

Overrides:

requestUpdateFromLayout in class AbstractTurnout

turnoutPushbuttonLockout

protected void turnoutPushbuttonLockout(boolean _pushButtonLockout)

Specified by:

turnoutPushbuttonLockout in class AbstractTurnout

sendQuery

public void sendQuery()

Request the state of the accessory from the layout. The listener gets the answer.

sendMessage

protected void sendMessage(boolean closed)

Send a thrown/closed message to BiDiB

Parameters:

closed - true of the turnout should be switched to CLOSED, false to switch to THROWN

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. Remove the Message Listener for this turnout

Specified by:

dispose in interface NamedBean

Overrides:

dispose in class AbstractTurnout