Class LnSensorManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractManager<Sensor>
-
- jmri.managers.AbstractSensorManager
-
- jmri.jmrix.loconet.LnSensorManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,LocoNetListener
,Manager<Sensor>
,NameIncrementingManager
,ProvidingManager<Sensor>
,SensorManager
- Direct Known Subclasses:
LnSensorManager
public class LnSensorManager extends AbstractSensorManager implements LocoNetListener
Manage the LocoNet-specific Sensor implementation. System names are "LSnnn", where L is the user configurable system prefix, nnn is the sensor number without padding. Valid sensor numbers are in the range 1 to 2048, inclusive. Provides a mechanism to perform the LocoNet "Interrogate" process in order to get initial values from those LocoNet devices which support the process and provide LocoNet Sensor (and/or LocoNet Turnout) functionality.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) class
LnSensorManager.LnSensorUpdateThread
Class providing a thread to query LocoNet Sensor and Turnout states.-
Nested classes/interfaces inherited from interface jmri.Manager
Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity
-
-
Field Summary
Fields Modifier and Type Field Description (package private) int
iName
protected int
restingTime
Minimum amount of time since previous LocoNet Sensor State report or previous LocoNet Turnout State report or previous LocoNet "interrogate" message.protected LnTrafficController
tc
(package private) LnSensorManager.LnSensorUpdateThread
thread
-
Fields inherited from class jmri.managers.AbstractSensorManager
sensorDebounceGoingActive, sensorDebounceGoingInActive
-
Fields inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, memo, silenceableProperties, silencedProperties
-
Fields inherited from class jmri.beans.VetoableChangeSupport
vetoableChangeSupport
-
Fields inherited from class jmri.beans.PropertyChangeSupport
propertyChangeSupport
-
Fields inherited from interface jmri.Manager
ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, 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 LnSensorManager(LocoNetSystemConnectionMemo memo, boolean interrogateAtStart)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowMultipleAdditions(java.lang.String systemName)
Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.protected Sensor
createNewSensor(java.lang.String systemName, java.lang.String userName)
Internal method to invoke the factory and create a new Sensor.java.lang.String
createSystemName(java.lang.String curAddress, java.lang.String prefix)
Default Sensor ensures a numeric only system name.void
dispose()
Free resources when no longer used.int
getBitFromSystemName(java.lang.String systemName)
Get the bit address from the system name.java.lang.String
getEntryToolTip()
Provide a manager-specific tooltip for the Add new item beantable pane.LocoNetSystemConnectionMemo
getMemo()
Get the system connection for this manager.int
getRestingTime()
get Interrogation process's "resting time"void
message(LocoNetMessage l)
Listen for sensor messages, creating them as needed.void
setRestingTime(int rest)
Set "resting time" for the Interrogation process.void
setUpdateBusy()
Set Route busy when commands are being issued to Route turnouts.void
setUpdateNotBusy()
Set Route not busy when all commands have been issued to Route turnouts.void
updateAll()
Requests status updates from all layout sensors.java.lang.String
validateSystemNameFormat(java.lang.String systemName, java.util.Locale locale)
Validate the format of name, returning it unchanged if valid.Manager.NameValidity
validSystemNameFormat(java.lang.String systemName)
Test if parameter is a properly formatted system name.-
Methods inherited from class jmri.managers.AbstractSensorManager
getBeanTypeHandled, getBySystemName, getDefaultSensorDebounceGoingActive, getDefaultSensorDebounceGoingInActive, getNamedBeanClass, getSensor, getXMLOrder, isPullResistanceConfigurable, newSensor, provideSensor, setDefaultSensorDebounceGoingActive, setDefaultSensorDebounceGoingInActive, typeLetter
-
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, deleteBean, deregister, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, vetoableChange
-
Methods inherited from class jmri.beans.VetoableChangeSupport
addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
Methods inherited from class jmri.beans.PropertyChangeSupport
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
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, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat
-
Methods inherited from interface jmri.NameIncrementingManager
getNextValidSystemName
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface jmri.SensorManager
getByUserName, provide
-
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
-
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
-
-
-
Field Detail
-
tc
protected final LnTrafficController tc
-
restingTime
protected int restingTime
Minimum amount of time since previous LocoNet Sensor State report or previous LocoNet Turnout State report or previous LocoNet "interrogate" message.
-
thread
volatile LnSensorManager.LnSensorUpdateThread thread
-
iName
int iName
-
-
Constructor Detail
-
LnSensorManager
public LnSensorManager(LocoNetSystemConnectionMemo memo, boolean interrogateAtStart)
-
-
Method Detail
-
getMemo
@Nonnull public LocoNetSystemConnectionMemo getMemo()
Get the system connection for this manager.
-
dispose
public void dispose()
Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.- Specified by:
dispose
in interfaceManager<Sensor>
- Specified by:
dispose
in interfaceSensorManager
- Overrides:
dispose
in classAbstractManager<Sensor>
-
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 classAbstractSensorManager
- Parameters:
systemName
- the system name to use for the new SensoruserName
- the optional user name to use for the new Sensor- Returns:
- the new Sensor
- Throws:
java.lang.IllegalArgumentException
- if unsuccessful with reason for fail.
-
message
public void message(LocoNetMessage l)
Listen for sensor messages, creating them as needed.- Specified by:
message
in interfaceLocoNetListener
- Parameters:
l
- LocoNet message to be examined
-
updateAll
public void updateAll()
Requests status updates from all layout sensors.- Specified by:
updateAll
in interfaceSensorManager
- Overrides:
updateAll
in classAbstractSensorManager
-
setUpdateBusy
public void setUpdateBusy()
Set Route busy when commands are being issued to Route turnouts.
-
setUpdateNotBusy
public void setUpdateNotBusy()
Set Route not busy when all commands have been issued to Route turnouts.
-
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 interfaceNameIncrementingManager
- 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
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 interfaceSensorManager
- Overrides:
createSystemName
in classAbstractSensorManager
- 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.
-
validSystemNameFormat
public Manager.NameValidity validSystemNameFormat(@Nonnull java.lang.String systemName)
Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user.- Specified by:
validSystemNameFormat
in interfaceManager<Sensor>
- Overrides:
validSystemNameFormat
in classAbstractManager<Sensor>
- Parameters:
systemName
- the system name- Returns:
Manager.NameValidity.INVALID
if system name does not start withManager.getSystemNamePrefix()
;Manager.NameValidity.VALID_AS_PREFIX_ONLY
if system name equalsManager.getSystemNamePrefix()
; otherwiseManager.NameValidity.VALID
to allow Managers that do not perform more specific validation to be considered valid.
-
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 returnManager.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 interfaceManager<Sensor>
- Parameters:
systemName
- the system name to validatelocale
- 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 LocoNet-based Turnout System Name- Returns:
- the turnout number extracted from the system name
-
getEntryToolTip
public java.lang.String getEntryToolTip()
Provide a manager-specific tooltip for the Add new item beantable pane.- Specified by:
getEntryToolTip
in interfaceManager<Sensor>
- Specified by:
getEntryToolTip
in interfaceSensorManager
- Overrides:
getEntryToolTip
in classAbstractSensorManager
- Returns:
- the tool tip or null to disable the tool tip
-
setRestingTime
public void setRestingTime(int rest)
Set "resting time" for the Interrogation process. A minimum of 500 (milliseconds) and a maximum of 200000 (milliseconds) is implemented. Values below this lower limit are forced to the lower limit, and values above this upper limit are forced to the upper limit.- Parameters:
rest
- Number of milliseconds (minimum) before sending next LocoNet Interrogate message.
-
getRestingTime
public int getRestingTime()
get Interrogation process's "resting time"- Returns:
- Resting time, in milliseconds
-
-