Package jmri.jmrix.openlcb

Class OlcbTurnout

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractTurnout

jmri.jmrix.openlcb.OlcbTurnout

All Implemented Interfaces:

PropertyChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, DigitalIO, NamedBean, Turnout, VariableControlSpanBean

public final class OlcbTurnout
extends AbstractTurnout

Turnout for OpenLCB connections.

State Diagram for read and write operations (click to magnify):

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) OlcbAddress	addrClosed
(package private) OlcbAddress	addrThrown
(package private) EventTable.EventTableEntryHolder	closedEventTableEntryHolder
(package private) static final boolean	DEFAULT_IS_AUTHORITATIVE
(package private) static final boolean	DEFAULT_LISTEN
(package private) BitProducerConsumer	pc
(package private) EventTable.EventTableEntryHolder	thrownEventTableEntryHolder
(package private) VersionedValueListener<Boolean>	turnoutListener

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_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Turnout

CABLOCKOUT, CLOSED, DELAYED, DIRECT, EXACT, INDIRECT, LNALTERNATE, LOCKED, MONITORING, ONESENSOR, PROPERTY_COMMANDED_STATE, PROPERTY_DECODER_NAME, PROPERTY_FEEDBACK_MODE, PROPERTY_INVERTED, PROPERTY_LEADING_TURNOUT, PROPERTY_LOCKED, PROPERTY_REPORT_LOCKED, PROPERTY_TURNOUT_DIVERGING_SPEED, PROPERTY_TURNOUT_FEEDBACK_FIRST_SENSOR, PROPERTY_TURNOUT_FEEDBACK_SECOND_SENSOR, PROPERTY_TURNOUT_OPERATION_STATE, PROPERTY_TURNOUT_STRAIGHT_SPEED, PUSHBUTTONLOCKOUT, SIGNAL, THROWN, TWOSENSOR, UNLOCKED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OlcbTurnout(String prefix, String address, CanSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	Determine if the turnouts can be inverted.
int	compareSystemNameSuffix(String suffix1, String suffix2, NamedBean n)	Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation.
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 feedback 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.
EventID	getEventID(boolean isThrown)
String	getEventName(boolean isThrown)	Computes the display name of a given event to be entered into the Event Table.
String	getRecommendedToolTip()	Get a recommended text for a tooltip when displaying the NamedBean, e.g. in a list or table.
boolean	isAuthoritative()
boolean	isListeningToStateMessages()
void	requestUpdateFromLayout()	Request an update from the layout soft/hardware.
void	setAuthoritative(boolean authoritative)	Changes how the turnout reacts to inquire state events.
void	setFeedbackMode(int mode)	On change, fires Property Change "feedbackchange".
void	setListeningToStateMessages(boolean listen)	Changes how the turnout reacts to state declaration messages.
void	setProperty(String key, Object value)	Attach a key/value pair to the NamedBean, which can be retrieved later.
void	setUserName(String s)	Updates event table entries when the user name changes.
protected void	turnoutPushbuttonLockout(boolean locked)

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, 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, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, 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, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, removeProperty, setComment, toString, updateListenerRef

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Turnout

provideFeedbackSensor

Field Details

addrThrown

OlcbAddress addrThrown

addrClosed

OlcbAddress addrClosed

turnoutListener

VersionedValueListener<Boolean> turnoutListener

pc

BitProducerConsumer pc

thrownEventTableEntryHolder

EventTable.EventTableEntryHolder thrownEventTableEntryHolder

closedEventTableEntryHolder

EventTable.EventTableEntryHolder closedEventTableEntryHolder

DEFAULT_IS_AUTHORITATIVE

static final boolean DEFAULT_IS_AUTHORITATIVE

See Also:

• Constant Field Values

DEFAULT_LISTEN

static final boolean DEFAULT_LISTEN

See Also:

• Constant Field Values

Constructor Details

OlcbTurnout

protected OlcbTurnout(String prefix,
 String address,
 CanSystemConnectionMemo memo)

Method Details

finishLoad

public void finishLoad()

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

getEventName

public String getEventName(boolean isThrown)

Computes the display name of a given event to be entered into the Event Table.

Parameters:

isThrown - true for thrown event, false for closed event

Returns:

user-visible string to represent this event.

getEventID

public EventID getEventID(boolean isThrown)

getRecommendedToolTip

@CheckReturnValue
@Nonnull
public String getRecommendedToolTip()

Description copied from interface: NamedBean

Get a recommended text for a tooltip when displaying the NamedBean, e.g. in a list or table. By default, this is the comment from the NamedBean, on the theory that the system name and/or user name are being displayed directly. Specific system implementations may override that.

Returns:

empty String if no recommendation.

setUserName

@OverridingMethodsMustInvokeSuper
public void setUserName(String s)
                 throws NamedBean.BadUserNameException

Updates event table entries when the user name changes.

Specified by:

setUserName in interface NamedBean

Overrides:

setUserName in class AbstractNamedBean

Parameters:

s - new user name

Throws:

NamedBean.BadUserNameException - see NamedBean

setFeedbackMode

public void setFeedbackMode(int mode)
                     throws IllegalArgumentException

Description copied from class: AbstractTurnout

On change, fires Property Change "feedbackchange". 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

Overrides:

setFeedbackMode in class AbstractTurnout

Parameters:

mode - the feedback type to set

Throws:

IllegalArgumentException - if mode is not valid

setProperty

public void setProperty(@Nonnull
 String key,
 Object value)

Description copied from class: AbstractNamedBean

Attach a key/value pair to the NamedBean, which can be retrieved later. These are not bound properties as yet, and don't throw events on modification. Key must not be null.

The key is constrained to String to make these behave like normal Java Beans.

Specified by:

setProperty in interface NamedBean

Overrides:

setProperty in class AbstractNamedBean

Parameters:

key - the property to set

value - the value of the property

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. Sends an OpenLCB command

Specified by:

forwardCommandChangeToLayout in class AbstractTurnout

Parameters:

s - new state value

requestUpdateFromLayout

public void requestUpdateFromLayout()

Description copied from class: AbstractTurnout

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 locked)

