Package jmri.jmrix.ecos

Class EcosTurnout

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractTurnout

jmri.jmrix.ecos.EcosTurnout

All Implemented Interfaces:

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

public class EcosTurnout
extends AbstractTurnout
implements EcosListener

Implement a Turnout via ECoS communications.

This object doesn't listen to the Ecos 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.

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) int	_number
static int	DOUBLESLIP
(package private) int	extended
(package private) boolean	masterObjectNumber
(package private) static java.lang.String[]	modeNames
(package private) static int[]	modeValues
(package private) int	newstate
(package private) int	newstateext
(package private) int	objectNumber
(package private) java.lang.String	prefix
(package private) java.lang.String	slaveAddress
(package private) EcosTrafficController	tc
static int	THREEWAY
(package private) EcosTurnoutManager	tm

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
EcosTurnout(int number, java.lang.String prefix, EcosTrafficController etc, EcosTurnoutManager etm)	ECoS turnouts use the NMRA number (0-2044) as their numerical identification in the system name.

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	Determine if the turnouts can be inverted.
protected void	forwardCommandChangeToLayout(int newState)	Handle a request to change state, typically by sending a message to the layout in some child class.
int	getExtended()
int	getNumber()
int	getObject()
java.lang.String	getSlaveAddress()
void	message(EcosMessage m)
void	reply(EcosReply m)
protected void	sendMessage(boolean closed)	Tell the layout to go to new 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	setExtended(int e)
(package private) void	setKnownStateFromCS(int state)	Set the turnout known state to reflect what's been observed from the command station messages.
(package private) void	setMasterObjectNumber(boolean o)
(package private) void	setObjectNumber(int o)
(package private) void	setSlaveAddress(int o)
void	turnoutPushbuttonLockout(boolean b)

Methods inherited from class jmri.implementation.AbstractTurnout

canLock, describeState, dispose, 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 Detail

prefix

java.lang.String prefix

objectNumber

int objectNumber

masterObjectNumber

boolean masterObjectNumber

slaveAddress

java.lang.String slaveAddress

extended

int extended

modeNames

static java.lang.String[] modeNames

modeValues

static int[] modeValues

tc

EcosTrafficController tc

tm

EcosTurnoutManager tm

THREEWAY

public static final int THREEWAY

See Also:

Constant Field Values

DOUBLESLIP

public static final int DOUBLESLIP

See Also:

Constant Field Values

_number

int _number

newstate

int newstate

newstateext

int newstateext

Constructor Detail

EcosTurnout

public EcosTurnout(int number,
                   java.lang.String prefix,
                   EcosTrafficController etc,
                   EcosTurnoutManager etm)

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

Parameters:

number - DCC address of the turnout

prefix - system prefix

etc - system connection traffic controller

etm - ecos turnout manager

Method Detail

setExtended

void setExtended(int e)

setObjectNumber

void setObjectNumber(int o)

setSlaveAddress

void setSlaveAddress(int o)

setMasterObjectNumber

void setMasterObjectNumber(boolean o)

getNumber

public int getNumber()

getObject

public int getObject()

getExtended

public int getExtended()

getSlaveAddress

public java.lang.String getSlaveAddress()

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

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:

ECoS turnouts can be inverted

sendMessage

protected void sendMessage(boolean closed)

Tell the layout to go to new state.

Parameters:

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

reply

public void reply(EcosReply m)

Specified by:

reply in interface EcosListener

message

public void message(EcosMessage m)

Specified by:

message in interface EcosListener