Package jmri.jmrit.ussctc

Class TurnoutLock

java.lang.Object

jmri.jmrit.ussctc.TurnoutLock

All Implemented Interfaces:

Lock

public class TurnoutLock
extends Object
implements Lock

Lock if a turnout isn't in the desired state.

Can be used to e.g. lock when a call-on (turnout) is set

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) NamedBeanHandle<Turnout>	turnout
(package private) int	value

Fields inherited from interface jmri.jmrit.ussctc.Lock

debugLockLogger, signalLockLogger, turnoutLockLogger

Constructor Summary

Constructors

Constructor	Description
TurnoutLock(String name, int okValue)

Method Summary

Modifier and Type	Method	Description
boolean	isLockClear(LockLogger lockLogger)	Test the lock conditions
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

turnout

NamedBeanHandle<Turnout> turnout

value

int value

Constructor Details

TurnoutLock

public TurnoutLock(String name,
 int okValue)

Parameters:

name - System or user name of turnout to monitor

okValue - If this value isn't present, the operation is locked out

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

toString

public String toString()

Overrides:

toString in class Object