Specified by:

turnoutPushbuttonLockout in class AbstractTurnout

canInvert

public boolean canInvert()

Description copied from class: AbstractTurnout

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

dispose

public void dispose()

Description copied from class: AbstractTurnout

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 AbstractTurnout

setAuthoritative

public void setAuthoritative(boolean authoritative)

Changes how the turnout reacts to inquire state events. With authoritative == false the state will always be reported as UNKNOWN to the layout when queried.

Parameters:

authoritative - whether we should respond true state or unknown to the layout event state inquiries.

isAuthoritative

public boolean isAuthoritative()

Returns:

whether this producer/consumer is enabled to return state to the layout upon queries.

isListeningToStateMessages

public boolean isListeningToStateMessages()

Returns:

whether this producer/consumer is always listening to state declaration messages.

setListeningToStateMessages

public void setListeningToStateMessages(boolean listen)

Changes how the turnout reacts to state declaration messages. With listen == true state declarations will update local state at all times. With listen == false state declarations will update local state only if local state is unknown.

Parameters:

listen - whether we should always listen to state declaration messages.

compareSystemNameSuffix

@CheckReturnValue
public int compareSystemNameSuffix(@Nonnull
 String suffix1,
 @Nonnull
 String suffix2,
 @Nonnull
 NamedBean n)

Compare the suffix of this NamedBean's name with the suffix of the argument NamedBean's name for the NamedBean.compareTo(jmri.NamedBean) operation. This is intended to be a system-specific comparison that understands the various formats, etc. By default, does an alphanumeric-by-chunks comparison. Sorts by decoded EventID(s)

Specified by:

compareSystemNameSuffix in interface NamedBean

Overrides:

compareSystemNameSuffix in class AbstractNamedBean

Parameters:

suffix1 - The suffix for the 1st bean in the comparison

suffix2 - The suffix for the 2nd bean in the comparison

n - The other (second) NamedBean in the comparison

Returns:

-1,0,+1 for ordering if the names are well-formed; may not provide proper ordering if the names are not well-formed.