jmri.jmrix.cmri.serial
Class SerialLightManager

java.lang.Object
  jmri.AbstractManager
      jmri.AbstractLightManager
          jmri.jmrix.cmri.serial.SerialLightManager

All Implemented Interfaces:

PropertyChangeListener, EventListener, LightManager, Manager

public class SerialLightManager
extends AbstractLightManager

Implement light manager for CMRI serial systems

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

Based in part on SerialTurnoutManager.java

Author:

Dave Duchamp Copyright (C) 2004

Field Summary

Fields inherited from class jmri.AbstractManager

_tsys, _tuser

Constructor Summary

SerialLightManager()

Method Summary

String	convertSystemNameToAlternate(String systemName) Public method to convert system name to its alternate format Returns a normalized system name if system name is valid and has a valid alternate representation, else return "".
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 or if the system name does not correspond to a configured C/MRI digital output bit Assumes calling method has checked that a Light with this system name does not already exist
static SerialLightManager	instance() Allow access to SerialLightManager
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 "".
void	notifyLightCreationError(String conflict, int bitNum) Public method to notify user of Light creation error.
char	systemLetter() Returns the system letter for CMRI
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.AbstractLightManager

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

Methods inherited from class jmri.AbstractManager

addPropertyChangeListener, deregister, dispose, firePropertyChange, getInstanceBySystemName, getInstanceByUserName, getSystemNameList, makeSystemName, propertyChange, register, removePropertyChangeListener

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, makeSystemName, register, removePropertyChangeListener

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Constructor Detail

SerialLightManager

public SerialLightManager()

Method Detail

systemLetter

public char systemLetter()

Returns the system letter for CMRI

Returns:

The system-specific prefix letter for a specific implementation

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 or if the system name does not correspond to a configured C/MRI digital output bit 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

notifyLightCreationError

public void notifyLightCreationError(String conflict,
                                     int bitNum)

Public method to notify user of Light creation error.

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

convertSystemNameToAlternate

public String convertSystemNameToAlternate(String systemName)

Public method to convert system name to its alternate format

Returns a normalized system name if system name is valid and has a valid alternate representation, else return "".

Specified by:

convertSystemNameToAlternate in interface LightManager

Overrides:

convertSystemNameToAlternate in class AbstractLightManager

instance

public static SerialLightManager instance()

Allow access to SerialLightManager