Package jmri.implementation

Class DefaultRoute

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.DefaultRoute

All Implemented Interfaces:

VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, NamedBean, Route

public class DefaultRoute
extends AbstractNamedBean
implements Route, VetoableChangeListener

Class providing the basic logic of the Route interface.

See Also:

• Route

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

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

Field Summary

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

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

MAX_CONTROL_SENSORS, ONACTIVE, ONCHANGE, ONCLOSED, ONINACTIVE, ONTHROWN, PROPERTY_ROUTE_LOCKED, TOGGLE, VETOACTIVE, VETOCLOSED, VETOINACTIVE, VETOTHROWN

Constructor Summary

Constructors

Constructor	Description
DefaultRoute(String systemName)	Constructor for a Route instance.
DefaultRoute(String systemName, String userName)	Constructor for a Route instance with a given userName.

Method Summary

Modifier and Type	Method	Description
void	activateRoute()	Activate the Route.
boolean	addOutputSensor(String sensorName, int state)	Add an output Sensor to this Route.
boolean	addOutputTurnout(String turnoutName, int turnoutState)	Add an output Turnout to this Route.
boolean	addSensorToRoute(String sensorName, int mode)	Add a Sensor to the list of control Sensors for this Route.
boolean	canLock()	Has at least one lockable turnout.
(package private) void	checkLockTurnout(int newState, int oldState, Turnout t)	Turnout has changed, check to see if this will lock or unlock route.
protected void	checkSensor(int newState, int oldState, Sensor sensor)	Handle sensor update event to see if it will set the route.
(package private) void	checkTurnout(int newState, int oldState, Turnout t)	Turnout has changed, check to see if this fires.
void	checkTurnoutAlignment()	Method to check if the turnouts for this route are correctly aligned.
void	clearOutputSensors()	Delete all output Sensors from this Route.
void	clearOutputTurnouts()	Delete all output Turnouts from this Route.
void	clearRouteSensors()	Delete all control Sensors from this Route.
void	deActivateRoute()	Deactivate the Route.
String	getBeanType()	For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
String	getControlTurnout()	Get the SystemName of the control Turnout for this Route.
boolean	getControlTurnoutFeedback()	Get the feedback to use when checking the control turnout state
int	getControlTurnoutState()	Get the State of control Turnout that fires this Route.
Turnout	getCtlTurnout()	Get the Turnout of a control Turnout for this Route.
boolean	getEnabled()	Get enabled status.
String	getLockControlTurnout()	Get the SystemName of the lock control Turnout for this Route.
int	getLockControlTurnoutState()	Get the State of the lock control Turnout that locks this Route.
Turnout	getLockCtlTurnout()	Get the Turnout of a lock control Turnout for this Route.
boolean	getLocked()	Get locked status.
int	getNumOutputSensors()
int	getNumOutputTurnouts()
String	getOutputScriptName()	Get name of script file to be run when Route is fired.
Sensor	getOutputSensor(int k)	Get the output Sensor by index.
String	getOutputSensorByIndex(int index)	Get an output Sensor system name by index.
int	getOutputSensorSetState(String name)	Get the Set State of an output Sensor.
int	getOutputSensorState(int k)	Get the desired state of an output Sensor by index.
String	getOutputSoundName()	Get name of sound file to be played when Route is fired.
Turnout	getOutputTurnout(int k)	Get the output Turnout by index.
String	getOutputTurnoutByIndex(int index)	Get an output Turnout system name by index.
int	getOutputTurnoutSetState(String name)	get the Set State of an output Turnout.
int	getOutputTurnoutState(int k)	Get the desired state of the Turnout by index.
int	getRouteCommandDelay()	Get the delay between issuing Turnout commands on this route.
Sensor	getRouteSensor(int index)	Get the Sensor of a control Sensor in this Route.
int	getRouteSensorMode(int index)	Get the state of a particular Sensor in this Route.
String	getRouteSensorName(int index)	Get the SystemName of a control Sensor in this Route.
int	getState()	Provide generic access to internal state.
Sensor	getTurnoutsAlgdSensor()	Get the turnouts aligned sensor.
String	getTurnoutsAlignedSensor()	Get the system name of the turnouts aligned sensor.
List<NamedBeanUsageReport>	getUsageReport(NamedBean bean)	Get a list of references for the specified bean.
boolean	isOutputSensorIncluded(String sensorName)	Inquire if a Sensor is included in this Route as an output.
boolean	isOutputTurnoutIncluded(String turnoutName)	Inquire if a Turnout is included in this Route as an output.
protected boolean	isRouteBusy()	Method to query if Route is busy (returns true if commands are being issued to Route turnouts)
(package private) boolean	isRouteSensorIncluded(Sensor s)
(package private) boolean	isVetoed()	Internal method to check whether operation of the route has been vetoed by a sensor or turnout setting.
(package private) void	removeRouteSensor(Sensor s)
void	setControlTurnout(String turnoutName)	Set the control Turnout for this Route.
void	setControlTurnoutFeedback(boolean turnoutFeedbackIsCommanded)	Set the feedback to use when checking the control turnout state
void	setControlTurnoutState(int turnoutState)	Set the State of control Turnout that fires this Route.
void	setEnabled(boolean v)	Set enabled status.
void	setLockControlTurnout(String turnoutName)	Set the lock control Turnout for this Route.
void	setLockControlTurnoutState(int turnoutState)	Set the State of the lock control Turnout for this Route.
void	setLocked(boolean v)	Set locked status.
void	setOutputScriptName(String filename)	Set name of script file to be run when Route is fired.
void	setOutputSoundName(String filename)	Set name of sound file to be played when Route is fired.
void	setRoute()	Set the Route.
protected void	setRouteBusy(boolean busy)	Mark the Route as transitioning to an Sensor.ACTIVE state.
void	setRouteCommandDelay(int delay)	Set the delay between issuing Turnout commands on this route.
void	setState(int state)	Provide generic access to internal state.
void	setTurnoutsAlignedSensor(String sensorName)	Set a sensor to be the turnouts aligned sensor.
void	vetoableChange(PropertyChangeEvent evt)

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, dispose, 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, describeState, dispose, 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

