Package jmri.jmrix.roco.z21

Class Z21SensorManager

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

        Assumes calling method has checked that a Sensor with this system name does not already exist.

        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 the system name is not in a valid format

      • reply

        public void reply​(Z21Reply msg)
        Member function that will be invoked by a z21Interface implementation to forward a z21 message from the layout.
        Specified by:
        reply in interface Z21Listener
        Parameters:
        msg - The received z21 reply. Note that this same object may be presented to multiple users. It should not be modified here.

      • message

        public void message​(Z21Message l)
        Member function that will be invoked by a z21Interface implementation to forward a z21 message sent to the layout. Normally, this function will do nothing.
        Specified by:
        message in interface Z21Listener
        Parameters:
        l - The received z21 message. Note that this same object may be presented to multiple users. It should not be modified here.

      • validateSystemNameFormat

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

      • allowMultipleAdditions

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

        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
        Description copied from class: AbstractSensorManager
        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.