Class BiDiBSensorManager

    • Method Detail

      • createNewSensor

        public Sensor createNewSensor​(java.lang.String systemName,
                                      java.lang.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
        systemName - the system name to use for the new Sensor
        userName - the optional user name to use for the new Sensor
        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 java.lang.String createSystemName​(java.lang.String curAddress,
                                                 java.lang.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
        createSystemName in class AbstractSensorManager
        curAddress - hardware address, no system prefix or type letter.
        prefix - - just system prefix, not including Type Letter.
        full system name with system prefix, type letter and hardware address.
        JmriException - if unable to create a system name.
      • allowMultipleAdditions

        public boolean allowMultipleAdditions​(java.lang.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.

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

        public java.lang.String validateSystemNameFormat​(java.lang.String name,
                                                         java.util.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.

        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
        the unchanged value of the name parameter