jmri.implementation
Class AbstractTurnout

Show UML class diagram

java.lang.Object
  jmri.implementation.AbstractNamedBean
      jmri.implementation.AbstractTurnout

All Implemented Interfaces:

PropertyChangeListener, Serializable, EventListener, NamedBean, Turnout

Direct Known Subclasses:

AcelaTurnout, CbusTurnout, EasyDccTurnout, EcosTurnout, LnTurnout, NceTurnout, SerialTurnout, SerialTurnout, SerialTurnout, SerialTurnout, SerialTurnout, SerialTurnout, SerialTurnout, SprogCSTurnout, SprogTurnout, SRCPTurnout, XNetTurnout, XpaTurnout

public abstract class AbstractTurnout
extends AbstractNamedBean
implements Turnout, Serializable, PropertyChangeListener

Abstract base for the Turnout interface.

Implements basic feedback modes:

• NONE feedback, where the KnownState and CommandedState track each other.
• ONESENSOR feedback where the state of a single sensor specifies THROWN vs CLOSED
• TWOSENSOR feedback, where one sensor specifies THROWN and another CLOSED.

If you want to implement some other feedback, override and modify setCommandedState() here.

Implements the parameter binding support.

Note that we consider it an error for there to be more than one object that corresponds to a particular physical turnout on the layout.

Turnout system names are always upper case.

See Also:

Serialized Form

Field Summary

Fields inherited from interface jmri.Turnout

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

Fields inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Method Summary

boolean	canInvert() Determine if the turnouts can be inverted.
boolean	canLock(int turnoutLockout) Determine if turnout can be locked.
void	dispose() Deactivate this object, so that it releases as many resources as possible and no longer effects others.
void	enableLockOperation(int turnoutLockout, boolean enabled) Enable turnout lock operators.
int	getCommandedState() Query the commanded state.
int	getControlType() Get control type.
TurnoutOperator	getCurrentOperator()
String	getDecoderName() Get a human readable representation of the decoder type for this turnout.
int	getFeedbackMode() Get the feedback mode in machine readable form.
String	getFeedbackModeName() Get the feedback mode in human readable form.
Sensor	getFirstSensor() Get the first sensor, if defined.
boolean	getInhibitOperation() Get the indicator for whether automatic operation (retry) has been inhibited for this turnout
boolean	getInverted() Get the turnout inverted state.
int	getKnownState() Query the known state.
boolean	getLocked(int turnoutLockout) Determine if turnout is locked.
int	getNumberOutputBits() Get number of output bits.
boolean	getReportLocked() When true, report to console anytime a cab attempts to change the state of a turnout on the layout.
Sensor	getSecondSensor() Get the Second sensor, if defined.
int	getState() Implement a shorter name for getKnownState.
TurnoutOperation	getTurnoutOperation()
String[]	getValidDecoderNames() Get a human readable representation of the decoder types.
String[]	getValidFeedbackNames() Get a human readable representation of the feedback type.
int	getValidFeedbackTypes() Get a representation of the feedback type.
boolean	isConsistentState() Show whether state is one you can safely run trains over
void	propertyChange(PropertyChangeEvent evt) React to sensor changes by changing the KnownState if using an appropriate sensor mode
void	provideFirstFeedbackSensor(Sensor s) Provide Sensor objects needed for some feedback types.
void	provideSecondFeedbackSensor(Sensor s)
void	setBinaryOutput(boolean state) Turn this object into just a binary output.
void	setCommandedState(int s) Public access to changing turnout state.
void	setControlType(int num) Set control type.
void	setDecoderName(String decoderName) Set a human readable representation of the decoder type for this turnout.
void	setFeedbackMode(int mode) Set the feedback mode from a integer.
void	setFeedbackMode(String mode) Set the feedback mode from a human readable name.
void	setInhibitOperation(boolean io) Change the value of the inhibit operation indicator
void	setInitialKnownStateFromFeedback() Sets the initial known state (CLOSED,THROWN,UNKNOWN) from feedback information, if appropriate.
void	setInverted(boolean inverted) Set turnout inverted If true commands are reversed to layout
void	setLocked(int turnoutLockout, boolean locked) Turnouts that are locked should only respond to JMRI commands to change state.
void	setNumberOutputBits(int num) Set number of output bits.
void	setReportLocked(boolean reportLocked) When true, report to console anytime a cab attempts to change the state of a turnout on the layout.
void	setState(int s) Implement a shorter name for setCommandedState.
void	setTurnoutOperation(TurnoutOperation toper) set current automation class

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, getComment, getDisplayName, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, getComment, getDisplayName, getNumPropertyChangeListeners, getProperty, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName

Method Detail

getKnownState

public int getKnownState()

Description copied from interface: Turnout

Query the known state. This is a bound parameter, so you can also register a listener to be informed of changes. A result is always returned; if no other feedback method is available, the commanded state will be used.

