Package jmri.jmrix.openlcb

Class OlcbTurnoutManager

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.beans.VetoableChangeSupport
jmri.managers.AbstractManager<Turnout>
jmri.managers.AbstractTurnoutManager
jmri.jmrix.openlcb.OlcbTurnoutManager
All Implemented Interfaces:
PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Turnout>, NameIncrementingManager, ProvidingManager<Turnout>, TurnoutManager
public class OlcbTurnoutManager extends AbstractTurnoutManager
OpenLCB implementation of a TurnoutManager.

Turnouts must be manually created.

Since:
2.3.1

  • Constructor Details

  • Method Details

    • getMemo

      @Nonnull public CanSystemConnectionMemo 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

    • getKnownBeanProperties

      @Nonnull public List<NamedBeanPropertyDescriptor<?>> getKnownBeanProperties()
      Description copied from class: AbstractManager
      By default there are no custom properties.
      Specified by:
      getKnownBeanProperties in interface Manager<Turnout>
      Overrides:
      getKnownBeanProperties in class AbstractManager<Turnout>
      Returns:
      empty list

    • createNewTurnout

      @Nonnull protected Turnout createNewTurnout(@Nonnull String systemName, String userName) throws IllegalArgumentException
      Internal method to invoke the factory, after all the logic for returning an existing method has been invoked.
      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:
      never null the new Turnout or
      Throws:
      IllegalArgumentException - if unsuccessful

    • 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 turnouts are instantiated and their feedback type is read in. We use this hook to finalize the construction of the OpenLCB objects whose instantiation was deferred until the feedback type was known.

    • allowMultipleAdditions

      public boolean allowMultipleAdditions(@Nonnull String systemName)
      Description copied from interface: NameIncrementingManager
      Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.

      Default is not providing this service. Systems should override this method if they do provide the service.

      Parameters:
      systemName - the system name to check against; appears to be ignored in all implementations
      Returns:
      true if possible; false otherwise

    • createSystemName

      public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException
      Description copied from class: AbstractTurnoutManager
      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.

    • getNextValidSystemName

      @Nonnull @CheckReturnValue public String getNextValidSystemName(@Nonnull NamedBean currentBean) throws JmriException
      Description copied from interface: NameIncrementingManager
      Get the next valid NamedBean system name.

      For example, if the system name of the provided NamedBean is IS10, the next valid name is IS11.

      This should not be called if NameIncrementingManager.allowMultipleAdditions(java.lang.String) returns false.

      Pays no attention to whether the next NamedBean already exists or not, just works out the name. Nor is there any guarantee that the return value can actually be created: a provide() call on the return value can still perhaps fail in some circumstances.

      In some cases, there is no clear next address. In that case, a JmriException is thrown. For example, some systems have no concept of a "next" address; Internal sensors don't necessarily have numeric suffixes; etc.

      Default implementation works for names of the form (prefix)(type letter)(numeric string) by incrementing the numeric string as needed.

      Parameters:
      currentBean - The NamedBean who's system name that provides the base for "next"
      Returns:
      The next valid system name
      Throws:
      JmriException - If unable to create a valid next address

    • validateSystemNameFormat

      @Nonnull public String validateSystemNameFormat(@Nonnull String name, @Nonnull Locale locale) throws NamedBean.BadSystemNameException
      Validates to OpenLCB 2 part address format. 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
      Throws:
      NamedBean.BadSystemNameException - if provided name is an invalid format

    • 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