Package jmri.jmrix.bidib

Class BiDiBLightManager

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.beans.VetoableChangeSupport
jmri.managers.AbstractManager<Light>
jmri.managers.AbstractLightManager
jmri.jmrix.bidib.BiDiBLightManager
All Implemented Interfaces:
PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LightManager, Manager<Light>, NameIncrementingManager, ProvidingManager<Light>
public class BiDiBLightManager extends AbstractLightManager
Implement LightManager for BiDiB systems.

  • Constructor Details

  • Method Details

    • getMemo

      public BiDiBSystemConnectionMemo getMemo()
      Get the system connection for this manager.
      Specified by:
      getMemo in interface Manager<Light>
      Overrides:
      getMemo in class AbstractManager<Light>
      Returns:
      the system connection for this manager

    • createNewLight

      public Light createNewLight(String systemName, String userName)
      Create a new Light based on the system name. Assumes calling method has checked that a Light with this system name does not already exist.
      Specified by:
      createNewLight in class AbstractLightManager
      Parameters:
      systemName - the system name to use for this light
      userName - the user name to use for this light
      Returns:
      null if the system name is not in a valid format.

    • startLoad

      public void startLoad()
      This function is invoked before an XML load is started. We defer initialization of the newly created turnouts until finishLoad because the feedback type might be changing as we are parsing the XML.

    • finishLoad

      public void finishLoad()
      This function is invoked after the XML load is complete and all Sensors are instantiated and their type is read in. We use this hook to finalize the construction of the objects whose instantiation was deferred until the feedback type was known.

    • createSystemName

      public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException
      Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.
      Specified by:
      createSystemName in interface LightManager
      Overrides:
      createSystemName in class AbstractManager<Light>
      Parameters:
      curAddress - hardware address, no system prefix or type letter.
      prefix - - just system prefix, not including Type Letter.
      Returns:
      full system name with system prefix, type letter and hardware address.
      Throws:
      JmriException - if unable to create a system name.

    • validateSystemNameFormat

      public String validateSystemNameFormat(String name, Locale locale)
      Validate the format of name, returning it unchanged if valid.

      Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.

      Overriding implementations may rely on Manager.validSystemNameFormat(java.lang.String), however they must provide an actionable message in the thrown exception if that method does not return Manager.NameValidity.VALID. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.

      Parameters:
      name - the system name to validate
      locale - the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales
      Returns:
      the unchanged value of the name parameter

    • validSystemNameFormat

      public Manager.NameValidity validSystemNameFormat(String systemName)
      Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user.
      Specified by:
      validSystemNameFormat in interface Manager<Light>
      Overrides:
      validSystemNameFormat in class AbstractManager<Light>
      Parameters:
      systemName - the system name
      Returns:
      Manager.NameValidity.INVALID if system name does not start with Manager.getSystemNamePrefix(); Manager.NameValidity.VALID_AS_PREFIX_ONLY if system name equals Manager.getSystemNamePrefix(); otherwise Manager.NameValidity.VALID to allow Managers that do not perform more specific validation to be considered valid.

    • validSystemNameConfig

      public boolean validSystemNameConfig(String systemName)
      Validate system name for configuration.
      Parameters:
      systemName - system name to validate
      Returns:
      'true' if system name has a valid meaning in current configuration, else returns 'false'. For now, this method always returns 'true'; it is needed for the Abstract Light class.

    • allowMultipleAdditions

      public boolean allowMultipleAdditions(String systemName)
      Determine if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to enable/disable the Add range checkbox in the Add Light pane.
      Parameters:
      systemName - system name to check for (not used so far)
      Returns:
      true if multiple additions are possible. For now, this is always the case.

    • getEntryToolTip

      public String getEntryToolTip()
      Get a manager-specific tool tip for adding an entry to the manager.
      Specified by:
      getEntryToolTip in interface Manager<Light>
      Overrides:
      getEntryToolTip in class AbstractLightManager
      Returns:
      the tool tip or null to disable the tool tip

    • configAll

      public void configAll()
      Request config from all LC ports. The resulting config messages are processed by the Message Listeners of the Light and Sensor instances.