Package jmri.implementation

Class TurnoutSignalMast

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSignalMast

jmri.implementation.TurnoutSignalMast

All Implemented Interfaces:

VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, NamedBean, Signal, SignalMast

public class TurnoutSignalMast
extends AbstractSignalMast

SignalMast implemented via Turnout objects.

A SignalMast that is built up using turnouts to control a specific appearance. System name specifies the creation information:

 IF$tsm:basic:one-searchlight(IT1)(IT2)
 

The name is a colon-separated series of terms:

• IF$tsm - defines signal masts of this type
• basic - name of the signaling system
• one-searchlight - name of the particular aspect map
• (IT1)(IT2) - colon-separated list of names for Turnouts

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
protected static int	lastRef	Ordinal of all TurnoutSignalMasts to create unique system name.

Fields inherited from class jmri.implementation.AbstractSignalMast

aspect, disabledAspects, disablePermissiveSignalMastLogic, map, mastType, speed, systemDefn

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

PROPERTY_HELD, PROPERTY_LIT

Fields inherited from interface jmri.SignalMast

PROPERTY_ASPECT, PROPERTY_ASPECT_DISABLED, PROPERTY_ASPECT_ENABLED, PROPERTY_PERMISSIVE_SML_DISABLED

Constructor Summary

Constructors

Constructor	Description
TurnoutSignalMast(String systemName)
TurnoutSignalMast(String systemName, String userName)

Method Summary

Modifier and Type	Method	Description
List<NamedBeanHandle<Turnout>>	getHeadsUsed()
static int	getLastRef()
String	getTurnoutName(String appearance)
int	getTurnoutState(String appearance)
Turnout	getUnLitTurnout()
String	getUnLitTurnoutName()
int	getUnLitTurnoutState()
boolean	isTurnoutUsed(Turnout t)
boolean	resetPreviousStates()
void	resetPreviousStates(boolean boo)	If the signal mast driver requires the previous state to be cleared down before the next state is set.
void	setAspect(String aspect)	Set aspect to a valid name in the current signal system definition.
protected static void	setLastRef(int newVal)
void	setLit(boolean newLit)	Set the lit property.
void	setTurnout(String appearance, String turn, int state)
void	setUnLitTurnout(String turnoutName, int turnoutState)
void	vetoableChange(PropertyChangeEvent evt)

Methods inherited from class jmri.implementation.AbstractSignalMast

allowUnLit, configureAspectTable, configureSignalSystemDefinition, getAllKnownAspects, getAppearanceMap, getAspect, getBeanType, getDisabledAspects, getHeld, getLit, getMastType, getSignalSystem, getSpeed, getState, getUsageReport, getValidAspects, isAspectDisabled, isAtStop, isCleared, isPermissiveSmlDisabled, isShowingRestricting, setAllowUnLit, setAspectDisabled, setAspectEnabled, setHeld, setMastType, setPermissiveSmlDisabled, setState

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

Field Details

lastRef

protected static volatile int lastRef

Ordinal of all TurnoutSignalMasts to create unique system name.

Constructor Details

TurnoutSignalMast

public TurnoutSignalMast(String systemName,
 String userName)

TurnoutSignalMast

public TurnoutSignalMast(String systemName)

Method Details

setAspect

public void setAspect(@Nonnull
 String aspect)

Description copied from interface: SignalMast

Set aspect to a valid name in the current signal system definition.

Specified by:

setAspect in interface SignalMast

Overrides:

setAspect in class AbstractSignalMast

Parameters:

aspect - the new aspect shown

setUnLitTurnout

public void setUnLitTurnout(String turnoutName,
 int turnoutState)

getUnLitTurnoutName

public String getUnLitTurnoutName()

getUnLitTurnout

public Turnout getUnLitTurnout()

getUnLitTurnoutState

public int getUnLitTurnoutState()

setLit

public void setLit(boolean newLit)

Description copied from class: AbstractSignalMast

Set the lit property.

This acts on all the SignalHeads included in this SignalMast

Specified by:

setLit in interface Signal

Specified by:

setLit in interface SignalMast

Overrides:

setLit in class AbstractSignalMast

Parameters:

newLit - the new value of lit

getTurnoutName

public String getTurnoutName(String appearance)

getTurnoutState

public int getTurnoutState(String appearance)

setTurnout

public void setTurnout(String appearance,
 String turn,
 int state)

resetPreviousStates

public void resetPreviousStates(boolean boo)

If the signal mast driver requires the previous state to be cleared down before the next state is set.

Parameters:

boo - true if prior states should be cleared; false otherwise

resetPreviousStates

public boolean resetPreviousStates()

isTurnoutUsed

public boolean isTurnoutUsed(Turnout t)

getHeadsUsed

public List<NamedBeanHandle<Turnout>> getHeadsUsed()

setLastRef

protected static void setLastRef(int newVal)

Parameters:

newVal - for ordinal of all TurnoutSignalMasts in use

getLastRef

public static int getLastRef()

Returns:

highest ordinal of all TurnoutSignalMasts in use

vetoableChange

public void vetoableChange(PropertyChangeEvent evt)
                    throws PropertyVetoException

Description copied from class: AbstractNamedBean

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface VetoableChangeListener

Overrides:

vetoableChange in class AbstractSignalMast

Throws:

PropertyVetoException