Package jmri.jmrix.dccpp

Class DCCppTurnoutManager

    • Constructor Detail

    • Method Detail

      • createNewTurnout

        @Nonnull
protected Turnout createNewTurnout​(@Nonnull
                                   java.lang.String systemName,
                                   java.lang.String userName)
                            throws java.lang.IllegalArgumentException
        Internal method to invoke the factory, after all the logic for returning an existing Turnout has been invoked.
        Specified by:
        createNewTurnout in class AbstractTurnoutManager
        Parameters:
        systemName - the system name to use for the new Turnout
        userName - the user name to use for the new Turnout
        Returns:
        the new Turnout or
        Throws:
        java.lang.IllegalArgumentException - if unsuccessful

      • message

        public void message​(DCCppReply l)
        Member function that will be invoked by a DCCppInterface implementation to forward a DCC++ message from the layout. Listen for turnouts, creating them as needed.
        Specified by:
        message in interface DCCppListener
        Parameters:
        l - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.

      • message

        public void message​(DCCppMessage l)
        Listen for the outgoing messages (to the command station)
        Specified by:
        message in interface DCCppListener
        Parameters:
        l - The received DCC++ message. Note that this same object may be presented to multiple users. It should not be modified here.

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

      • 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<Turnout>
        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 Turnout System Name
        Returns:
        the turnout number extracted from the system name