Class ProxyTurnoutManager
- All Implemented Interfaces:
PropertyChangeListener
,EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<Turnout>
,Manager.ManagerDataListener<Turnout>
,ProvidingManager<Turnout>
,ProxyManager<Turnout>
,TurnoutManager
public class ProxyTurnoutManager extends AbstractProvidingProxyManager<Turnout> implements TurnoutManager
-
Nested Class Summary
Nested classes/interfaces inherited from interface jmri.Manager
Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity
-
Field Summary
Fields inherited from class jmri.managers.AbstractProxyManager
defaultManager, listeners, silenceableProperties, silencedProperties
Fields inherited from interface jmri.Manager
ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS
-
Constructor Summary
Constructors Constructor Description ProxyTurnoutManager()
-
Method Summary
Modifier and Type Method Description void
addManager(Manager<Turnout> m)
Add a Manager to the collection of Managers.boolean
allowMultipleAdditions(String systemName)
Determines if it is possible to add a range of turnouts in numerical order.int
askControlType(String systemName)
Get from the user, the type of output to be used bits to control a turnout.int
askNumControlBits(String systemName)
Get from the user, the number of addressed bits used to control a turnout.String
getBeanTypeHandled(boolean plural)
Get the user-readable name of the type of NamedBean handled by this manager.String
getClosedText()
Get text to be used for the Turnout.CLOSED state in user communication.String
getDefaultClosedSpeed()
String
getDefaultThrownSpeed()
Class<Turnout>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.String
getNextValidAddress(String curAddress, String prefix)
Get the next valid address.String
getNextValidAddress(String curAddress, String prefix, boolean ignoreInitialExisting)
Get the Next valid Turnout address.int
getOutputInterval()
Get the Interval (in ms) to wait between output commands.String
getThrownText()
Get text to be used for the Turnout.THROWN state in user communication.Turnout
getTurnout(String name)
Locate via user name, then system name if needed.String[]
getValidOperationTypes()
Get a list of the valid TurnoutOperation subtypes for use with turnouts of this system.int
getXMLOrder()
Determine the order that types should be written when storing panel files.boolean
isControlTypeSupported(String systemName)
Determine if the manager supports the handling of pulsed and steady state control as theTurnoutManager.askControlType(java.lang.String)
will always return a value even if it is not supported.boolean
isNumControlBitsSupported(String systemName)
Determine if the manager supports multiple control bits, asTurnoutManager.askNumControlBits(java.lang.String)
will always return a value even if it is not supported.protected Turnout
makeBean(Manager<Turnout> manager, String systemName, String userName)
Defer creation of the proper type to the subclass.protected AbstractManager<Turnout>
makeInternalManager()
Create specific internal manager as needed for concrete type.Turnout
newTurnout(String systemName, String userName)
Get an instance with the specified system and user names.LocalDateTime
outputIntervalEnds()
Get end time of latest OutputInterval, calculated from the current time.Turnout
provide(String name)
Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.Turnout
provideTurnout(String name)
Get the Turnout with the user name, then system name if needed; if that fails, create a new Turnout.void
setDefaultClosedSpeed(String speed)
void
setDefaultThrownSpeed(String speed)
void
setOutputInterval(int newInterval)
Set the Interval (in ms) to wait between output commands.Methods inherited from class jmri.managers.AbstractProvidingProxyManager
newNamedBean, provideNamedBean
Methods inherited from class jmri.managers.AbstractProxyManager
addDataListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, contentsChanged, createSystemManager, createSystemName, createSystemName, deleteBean, deregister, dispose, getBySystemName, getByUserName, getDefaultManager, getDisplayOrderManagerList, getEntryToolTip, getInternalManager, getKnownBeanProperties, getManager, getManagerList, getManagerOrDefault, getMemo, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, initInternal, intervalAdded, intervalRemoved, makeSystemName, propertyChange, recomputeNamedBeanSet, register, removeDataListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setDataListenerMute, setPropertyChangesSilenced, typeLetter, validateSystemNameFormat, validSystemNameFormat
Methods inherited from class jmri.beans.VetoableChangeSupport
fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners
Methods inherited from class jmri.beans.PropertyChangeSupport
fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, dispose, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
Methods inherited from interface jmri.TurnoutManager
createSystemName, getBySystemName, getByUserName
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
Constructor Details
-
ProxyTurnoutManager
public ProxyTurnoutManager()
-
-
Method Details
-
makeInternalManager
Description copied from class:AbstractProxyManager
Create specific internal manager as needed for concrete type.- Specified by:
makeInternalManager
in classAbstractProxyManager<Turnout>
- Returns:
- an internal manager
-
addManager
Add a Manager to the collection of Managers.- Specified by:
addManager
in interfaceProxyManager<Turnout>
- Overrides:
addManager
in classAbstractProxyManager<Turnout>
- Parameters:
m
- the Manager to add; if manager has already been added, it will not be added again
-
getTurnout
Locate via user name, then system name if needed.- Specified by:
getTurnout
in interfaceTurnoutManager
- 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, String systemName, String userName) throws IllegalArgumentExceptionDefer creation of the proper type to the subclass.- Specified by:
makeBean
in classAbstractProvidingProxyManager<Turnout>
- Parameters:
manager
- the manager to invokesystemName
- the system nameuserName
- the user name- Returns:
- a bean
- Throws:
IllegalArgumentException
- if unable to make.
-
provideTurnout
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, theManager.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 interfaceTurnoutManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
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
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 interfaceProvidingManager<Turnout>
- Specified by:
provide
in interfaceTurnoutManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
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 String systemName, String userName) throws IllegalArgumentExceptionGet 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.
- Specified by:
newTurnout
in interfaceTurnoutManager
- Parameters:
systemName
- the system nameuserName
- the user name (optional)- Returns:
- requested Turnout object (never null)
- Throws:
IllegalArgumentException
- if cannot create the Turnout; likely due to an illegal name or name that cannot be parsed
-
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 interfaceTurnoutManager
- Returns:
- the textual representation of
Turnout.CLOSED
-
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 interfaceTurnoutManager
- Returns:
- the textual representation of
Turnout.THROWN
-
askNumControlBits
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 interfaceTurnoutManager
- Parameters:
systemName
- the turnout system name- Returns:
- the bit length for turnout control
-
askControlType
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 interfaceTurnoutManager
- Parameters:
systemName
- the turnout system name- Returns:
- 0 for steady state or the number of seconds for a pulse control
-
isControlTypeSupported
Determine if the manager supports the handling of pulsed and steady state control as theTurnoutManager.askControlType(java.lang.String)
will always return a value even if it is not supported.- Specified by:
isControlTypeSupported
in interfaceTurnoutManager
- Parameters:
systemName
- the turnout system name- Returns:
- true if manager supports the control type returned by
TurnoutManager.askControlType(java.lang.String)
; false otherwise
-
isNumControlBitsSupported
Determine if the manager supports multiple control bits, asTurnoutManager.askNumControlBits(java.lang.String)
will always return a value even if it is not supported.- Specified by:
isNumControlBitsSupported
in interfaceTurnoutManager
- Parameters:
systemName
- the turnout system name- Returns:
- true if manager supports multiple control bits for the turnout; false otherwise
-
getValidOperationTypes
Get a list of the valid TurnoutOperation subtypes for use with turnouts of this system.- Specified by:
getValidOperationTypes
in interfaceTurnoutManager
- Returns:
- a list of subtypes or an empty list if turnout operations are not supported
-
allowMultipleAdditions
Determines if it is possible to add a range of turnouts in numerical order.- Specified by:
allowMultipleAdditions
in interfaceTurnoutManager
- Parameters:
systemName
- the starting turnout system name; ignored in all known implementations- Returns:
- true if a range of turnouts can be added; false otherwise
-
getNextValidAddress
public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix) throws JmriExceptionDescription copied from interface:TurnoutManager
Get the next valid address.Determine if the address supplied is valid and free. If not then it shall return the next free valid address up to a maximum of 10 addresses away from the initial address. Used when adding add a range of Turnouts.
- Specified by:
getNextValidAddress
in interfaceTurnoutManager
- Parameters:
curAddress
- desired hardware addressprefix
- System prefix used in system name- Returns:
- the next available address or null if next 10 addresses unavailable.
- Throws:
JmriException
- if unable to provide a turnout at the desired address due to invalid format for the current address or other reasons.
-
getNextValidAddress
public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix, boolean ignoreInitialExisting) throws JmriExceptionDescription copied from interface:TurnoutManager
Get the Next valid Turnout address.- Specified by:
getNextValidAddress
in interfaceTurnoutManager
- Parameters:
curAddress
- the starting hardware address to get the next valid from.prefix
- system prefix, just system name, not type letter.ignoreInitialExisting
- false to return the starting address if it does not exist, else true to force an increment.- Returns:
- the next valid system name not already in use, excluding both system name prefix and type letter.
- Throws:
JmriException
- if unable to get the current / next address, or more than 10 next addresses in use.
-
setDefaultClosedSpeed
- Specified by:
setDefaultClosedSpeed
in interfaceTurnoutManager
- Throws:
JmriException
-
setDefaultThrownSpeed
- Specified by:
setDefaultThrownSpeed
in interfaceTurnoutManager
- Throws:
JmriException
-
getDefaultThrownSpeed
- Specified by:
getDefaultThrownSpeed
in interfaceTurnoutManager
-
getDefaultClosedSpeed
- Specified by:
getDefaultClosedSpeed
in interfaceTurnoutManager
-
getOutputInterval
Get the Interval (in ms) to wait between output commands. Configured in AdapterConfig, stored in memo.- Specified by:
getOutputInterval
in interfaceTurnoutManager
- Returns:
- outputInterval from default TurnoutManager
-
setOutputInterval
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 interfaceTurnoutManager
- Parameters:
newInterval
- the new Output Interval in Milliseconds
-
outputIntervalEnds
Get end time of latest OutputInterval, calculated from the current time.- Specified by:
outputIntervalEnds
in interfaceTurnoutManager
- Returns:
- end time of latest OutputInterval as LocalDateTime from default TurnoutManager
-
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 interfaceManager<Turnout>
- Returns:
- write order for this Manager; larger is later.
-
getBeanTypeHandled
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 interfaceManager<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
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 interfaceManager<Turnout>
- Returns:
- the class supported by this Manager.
-