Constructor Details

DefaultRoute

public DefaultRoute(String systemName,
 String userName)

Constructor for a Route instance with a given userName.

Parameters:

systemName - suggested system name

userName - provided user name

DefaultRoute

public DefaultRoute(String systemName)

Constructor for a Route instance.

Parameters:

systemName - suggested system name

Method Details

getBeanType

public String getBeanType()

For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.

Specified by:

getBeanType in interface NamedBean

Returns:

a string of the bean type, eg Turnout, Sensor etc

getEnabled

public boolean getEnabled()

Get enabled status.

Specified by:

getEnabled in interface Route

Returns:

true if enabled; false otherwise

setEnabled

public void setEnabled(boolean v)

Set enabled status.

Specified by:

setEnabled in interface Route

Parameters:

v - true if enabled; false otherwise

getLocked

public boolean getLocked()

Get locked status.

Specified by:

getLocked in interface Route

Returns:

true if locked; false otherwise

setLocked

public void setLocked(boolean v)

Set locked status.

Specified by:

setLocked in interface Route

Parameters:

v - true if locked; false otherwise

canLock

public boolean canLock()

Has at least one lockable turnout.

Specified by:

canLock in interface Route

Returns:

true if lockable; false otherwise

addOutputTurnout

public boolean addOutputTurnout(String turnoutName,
 int turnoutState)

Add an output Turnout to this Route.

Specified by:

addOutputTurnout in interface Route

Parameters:

turnoutName - The turnout system name

turnoutState - must be Turnout.CLOSED, Turnout.THROWN, or Route.TOGGLE, which determines how the Turnout is to be switched when this Route is set

Returns:

true if the output turnout was added

clearOutputTurnouts

public void clearOutputTurnouts()

Delete all output Turnouts from this Route.

Specified by:

clearOutputTurnouts in interface Route

getNumOutputTurnouts

public int getNumOutputTurnouts()

Specified by:

getNumOutputTurnouts in interface Route

getOutputTurnoutByIndex

@CheckForNull
public String getOutputTurnoutByIndex(int index)

Get an output Turnout system name by index.

Specified by:

getOutputTurnoutByIndex in interface Route

Parameters:

index - the index of the turnout

Returns:

the turnout system name or null if no turnout exists at index

isOutputTurnoutIncluded

public boolean isOutputTurnoutIncluded(String turnoutName)
                                throws IllegalArgumentException

Inquire if a Turnout is included in this Route as an output.

Specified by:

isOutputTurnoutIncluded in interface Route

