jmri.jmrix.powerline
Class SerialLightManager

java.lang.Object
  jmri.managers.AbstractManager
      jmri.managers.AbstractLightManager
          jmri.jmrix.powerline.SerialLightManager

All Implemented Interfaces:

PropertyChangeListener, Serializable, EventListener, LightManager, Manager

Direct Known Subclasses:

SpecificLightManager, SpecificLightManager, SpecificLightManager, SpecificLightManager

public abstract class SerialLightManager
extends AbstractLightManager

Implement light manager for powerline serial systems

System names are "PLnnn", where nnn is the bit number without padding.

See Also:

Serialized Form

Field Summary

(package private) static org.slf4j.Logger	log
(package private) SerialTrafficController	tc

Fields inherited from class jmri.managers.AbstractManager

_tsys, _tuser

Fields inherited from interface jmri.Manager

AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXS, MEMORIES, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

SerialLightManager(SerialTrafficController tc)

Method Summary

boolean	allowMultipleAdditions(String systemName) A method that determines if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to show/not show the add range box in the add Light window
Light	createNewLight(String systemName, String userName) Method to create a new Light based on the system name Returns null if the system name is not in a valid format Assumes calling method has checked that a Light with this system name does not already exist
protected abstract Light	createNewSpecificLight(String systemName, String userName) Create light of a specific type for the interface
String	getSystemPrefix() Returns the system letter
String	normalizeSystemName(String systemName) Public method to normalize a system name Returns a normalized system name if system name has a valid format, else returns "".
boolean	supportsVariableLights(String systemName) Returns 'true' to indicate this system can support variable lights
boolean	validSystemNameConfig(String systemName) Public method to validate system name for configuration returns 'true' if system name has a valid meaning in current configuration, else returns 'false'
boolean	validSystemNameFormat(String systemName) Public method to validate system name format returns 'true' if system name has a valid format, else returns 'false'

Methods inherited from class jmri.managers.AbstractLightManager

activateAllLights, convertSystemNameToAlternate, getBySystemName, getByUserName, getLight, getXMLOrder, newLight, provideLight, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addPropertyChangeListener, deregister, dispose, firePropertyChange, getBeanBySystemName, getBeanByUserName, getInstanceBySystemName, getInstanceByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, getSystemNameList, makeSystemName, propertyChange, register, registerSelf, removePropertyChangeListener, systemLetter

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.LightManager

dispose, getSystemNameList

Methods inherited from interface jmri.Manager

addPropertyChangeListener, deregister, getBeanBySystemName, getBeanByUserName, getNamedBean, getNamedBeanList, getSystemNameArray, makeSystemName, register, removePropertyChangeListener, systemLetter

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Field Detail

tc

SerialTrafficController tc

log

static org.slf4j.Logger log

Constructor Detail

SerialLightManager

public SerialLightManager(SerialTrafficController tc)

Method Detail

getSystemPrefix

public String getSystemPrefix()

Returns the system letter

allowMultipleAdditions

public boolean allowMultipleAdditions(String systemName)

Description copied from class: AbstractLightManager

A method that determines if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to show/not show the add range box in the add Light window

Specified by:

allowMultipleAdditions in interface LightManager

Overrides:

allowMultipleAdditions in class AbstractLightManager

createNewLight

public Light createNewLight(String systemName,
                            String userName)

Method to create a new Light based on the system name Returns null if the system name is not in a valid format Assumes calling method has checked that a Light with this system name does not already exist

Specified by:

createNewLight in class AbstractLightManager

Returns:

new null

createNewSpecificLight

protected abstract Light createNewSpecificLight(String systemName,
                                                String userName)

Create light of a specific type for the interface

validSystemNameFormat

public boolean validSystemNameFormat(String systemName)

Public method to validate system name format returns 'true' if system name has a valid format, else returns 'false'

validSystemNameConfig

public boolean validSystemNameConfig(String systemName)

Public method to validate system name for configuration returns 'true' if system name has a valid meaning in current configuration, else returns 'false'

normalizeSystemName

public String normalizeSystemName(String systemName)

Public method to normalize a system name

Returns a normalized system name if system name has a valid format, else returns "".

Specified by:

normalizeSystemName in interface LightManager

Overrides:

normalizeSystemName in class AbstractLightManager

supportsVariableLights

public boolean supportsVariableLights(String systemName)

Returns 'true' to indicate this system can support variable lights

Specified by:

supportsVariableLights in interface LightManager

Overrides:

supportsVariableLights in class AbstractLightManager