Specified by:

getKnownState in interface Turnout

setCommandedState

public void setCommandedState(int s)

Public access to changing turnout state. Sets the commanded state and, if appropriate starts a TurnoutOperator to do its thing. If there is no TurnoutOperator (not required or nothing suitable) then just tell the layout and hope for the best.

Specified by:

setCommandedState in interface Turnout

getCommandedState

public int getCommandedState()

Description copied from interface: Turnout

Query the commanded state. This is a bound parameter, so you can also register a listener to be informed of changes.

Specified by:

getCommandedState in interface Turnout

isConsistentState

public boolean isConsistentState()

Show whether state is one you can safely run trains over

Specified by:

isConsistentState in interface Turnout

Returns:

true iff state is a valid one and the known state is the same as commanded

setState

public void setState(int s)

Implement a shorter name for setCommandedState.

This generally shouldn't be used by Java code; use setCommandedState instead. The is provided to make Jython script access easier to read.

Note that getState() and setState(int) are not symmetric: getState is the known state, and set state modifies the commanded state.

Specified by:

setState in interface NamedBean

getState

public int getState()

Implement a shorter name for getKnownState.

This generally shouldn't be used by Java code; use getKnownState instead. The is provided to make Jython script access easier to read.

Note that getState() and setState(int) are not symmetric: getState is the known state, and set state modifies the commanded state.

Specified by:

getState in interface NamedBean

getNumberOutputBits

public int getNumberOutputBits()

Description copied from interface: Turnout

Get number of output bits.

Currently must be one or two.

Specified by:

getNumberOutputBits in interface Turnout

setNumberOutputBits

public void setNumberOutputBits(int num)

Description copied from interface: Turnout

Set number of output bits.

Currently must be one or two.

Specified by:

setNumberOutputBits in interface Turnout

getControlType

public int getControlType()

Description copied from interface: Turnout

Get control type.

Currently must be either 0 for steady state, or n for pulse for n time units.

Specified by:

getControlType in interface Turnout

setControlType

public void setControlType(int num)

Description copied from interface: Turnout

Set control type.

Currently must be either 0 for steady state, or n for pulse for n time units.

Specified by:

setControlType in interface Turnout

getValidFeedbackTypes

public int getValidFeedbackTypes()

Description copied from interface: Turnout

Get a representation of the feedback type. This is the OR of possible values: DIRECT, EXACT, etc. The valid combinations depend on the implemented system.

Specified by:

getValidFeedbackTypes in interface Turnout

getValidFeedbackNames

public String[] getValidFeedbackNames()

Description copied from interface: Turnout

Get a human readable representation of the feedback type. The values depend on the implemented system.

Specified by:

getValidFeedbackNames in interface Turnout

setFeedbackMode

public void setFeedbackMode(String mode)
                     throws IllegalArgumentException

Description copied from interface: Turnout

Set the feedback mode from a human readable name. This must be one of the names defined in a previous Turnout.getValidFeedbackNames() call.

Specified by:

setFeedbackMode in interface Turnout

Throws:

IllegalArgumentException

setFeedbackMode

public void setFeedbackMode(int mode)
                     throws IllegalArgumentException

Description copied from interface: Turnout

Set the feedback mode from a integer. This must be one of the bit values defined in a previous Turnout.getValidFeedbackTypes() call. Having more than one bit set is an error.

Specified by:

setFeedbackMode in interface Turnout

Throws:

IllegalArgumentException

getFeedbackMode

public int getFeedbackMode()

Description copied from interface: Turnout

Get the feedback mode in machine readable form. This will be one of the bits defined in a Turnout.getValidFeedbackTypes() call.

Specified by:

getFeedbackMode in interface Turnout

getFeedbackModeName

public String getFeedbackModeName()

Description copied from interface: Turnout

Get the feedback mode in human readable form. This will be one of the names defined in a Turnout.getValidFeedbackNames() call.

Specified by:

getFeedbackModeName in interface Turnout

setInverted

public void setInverted(boolean inverted)

Description copied from interface: Turnout

Set turnout inverted

If true commands are reversed to layout

Specified by:

setInverted in interface Turnout

getInverted

public final boolean getInverted()

Get the turnout inverted state. If true, commands sent to the layout are reversed. Thrown becomes Closed, and Closed becomes Thrown.

Used in polling loops in system-specific code, so made final to allow optimization.

Specified by:

getInverted in interface Turnout

canInvert

public boolean canInvert()

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

Specified by:

canInvert in interface Turnout

setLocked

public void setLocked(int turnoutLockout,
                      boolean locked)

Turnouts that are locked should only respond to JMRI commands to change state. We simulate a locked turnout by monitoring the known state (turnout feedback is required) and if we detect that the known state has changed, negate it by forcing the turnout to return to the commanded state. Turnout that have local buttons can also be locked if their decoder supports it.

