Package jmri.jmrix.loconet

Class LnSensorManager

    • Method Detail

      • createNewSensor

        @Nonnull
protected Sensor createNewSensor​(@Nonnull
                                 java.lang.String systemName,
                                 java.lang.String userName)
                          throws java.lang.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:
        java.lang.IllegalArgumentException - if unsuccessful with reason for fail.

      • setUpdateBusy

        public void setUpdateBusy()
        Set Route busy when commands are being issued to Route turnouts.

      • setUpdateNotBusy

        public void setUpdateNotBusy()
        Set Route not busy when all commands have been issued to Route turnouts.

      • allowMultipleAdditions

        public boolean allowMultipleAdditions​(@Nonnull
                                      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.

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

      • createSystemName

        @Nonnull
public java.lang.String createSystemName​(@Nonnull
                                         java.lang.String curAddress,
                                         @Nonnull
                                         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
        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.

      • validateSystemNameFormat

        @Nonnull
public java.lang.String validateSystemNameFormat​(@Nonnull
                                                 java.lang.String systemName,
                                                 @Nonnull
                                                 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.

        Specified by:
        validateSystemNameFormat in interface Manager<Sensor>
        Parameters:
        systemName - 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

      • getBitFromSystemName

        public int getBitFromSystemName​(java.lang.String systemName)
        Get the bit address from the system name.
        Parameters:
        systemName - a valid LocoNet-based Turnout System Name
        Returns:
        the turnout number extracted from the system name

      • setRestingTime

        public void setRestingTime​(int rest)
        Set "resting time" for the Interrogation process. A minimum of 500 (milliseconds) and a maximum of 200000 (milliseconds) is implemented. Values below this lower limit are forced to the lower limit, and values above this upper limit are forced to the upper limit.
        Parameters:
        rest - Number of milliseconds (minimum) before sending next LocoNet Interrogate message.

      • getRestingTime

        public int getRestingTime()
        get Interrogation process's "resting time"
        Returns:
        Resting time, in milliseconds