Parameters:

turnoutName - the system name of the turnout

Returns:

true if the named turnout is an output; false otherwise

Throws:

IllegalArgumentException

getOutputTurnoutSetState

public int getOutputTurnoutSetState(String name)
                             throws IllegalArgumentException

get the Set State of an output Turnout.

Specified by:

getOutputTurnoutSetState in interface Route

Parameters:

name - the system name of the turnout

Returns:

the state or -1 if the Turnout is not found

Throws:

IllegalArgumentException

getOutputTurnout

@CheckForNull
public Turnout getOutputTurnout(int k)

Get the output Turnout by index.

Specified by:

getOutputTurnout in interface Route

Parameters:

k - the index of the turnout

Returns:

the turnout or null if no turnout exists at index

getOutputTurnoutState

public int getOutputTurnoutState(int k)

Get the desired state of the Turnout by index.

Specified by:

getOutputTurnoutState in interface Route

Parameters:

k - the index of the turnout

Returns:

the turnout state or -1 if no turnout exists at index

addOutputSensor

public boolean addOutputSensor(String sensorName,
 int state)

Add an output Sensor to this Route.

Specified by:

addOutputSensor in interface Route

Parameters:

sensorName - the sensor system name

state - the state the sensor switches to when the Route is set; must be one of Sensor.ACTIVE, Sensor.INACTIVE, or Route.TOGGLE

Returns:

true if the sensor was added; false otherwise

clearOutputSensors

public void clearOutputSensors()

Delete all output Sensors from this Route.

Specified by:

clearOutputSensors in interface Route

getNumOutputSensors

public int getNumOutputSensors()

Specified by:

getNumOutputSensors in interface Route

getOutputSensorByIndex

@CheckForNull
public String getOutputSensorByIndex(int index)

Get an output Sensor system name by index.

Specified by:

getOutputSensorByIndex in interface Route

Parameters:

index - the index of the sensor

Returns:

the sensor or null if no sensor exists at index

isOutputSensorIncluded

public boolean isOutputSensorIncluded(String sensorName)
                               throws IllegalArgumentException

Inquire if a Sensor is included in this Route as an output.

Specified by:

isOutputSensorIncluded in interface Route

Parameters:

sensorName - the Sensor system name

Returns:

true if the sensor is an output in this Route

Throws:

IllegalArgumentException

getOutputSensorSetState

public int getOutputSensorSetState(String name)
                            throws IllegalArgumentException

Get the Set State of an output Sensor.

Specified by:

getOutputSensorSetState in interface Route

Parameters:

name - the system name of the Sensor

Returns:

-1 if the Sensor is not found

Throws:

IllegalArgumentException

getOutputSensor

@CheckForNull
public Sensor getOutputSensor(int k)

Get the output Sensor by index.

Specified by:

getOutputSensor in interface Route

Parameters:

k - the index of the sensor

Returns:

the sensor or null if no sensor exists at index

getOutputSensorState

public int getOutputSensorState(int k)

Get the desired state of an output Sensor by index.

Specified by:

getOutputSensorState in interface Route

Parameters:

k - the index of the sensor

Returns:

the sensor state or -1 if no sensor exists at index

setOutputScriptName

public void setOutputScriptName(String filename)

Set name of script file to be run when Route is fired.

Specified by:

setOutputScriptName in interface Route

Parameters:

filename - path to script

getOutputScriptName

@CheckForNull
public String getOutputScriptName()

Get name of script file to be run when Route is fired.

Specified by:

getOutputScriptName in interface Route

Returns:

script path or null if not defined

setOutputSoundName

public void setOutputSoundName(String filename)

Set name of sound file to be played when Route is fired.

Specified by:

setOutputSoundName in interface Route

Parameters:

filename - path to sound

getOutputSoundName

@CheckForNull
public String getOutputSoundName()

Get name of sound file to be played when Route is fired.

Specified by:

getOutputSoundName in interface Route

Returns:

sound file path or null if not defined

setTurnoutsAlignedSensor

public void setTurnoutsAlignedSensor(@CheckForNull
 String sensorName)
                              throws IllegalArgumentException

Set a sensor to be the turnouts aligned sensor.

Specified by:

setTurnoutsAlignedSensor in interface Route

Parameters:

sensorName - the system name of the sensor; pass null to disassociate any sensor from this route

Throws:

