Package jmri.managers

Class ProxyTurnoutManager

    • Method Detail

      • getTurnout

        public Turnout getTurnout​(@Nonnull
                          java.lang.String name)
        Locate via user name, then system name if needed.
        Specified by:
        getTurnout in interface TurnoutManager
        Parameters:
        name - User name or system name to match
        Returns:
        Null if nothing by that name exists

      • makeBean

        @Nonnull
protected Turnout makeBean​(Manager<Turnout> manager,
                           java.lang.String systemName,
                           java.lang.String userName)
                    throws java.lang.IllegalArgumentException
        Defer creation of the proper type to the subclass.
        Specified by:
        makeBean in class AbstractProvidingProxyManager<Turnout>
        Parameters:
        manager - the manager to invoke
        systemName - the system name
        userName - the user name
        Returns:
        a bean
        Throws:
        java.lang.IllegalArgumentException - if unable to make.

      • provideTurnout

        @Nonnull
public Turnout provideTurnout​(@Nonnull
                              java.lang.String name)
                       throws java.lang.IllegalArgumentException
        Get the Turnout with the user name, then system name if needed; if that fails, create a new Turnout. If the name is a valid system name, it will be used for the new Turnout. Otherwise, the Manager.makeSystemName(java.lang.String) method will attempt to turn it into a valid system name.

        This provides the same function as ProvidingManager.provide(java.lang.String) which has a more generic form.

        Specified by:
        provideTurnout in interface TurnoutManager
        Parameters:
        name - User name, system name, or address which can be promoted to system name
        Returns:
        Never null
        Throws:
        java.lang.IllegalArgumentException - if Turnout doesn't already exist and the manager cannot create the Turnout due to an illegal name or name that can't be parsed.

      • provide

        @Nonnull
public Turnout provide​(@Nonnull
                       java.lang.String name)
                throws java.lang.IllegalArgumentException
        Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.

        If the name is a valid system name, it will be used for the new NamedBean. Otherwise, the Manager.makeSystemName(java.lang.String) method will attempt to turn it into a valid system name which the manager will attempt to use. If that fails, an exception is thrown.

        This is similar to the specific methods found in certain type-specific managers: TurnoutManager.provideTurnout(java.lang.String), SensorManager.provideSensor(java.lang.String), et al. Those might be more mnemonic; this one is more generic. Neither is preferred nor deprecated; use your choice.

        Specified by:
        provide in interface ProvidingManager<Turnout>
        Specified by:
        provide in interface TurnoutManager
        Parameters:
        name - User name, system name, or address which can be promoted to system name
        Returns:
        Never null
        Throws:
        java.lang.IllegalArgumentException - if NamedBean doesn't already exist and the manager cannot create it due to an illegal name or name that can't be parsed.

      • newTurnout

        @Nonnull
public Turnout newTurnout​(@Nonnull
                          java.lang.String systemName,
                          java.lang.String userName)
                   throws java.lang.IllegalArgumentException
        Get an instance with the specified system and user names. Note that two calls with the same arguments will get the same instance; there is only one Sensor object representing a given physical turnout and therefore only one with a specific system or user name.

        This will always return a valid object reference for a valid request; a new object will be created if necessary. In that case:

        • If a null reference is given for user name, no user name will be associated with the Turnout object created; a valid system name must be provided
        • If a null reference is given for the system name, a system name will _somehow_ be inferred from the user name. How this is done is system specific. Note: a future extension of this interface will add an exception to signal that this was not possible.
        • If both names are provided, the system name defines the hardware access of the desired turnout, and the user address is associated with it.
        Note that it is possible to make an inconsistent request if both addresses are provided, but the given values are associated with different objects. This is a problem, and we don't have a good solution except to issue warnings. This will mostly happen if you're creating Sensors when you should be looking them up.
        Specified by:
        newTurnout in interface TurnoutManager
        Parameters:
        systemName - the system name
        userName - the user name (optional)
        Returns:
        requested Turnout object (never null)
        Throws:
        java.lang.IllegalArgumentException - if cannot create the Turnout; likely due to an illegal name or name that cannot be parsed

      • getClosedText

        @Nonnull
