Package jmri.jmrix.bidib

Class BiDiBTurnoutManager

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.beans.VetoableChangeSupport
jmri.managers.AbstractManager<Turnout>
jmri.managers.AbstractTurnoutManager
jmri.jmrix.bidib.BiDiBTurnoutManager
All Implemented Interfaces:
PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Turnout>, NameIncrementingManager, ProvidingManager<Turnout>, TurnoutManager
public class BiDiBTurnoutManager extends AbstractTurnoutManager
Implement turnout manager for BiDiB systems.

System names are "BTnnn", where B is the user configurable system prefix, nnn is the turnout number without padding.

  • Constructor Details

    • BiDiBTurnoutManager

      public BiDiBTurnoutManager(BiDiBSystemConnectionMemo memo)
      Create an new BiDiB TurnoutManager.
      Parameters:
      memo - the SystemConnectionMemo for this connection (contains the prefix string needed to parse names)

  • Method Details

    • getMemo

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

    • createNewTurnout

      public Turnout createNewTurnout(String systemName, String userName)
      Create a new Turnout based on the system name. Assumes calling method has checked that a Turnout with this system name does not already exist.
      Specified by:
      createNewTurnout in class AbstractTurnoutManager
      Parameters:
      systemName - the system name to use for the new Turnout
      userName - the user name to use for the new Turnout
      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 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 turnouts are instantiated and their config 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
      Default Turnout ensures a numeric only system name. Create a System Name from hardware address and system letter prefix. AbstractManager performs no validation.
      Specified by:
      createSystemName in interface TurnoutManager
      Overrides:
      createSystemName in class AbstractTurnoutManager
      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.

    • validSystemNameFormat

      public Manager.NameValidity validSystemNameFormat(String systemName)
      Public method to validate system name format.
      Specified by:
      validSystemNameFormat in interface Manager<Turnout>
      Overrides:
      validSystemNameFormat in class AbstractManager<Turnout>
      Parameters:
      systemName - system name
      Returns:
      VALID if system name has a valid format, else return INVALID

    • 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

    • getEntryToolTip

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