Package jmri.implementation

Class SignalHeadSignalMast

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSignalMast

jmri.implementation.SignalHeadSignalMast

All Implemented Interfaces:

java.beans.VetoableChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, NamedBean, Signal, SignalMast

public class SignalHeadSignalMast
extends AbstractSignalMast

SignalMast implemented via one SignalHead object.

System name specifies the creation information:

 IF$shsm:basic:one-searchlight(IH1)(IH2)
 

The name is a colon-separated series of terms:

• IF$shsm - defines signal masts of this type
• basic - name of the signaling system
• one-searchlight - name of the particular aspect map
• (IH1)(IH2) - List of signal head names in parentheses. Note: There is no colon between the mast name and the head names.

There was an older form where the SignalHead names were also colon separated: IF$shsm:basic:one-searchlight:IH1:IH2 This was deprecated because colons appear in e.g. SE8c system names.

• IF$shsm - defines signal masts of this type
• basic - name of the signaling system
• one-searchlight - name of the particular aspect map
• IH1:IH2 - colon-separated list of names for SignalHeads

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.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
SignalHeadSignalMast(java.lang.String systemName)
SignalHeadSignalMast(java.lang.String systemName, java.lang.String userName)

Method Summary

Modifier and Type	Method	Description
java.util.List<NamedBeanHandle<SignalHead>>	getHeadsUsed()
static java.util.List<SignalHead>	getSignalHeadsUsed()
static java.lang.String	isHeadUsed(SignalHead head)
void	setAppearances(java.lang.String aspect)
void	setAspect(java.lang.String aspect)	Set aspect to a valid name in the current signal system definition.
void	setHeld(boolean state)	Set the held property of the signal mast.
void	setLit(boolean state)	Set the lit property.
void	vetoableChange(java.beans.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, 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

Constructor Detail

SignalHeadSignalMast

public SignalHeadSignalMast(java.lang.String systemName,
                            java.lang.String userName)

SignalHeadSignalMast

public SignalHeadSignalMast(java.lang.String systemName)

Method Detail

setAspect

public void setAspect(@Nonnull
                      java.lang.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

setHeld

public void setHeld(boolean state)

Description copied from class: AbstractSignalMast

Set the held property of the signal mast.

Note that this does not directly effect the output on the layout; the held property is a local variable which effects the aspect only via higher-level logic.

Specified by:

setHeld in interface Signal

Specified by:

setHeld in interface SignalMast

Overrides:

setHeld in class AbstractSignalMast

Parameters:

state - the new value of the help property

setLit

public void setLit(boolean state)

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:

state - the new value of lit

getHeadsUsed

public java.util.List<NamedBeanHandle<SignalHead>> getHeadsUsed()

setAppearances

public void setAppearances(java.lang.String aspect)

getSignalHeadsUsed

public static java.util.List<SignalHead> getSignalHeadsUsed()

isHeadUsed

public static java.lang.String isHeadUsed(SignalHead head)

vetoableChange

public void vetoableChange(java.beans.PropertyChangeEvent evt)
                    throws java.beans.PropertyVetoException

Description copied from class: AbstractNamedBean

Specified by:

vetoableChange in interface NamedBean

Specified by:

vetoableChange in interface java.beans.VetoableChangeListener

Overrides:

vetoableChange in class AbstractSignalMast

Throws:

java.beans.PropertyVetoException