Package jmri.jmrix.dccpp

Class DCCppSensorManager

    • Constructor Detail

    • 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 - when SystemName can't be converted

      • message

        public void message​(DCCppMessage l)
        Listen for the outgoing messages (to the command station)
        Specified by:
        message in interface DCCppListener
        Parameters:
        l - the message to parse

      • notifyTimeout

        public void notifyTimeout​(DCCppMessage msg)
        Description copied from interface: DCCppListener
        Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
        Specified by:
        notifyTimeout in interface DCCppListener
        Parameters:
        msg - the message that timed out.

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

      • validateSystemNameFormat

        public java.lang.String validateSystemNameFormat​(java.lang.String systemName,
                                                 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 Sensor System Name
        Returns:
        the sensor number extracted from the system name