IllegalArgumentException

getTurnoutsAlignedSensor

@CheckForNull
public String getTurnoutsAlignedSensor()

Get the system name of the turnouts aligned sensor.

Specified by:

getTurnoutsAlignedSensor in interface Route

Returns:

the name or null if not defined

getTurnoutsAlgdSensor

@CheckForNull
public Sensor getTurnoutsAlgdSensor()
                             throws IllegalArgumentException

Get the turnouts aligned sensor.

Specified by:

getTurnoutsAlgdSensor in interface Route

Returns:

the sensor or null if not defined

Throws:

IllegalArgumentException

clearRouteSensors

public void clearRouteSensors()

Delete all control Sensors from this Route.

Specified by:

clearRouteSensors in interface Route

addSensorToRoute

public boolean addSensorToRoute(String sensorName,
 int mode)

Add a Sensor to the list of control Sensors for this Route.

Specified by:

addSensorToRoute in interface Route

Parameters:

sensorName - system name of the sensor

mode - the default state of the sensor

Returns:

true if added; false otherwise

getRouteSensorName

@CheckForNull
public String getRouteSensorName(int index)

Get the SystemName of a control Sensor in this Route.

Specified by:

getRouteSensorName in interface Route

Parameters:

index - The index in the Sensor array of the requested Sensor

Returns:

null If there is no Sensor at index

getRouteSensor

@CheckForNull
public Sensor getRouteSensor(int index)

Get the Sensor of a control Sensor in this Route.

Specified by:

getRouteSensor in interface Route

Parameters:

index - The index in the Sensor array of the requested Sensor

Returns:

null If there is no Sensor with at index

getRouteSensorMode

public int getRouteSensorMode(int index)

Get the state of a particular Sensor in this Route.

Specified by:

getRouteSensorMode in interface Route

Parameters:

index - The index in the Sensor array of the requested Sensor

Returns:

ONACTIVE if there is no Sensor with at index

isRouteSensorIncluded

boolean isRouteSensorIncluded(Sensor s)

removeRouteSensor

void removeRouteSensor(Sensor s)

setControlTurnout

public void setControlTurnout(@CheckForNull
 String turnoutName)
                       throws IllegalArgumentException

Set the control Turnout for this Route.

Specified by:

setControlTurnout in interface Route

Parameters:

turnoutName - the system name of a turnout

Throws:

IllegalArgumentException

getControlTurnout

@CheckForNull
public String getControlTurnout()

Get the SystemName of the control Turnout for this Route.

Specified by:

getControlTurnout in interface Route

Returns:

the name of the control turnout or null if not set

getCtlTurnout

@CheckForNull
public Turnout getCtlTurnout()
                      throws IllegalArgumentException

Get the Turnout of a control Turnout for this Route.

Specified by:

getCtlTurnout in interface Route

Returns:

the control turnout or null if not set

Throws:

IllegalArgumentException

setLockControlTurnout

public void setLockControlTurnout(@CheckForNull
 String turnoutName)
                           throws IllegalArgumentException

Set the lock control Turnout for this Route.

Specified by:

setLockControlTurnout in interface Route

Parameters:

turnoutName - the system name of the turnout

Throws:

IllegalArgumentException

getLockControlTurnout

@CheckForNull
public String getLockControlTurnout()

Get the SystemName of the lock control Turnout for this Route.

Specified by:

getLockControlTurnout in interface Route

Returns:

the system name or null if not defined

getLockCtlTurnout

@CheckForNull
public Turnout getLockCtlTurnout()
                          throws IllegalArgumentException

Get the Turnout of a lock control Turnout for this Route.

Specified by:

getLockCtlTurnout in interface Route

Returns:

the turnout or null if not defined

Throws:

IllegalArgumentException

setRouteCommandDelay

public void setRouteCommandDelay(int delay)

Set the delay between issuing Turnout commands on this route.

Specified by:

setRouteCommandDelay in interface Route

Parameters:

delay - the delay in milliseconds

getRouteCommandDelay

public int getRouteCommandDelay()

Get the delay between issuing Turnout commands on this route.

Specified by:

getRouteCommandDelay in interface Route

Returns:

the delay in milliseconds

setControlTurnoutState

public void setControlTurnoutState(int turnoutState)

Set the State of control Turnout that fires this Route.

Specified by:

setControlTurnoutState in interface Route

