Package jmri.jmrit.ussctc

Class RouteLock

java.lang.Object

jmri.jmrit.ussctc.RouteLock

All Implemented Interfaces:

Lock

public class RouteLock
extends Object
implements Lock

Lock if any of the SignalHeads controlling traffic over a turnout are not at stop.

This checks SignalHeads for RED; it locks against Restricting (FLASHRED) but you can change that by overriding the checkSignalClear() method.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.jmrit.ussctc.Lock

Lock.Valid

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Iterable<BeanSetting>	beans
(package private) Iterable<NamedBeanHandle<SignalHead>>	list

Fields inherited from interface jmri.jmrit.ussctc.Lock

debugLockLogger, signalLockLogger, turnoutLockLogger

Constructor Summary

Constructors

Constructor	Description
RouteLock(String head)
RouteLock(String[] array)
RouteLock(String[] array, BeanSetting[] beans)
RouteLock(List<NamedBeanHandle<SignalHead>> list)
RouteLock(List<NamedBeanHandle<SignalHead>> list, List<BeanSetting> beans)

Method Summary

Modifier and Type	Method	Description
boolean	isLockClear(LockLogger lockLogger)	Test the lock conditions
(package private) boolean	isSignalClear(NamedBeanHandle<SignalHead> handle)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

list

Iterable<NamedBeanHandle<SignalHead>> list

beans

Iterable<BeanSetting> beans

Constructor Details

RouteLock

public RouteLock(@Nonnull
 List<NamedBeanHandle<SignalHead>> list)

Parameters:

list - SignalHeads that cover this route

RouteLock

public RouteLock(@Nonnull
 List<NamedBeanHandle<SignalHead>> list,
 @Nonnull
 List<BeanSetting> beans)

Parameters:

list - SignalHeads that cover this route

beans - Defines the specific route

RouteLock

public RouteLock(@Nonnull
 String[] array)

Parameters:

array - User or system names of SignalHeads that cover this route

RouteLock

public RouteLock(@Nonnull
 String[] array,
 @Nonnull
 BeanSetting[] beans)

Parameters:

array - User or system names of SignalHeads that cover this route

beans - Defines the specific route

RouteLock

public RouteLock(@Nonnull
 String head)

Parameters:

head - User or system name of a SignalHead that covers this route

Method Details

isLockClear

public boolean isLockClear(LockLogger lockLogger)

Test the lock conditions

Specified by:

isLockClear in interface Lock

Parameters:

lockLogger - the logger on which to emit status messages

Returns:

True if lock is clear and operation permitted

isSignalClear

boolean isSignalClear(@Nonnull
 NamedBeanHandle<SignalHead> handle)

toString

public String toString()

Overrides:

toString in class Object