public java.lang.String getClosedText()
        Get text to be used for the Turnout.CLOSED state in user communication. Allows text other than "CLOSED" to be use with certain hardware system to represent the Turnout.CLOSED state. Defaults to the primary manager. This means that the primary manager sets the terminology used. Note: the primary manager need not override the method in AbstractTurnoutManager if "CLOSED" is the desired terminology.
        Specified by:
        getClosedText in interface TurnoutManager
        Returns:
        the textual representation of Turnout.CLOSED

      • getThrownText

        @Nonnull
public java.lang.String getThrownText()
        Get text to be used for the Turnout.THROWN state in user communication. Allows text other than "THROWN" to be use with certain hardware system to represent the Turnout.THROWN state. Defaults to the primary manager. This means that the primary manager sets the terminology used. Note: the primary manager need not override the method in AbstractTurnoutManager if "THROWN" is the desired terminology.
        Specified by:
        getThrownText in interface TurnoutManager
        Returns:
        the textual representation of Turnout.THROWN

      • askNumControlBits

        public int askNumControlBits​(@Nonnull
                             java.lang.String systemName)
        Get from the user, the number of addressed bits used to control a turnout. Normally this is 1, and the default routine returns 1 automatically. Turnout Managers for systems that can handle multiple control bits should override this method with one which asks the user to specify the number of control bits. If the user specifies more than one control bit, this method should check if the additional bits are available (not assigned to another object). If the bits are not available, this method should return 0 for number of control bits, after informing the user of the problem.
        Specified by:
        askNumControlBits in interface TurnoutManager
        Parameters:
        systemName - the turnout system name
        Returns:
        the bit length for turnout control

      • askControlType

        public int askControlType​(@Nonnull
                          java.lang.String systemName)
        Get from the user, the type of output to be used bits to control a turnout. Normally this is 0 for 'steady state' control, and the default routine returns 0 automatically. Turnout Managers for systems that can handle pulsed control as well as steady state control should override this method with one which asks the user to specify the type of control to be used. The routine should return 0 for 'steady state' control, or n for 'pulsed' control, where n specifies the duration of the pulse (normally in seconds).
        Specified by:
        askControlType in interface TurnoutManager
        Parameters:
        systemName - the turnout system name
        Returns:
        0 for steady state or the number of seconds for a pulse control

      • 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

      • getOutputInterval

        public int getOutputInterval()
        Get the Interval (in ms) to wait between output commands. Configured in AdapterConfig, stored in memo.
        Specified by:
        getOutputInterval in interface TurnoutManager
        Returns:
        outputInterval from default TurnoutManager

      • setOutputInterval

        public void setOutputInterval​(int newInterval)
        Set the Interval (in ms) to wait between output commands. This method is only used in jmri.jmrix.internal.InternalTurnoutManagerTest and should not be used in actual code, as it can overwrite individual per connection values set by the user.
        Specified by:
        setOutputInterval in interface TurnoutManager
        Parameters:
        newInterval - the new Output Interval in Milliseconds

      • outputIntervalEnds

        @Nonnull
public java.time.LocalDateTime outputIntervalEnds()
        Get end time of latest OutputInterval, calculated from the current time.
        Specified by:
        outputIntervalEnds in interface TurnoutManager
        Returns:
        end time of latest OutputInterval as LocalDateTime from default TurnoutManager

      • getXMLOrder

        public int getXMLOrder()
        Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.

        Yes, that's an overly-centralized methodology, but it works for now.

        Specified by:
        getXMLOrder in interface Manager<Turnout>
        Returns:
        write order for this Manager; larger is later.

      • getBeanTypeHandled

        @Nonnull
public java.lang.String getBeanTypeHandled​(boolean plural)
        Get the user-readable name of the type of NamedBean handled by this manager.

        For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.

        Specified by:
        getBeanTypeHandled in interface Manager<Turnout>
        Parameters:
        plural - true to return plural form of the type; false to return singular form
        Returns:
        a string of the bean type that the manager handles, eg Turnout, Sensor etc

      • getNamedBeanClass

        public java.lang.Class<Turnout> getNamedBeanClass()
        Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.
        Specified by:
        getNamedBeanClass in interface Manager<Turnout>
        Returns:
        the class supported by this Manager.