Package jmri.jmrix.marklin

Class MarklinTurnout

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractTurnout

jmri.jmrix.marklin.MarklinTurnout

All Implemented Interfaces:

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

public class MarklinTurnout
extends AbstractTurnout
implements MarklinListener

Implement a Turnout via Marklin communications.

This object doesn't listen to the Marklin communications. This is because it should be the only object that is sending messages for this turnout; more than one Turnout object pointing to a single device is not allowed.

Based on work by Bob Jacobsen

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) static final int	DCC
(package private) static final int	METERINTERVAL
(package private) static final int	MM2
(package private) static final int	PROTOCOL_UNKNOWN
(package private) static final int	SFX

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

Constructor	Description
MarklinTurnout(int number, String prefix, MarklinTrafficController etc)	Marklin turnouts use the NMRA number (0-2040) as their numerical identification in the system name.

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	Marklin turnouts can be inverted
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
protected void	forwardCommandChangeToLayout(int newState)	Handle a request to change state, typically by sending a message to the layout in some child class.
(package private) int	getCANAddress()
void	message(MarklinMessage m)
void	reply(MarklinReply m)
protected void	sendMessage(boolean newstate)	Tell the layout to go to new state.
protected void	sendOffMessage(int state)
(package private) void	setCommandedStateFromCS(int state)	Set the turnout known state to reflect what's been observed from the command station messages.
(package private) void	setKnownStateFromCS(int state)	Set the turnout known state to reflect what's been observed from the command station messages.
void	turnoutPushbuttonLockout(boolean b)

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, requestUpdateFromLayout, 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 Details

PROTOCOL_UNKNOWN

static final int PROTOCOL_UNKNOWN

See Also:

• Constant Field Values

DCC

static final int DCC

See Also:

• Constant Field Values

MM2

static final int MM2

See Also:

• Constant Field Values

SFX

static final int SFX

See Also:

• Constant Field Values

METERINTERVAL

static final int METERINTERVAL

See Also:

• Constant Field Values

Constructor Details

MarklinTurnout

public MarklinTurnout(int number,
 String prefix,
 MarklinTrafficController etc)

Marklin turnouts use the NMRA number (0-2040) as their numerical identification in the system name.

Parameters:

number - address of the turnout

prefix - system prefix

etc - connection traffic controller

Method Details

forwardCommandChangeToLayout

protected void forwardCommandChangeToLayout(int newState)

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:

newState - new state value

setCommandedStateFromCS

void setCommandedStateFromCS(int state)

Set the turnout known state to reflect what's been observed from the command station messages. A change there means that somebody commanded a state change (by using a throttle), and that command has already taken effect. Hence we use "newCommandedState" to indicate it's taken place. Must be followed by "newKnownState" to complete the turnout action.

Parameters:

state - Observed state, updated state from command station

setKnownStateFromCS

void setKnownStateFromCS(int state)

Set the turnout known state to reflect what's been observed from the command station messages. A change there means that somebody commanded a state change (by using a throttle), and that command has already taken effect. Hence we use "newKnownState" to indicate it's taken place.

Parameters:

state - Observed state, updated state from command station

turnoutPushbuttonLockout

public void turnoutPushbuttonLockout(boolean b)

Specified by:

turnoutPushbuttonLockout in class AbstractTurnout

canInvert

public boolean canInvert()

Marklin turnouts can be inverted

Specified by:

canInvert in interface Turnout

Overrides:

canInvert in class AbstractTurnout

Returns:

invert supported

sendMessage

protected void sendMessage(boolean newstate)

Tell the layout to go to new state.

Parameters:

newstate - State of the turnout to be sent to the command station

getCANAddress

int getCANAddress()

reply

public void reply(MarklinReply m)

Specified by:

reply in interface MarklinListener

message

public void message(MarklinMessage m)

Specified by:

message in interface MarklinListener

sendOffMessage

protected void sendOffMessage(int state)

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