jmri.implementation
Class SignalHeadSignalMast

java.lang.Object
  jmri.implementation.AbstractNamedBean
      jmri.implementation.AbstractSignalMast
          jmri.implementation.SignalHeadSignalMast

All Implemented Interfaces:

Serializable, NamedBean, SignalMast

public class SignalHeadSignalMast
extends AbstractSignalMast

SignalMast implemented via one SignalHead object.

System name specifies the creation information:

IF: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) - colon-separated list of names for SignalHeads

There was an older form where the names where colon separated: IF: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

Author:

Bob Jacobsen Copyright (C) 2009

See Also:

Serialized Form

Field Summary

protected static Logger

log

Fields inherited from class jmri.implementation.AbstractNamedBean

mSystemName, mUserName

Fields inherited from interface jmri.NamedBean

INCONSISTENT, UNKNOWN

Constructor Summary

SignalHeadSignalMast(String systemName)

SignalHeadSignalMast(String systemName, String userName)

Method Summary

SignalAppearanceMap	getAppearanceMap()
SignalSystem	getSignalSystem()
Vector<String>	getValidAspects()
void	setAspect(String aspect) Set aspect to a valid name in the current signal system definition.
void	setHeld(boolean state) Set the held parameter.
void	setLit(boolean state) Set the lit parameter.

Methods inherited from class jmri.implementation.AbstractSignalMast

getAspect, getHeld, getLit, getSpeed, getState, setState

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName, updateListenerRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, dispose, getComment, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyKeys, getSystemName, getUserName, removePropertyChangeListener, setComment, setProperty, setUserName, updateListenerRef

Field Detail

log

protected static final Logger log

Constructor Detail

SignalHeadSignalMast

public SignalHeadSignalMast(String systemName,
                            String userName)

SignalHeadSignalMast

public SignalHeadSignalMast(String systemName)

Method Detail

setAspect

public void setAspect(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

getValidAspects

public Vector<String> getValidAspects()

getSignalSystem

public SignalSystem getSignalSystem()

getAppearanceMap

public SignalAppearanceMap getAppearanceMap()

setHeld

public void setHeld(boolean state)

Description copied from class: AbstractSignalMast

Set the held parameter.

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

Specified by:

setHeld in interface SignalMast

Overrides:

setHeld in class AbstractSignalMast

setLit

public void setLit(boolean state)

Description copied from class: AbstractSignalMast

Set the lit parameter. This acts on all the SignalHeads included in this SignalMast

Specified by:

setLit in interface SignalMast

Overrides:

setLit in class AbstractSignalMast