Package jmri.jmrix.can.cbus

Class CbusSensorManager

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.beans.VetoableChangeSupport
jmri.managers.AbstractManager<Sensor>
jmri.managers.AbstractSensorManager
jmri.jmrix.can.cbus.CbusSensorManager
All Implemented Interfaces:
PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Sensor>, NameIncrementingManager, ProvidingManager<Sensor>, SensorManager
public class CbusSensorManager extends AbstractSensorManager
Implement SensorManager for CAN CBUS systems.

System names are "MS+n;-m", where M is the user configurable system prefix, n and m are the events (signed for on/off, separated by ;).

  • Constructor Details

  • Method Details

    • createNewSensor

      @Nonnull protected Sensor createNewSensor(@Nonnull String systemName, String userName) throws IllegalArgumentException
      Internal method to invoke the factory and create a new Sensor. Called after all the logic for returning an existing Sensor has been invoked. An existing SystemName is not found, existing UserName not found. Implementing classes should base Sensor on the system name, then add user name.
      Specified by:
      createNewSensor in class AbstractSensorManager
      Parameters:
      systemName - the system name to use for the new Sensor
      userName - the optional user name to use for the new Sensor
      Returns:
      the new Sensor
      Throws:
      IllegalArgumentException - if the system name is not in a valid format

    • createSystemName

      public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriException
      Default Sensor 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 SensorManager
      Overrides:
      createSystemName in class AbstractSensorManager
      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.

    • allowMultipleAdditions

      public boolean allowMultipleAdditions(@Nonnull String systemName)
      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

    • 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)
      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(@Nonnull 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<Sensor>
      Overrides:
      validSystemNameFormat in class AbstractManager<Sensor>
      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.

    • getEntryToolTip

      public String getEntryToolTip()
      Provide a manager-specific tooltip for the Add new item beantable pane.
      Specified by:
      getEntryToolTip in interface Manager<Sensor>
      Specified by:
      getEntryToolTip in interface SensorManager
      Overrides:
      getEntryToolTip in class AbstractSensorManager
      Returns:
      the tool tip or null to disable the tool tip

    • propertyChange

      public void propertyChange(PropertyChangeEvent e)
      Description copied from class: AbstractManager
      The PropertyChangeListener interface in this class is intended to keep track of user name changes to individual NamedBeans. It is not completely implemented yet. In particular, listeners are not added to newly registered objects.
      Specified by:
      propertyChange in interface PropertyChangeListener
      Overrides:
      propertyChange in class AbstractManager<Sensor>
      Parameters:
      e - the event