Package jmri.jmrix.bidib

Class BiDiBSensorManager

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

  • Constructor Details

  • Method Details

    • getMemo

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

    • dispose

      public void dispose()
      Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.
      Specified by:
      dispose in interface Manager<Sensor>
      Specified by:
      dispose in interface SensorManager
      Overrides:
      dispose in class AbstractManager<Sensor>

    • createNewSensor

      public Sensor createNewSensor(String systemName, String userName)
      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

    • 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.

    • updateNodeFeedbacks

      public void updateNodeFeedbacks(org.bidib.jbidibc.messages.Node node)

    • updateNodeFeedbacks

      public void updateNodeFeedbacks(org.bidib.jbidibc.messages.Node node, int min, int max)

    • createSystemName

      public String createSystemName(String curAddress, 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(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

    • 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<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