Specified by:

setLocked in interface Turnout

Parameters:

locked -

getLocked

public boolean getLocked(int turnoutLockout)

Determine if turnout is locked. Returns true if turnout is locked. There are two types of locks, cab lockout, and pushbutton lockout.

Specified by:

getLocked in interface Turnout

canLock

public boolean canLock(int turnoutLockout)

Description copied from interface: Turnout

Determine if turnout can be locked. Must specify the type of lock.

If true turnouts can be locked.

Specified by:

canLock in interface Turnout

enableLockOperation

public void enableLockOperation(int turnoutLockout,
                                boolean enabled)

Description copied from interface: Turnout

Enable turnout lock operators.

If true the type of lock specified is enabled.

Specified by:

enableLockOperation in interface Turnout

setReportLocked

public void setReportLocked(boolean reportLocked)

When true, report to console anytime a cab attempts to change the state of a turnout on the layout. When a turnout is cab locked, only JMRI is allowed to change the state of a turnout.

Specified by:

setReportLocked in interface Turnout

getReportLocked

public boolean getReportLocked()

When true, report to console anytime a cab attempts to change the state of a turnout on the layout. When a turnout is cab locked, only JMRI is allowed to change the state of a turnout.

Specified by:

getReportLocked in interface Turnout

getValidDecoderNames

public String[] getValidDecoderNames()

Description copied from interface: Turnout

Get a human readable representation of the decoder types.

Specified by:

getValidDecoderNames in interface Turnout

getDecoderName

public String getDecoderName()

Description copied from interface: Turnout

Get a human readable representation of the decoder type for this turnout.

Specified by:

getDecoderName in interface Turnout

setDecoderName

public void setDecoderName(String decoderName)

Description copied from interface: Turnout

Set a human readable representation of the decoder type for this turnout.

Specified by:

setDecoderName in interface Turnout

getCurrentOperator

public TurnoutOperator getCurrentOperator()

getTurnoutOperation

public TurnoutOperation getTurnoutOperation()

Specified by:

getTurnoutOperation in interface Turnout

Returns:

current operation automation class

setTurnoutOperation

public void setTurnoutOperation(TurnoutOperation toper)

Description copied from interface: Turnout

set current automation class

Specified by:

setTurnoutOperation in interface Turnout

Parameters:

toper - TurnoutOperation subclass instance

getInhibitOperation

public boolean getInhibitOperation()

Description copied from interface: Turnout

Get the indicator for whether automatic operation (retry) has been inhibited for this turnout

Specified by:

getInhibitOperation in interface Turnout

setInhibitOperation

public void setInhibitOperation(boolean io)

Description copied from interface: Turnout

Change the value of the inhibit operation indicator

Specified by:

setInhibitOperation in interface Turnout

provideFirstFeedbackSensor

public void provideFirstFeedbackSensor(Sensor s)

Description copied from interface: Turnout

Provide Sensor objects needed for some feedback types. Since we defined two feeedback methods that require monitoring, we provide these methods to define those sensors to the Turnout.

The second sensor can be null if needed.

Sensor-based feedback will not function until these sensors have been provided.

Specified by:

provideFirstFeedbackSensor in interface Turnout

provideSecondFeedbackSensor

public void provideSecondFeedbackSensor(Sensor s)

Specified by:

provideSecondFeedbackSensor in interface Turnout

getFirstSensor

public Sensor getFirstSensor()

Description copied from interface: Turnout

Get the first sensor, if defined.

Returns null if no Sensor recorded.

Specified by:

getFirstSensor in interface Turnout

getSecondSensor

public Sensor getSecondSensor()

Description copied from interface: Turnout

Get the Second sensor, if defined.

Returns null if no Sensor recorded.

Specified by:

getSecondSensor in interface Turnout

setInitialKnownStateFromFeedback

public void setInitialKnownStateFromFeedback()

Description copied from interface: Turnout

Sets the initial known state (CLOSED,THROWN,UNKNOWN) from feedback information, if appropriate.

This method is designed to be called only when Turnouts are loaded and when a new Turnout is defined in the Turnout table.

No change to known state is made if feedback information is not available. If feedback information is inconsistent, or if sensor definition is missing in ONESENSOR and TWOSENSOR feedback, turnout state is set to UNKNOWN.

Specified by:

setInitialKnownStateFromFeedback in interface Turnout

propertyChange

public void propertyChange(PropertyChangeEvent evt)

React to sensor changes by changing the KnownState if using an appropriate sensor mode

Specified by:

propertyChange in interface PropertyChangeListener

setBinaryOutput

public void setBinaryOutput(boolean state)

Description copied from interface: Turnout

Turn this object into just a binary output.

Specified by:

setBinaryOutput in interface Turnout

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

Overrides:

dispose in class AbstractNamedBean