Parameters:

turnoutState - the turnout state

getControlTurnoutState

public int getControlTurnoutState()

Get the State of control Turnout that fires this Route.

Specified by:

getControlTurnoutState in interface Route

Returns:

the turnout state

setControlTurnoutFeedback

public void setControlTurnoutFeedback(boolean turnoutFeedbackIsCommanded)

Set the feedback to use when checking the control turnout state

Specified by:

setControlTurnoutFeedback in interface Route

Parameters:

turnoutFeedbackIsCommanded - true if commanded state is to be checked; default is false

getControlTurnoutFeedback

public boolean getControlTurnoutFeedback()

Get the feedback to use when checking the control turnout state

Specified by:

getControlTurnoutFeedback in interface Route

Returns:

true if commanded state is to be checked; false is known state

setLockControlTurnoutState

public void setLockControlTurnoutState(int turnoutState)

Set the State of the lock control Turnout for this Route.

Specified by:

setLockControlTurnoutState in interface Route

Parameters:

turnoutState - the turnout state

getLockControlTurnoutState

public int getLockControlTurnoutState()

Get the State of the lock control Turnout that locks this Route.

Specified by:

getLockControlTurnoutState in interface Route

Returns:

the turnout state

setRoute

public void setRoute()

Set the Route.

Sets all Route Turnouts to the directed state in the Route definition.

Specified by:

setRoute in interface Route

checkSensor

protected void checkSensor(int newState,
 int oldState,
 @Nonnull
 Sensor sensor)

Handle sensor update event to see if it will set the route.

Called when a "KnownState" event is received, it assumes that only one sensor is changing right now, so can use state calls for everything other than this sensor.

This will fire the Route if the conditions are correct.

Returns nothing explicitly, but has the side effect of firing route.

Parameters:

newState - new state of control sensor

oldState - former state

sensor - Sensor used as Route control sensor

checkTurnout

void checkTurnout(int newState,
 int oldState,
 Turnout t)

Turnout has changed, check to see if this fires.

Will fire Route if appropriate.

Parameters:

newState - new state of control turnout

oldState - former state

t - Turnout used as Route control turnout

checkLockTurnout

void checkLockTurnout(int newState,
 int oldState,
 Turnout t)

Turnout has changed, check to see if this will lock or unlock route.

Parameters:

newState - new state of lock turnout

oldState - former turnout state

t - Turnout used for locking the Route

checkTurnoutAlignment

public void checkTurnoutAlignment()

Method to check if the turnouts for this route are correctly aligned. Sets turnouts aligned sensor (if there is one) to active if the turnouts are aligned. Sets the sensor to inactive if they are not aligned

activateRoute

public void activateRoute()

Activate the Route.

This starts route processing by connecting to inputs, etc. A Route must be activated before it will fire.

Specified by:

activateRoute in interface Route

isVetoed

boolean isVetoed()

Internal method to check whether operation of the route has been vetoed by a sensor or turnout setting.

Returns:

true if veto, i.e. don't fire route; false if no veto, OK to fire

deActivateRoute

public void deActivateRoute()

Deactivate the Route.

This disconnects the Route from all other objects and stops it from processing. A Route must be deactivated before its input and output definitions are changed.

Specified by:

deActivateRoute in interface Route

setRouteBusy

protected void setRouteBusy(boolean busy)

Mark the Route as transitioning to an Sensor.ACTIVE state.

Parameters:

busy - true if Route should be busy.

isRouteBusy

protected boolean isRouteBusy()

Method to query if Route is busy (returns true if commands are being issued to Route turnouts)

Returns:

true if the Route is transitioning to an Sensor.ACTIVE state, false otherwise.

getState

public int getState()

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

Specified by:

getState in interface NamedBean

Returns:

the state

setState

public void setState(int state)

Provide generic access to internal state.

This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

Specified by:

setState in interface NamedBean

Parameters:

state - the state

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface VetoableChangeListener

Overrides:

vetoableChange in class AbstractNamedBean

Throws:

PropertyVetoException

getUsageReport

public List<NamedBeanUsageReport> getUsageReport(NamedBean bean)

Description copied from interface: NamedBean

Get a list of references for the specified bean.

Specified by:

getUsageReport in interface NamedBean

Parameters:

bean - The bean to be checked.

Returns:

a list of NamedBeanUsageReports or an empty ArrayList.