Class DCCppSensorManager
- All Implemented Interfaces:
PropertyChangeListener
,VetoableChangeListener
,EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,AbstractMRListener
,DCCppListener
,Manager<Sensor>
,ProvidingManager<Sensor>
,SensorManager
public class DCCppSensorManager extends AbstractSensorManager implements DCCppListener
System names are "DSnnn", where D is the user configurable system prefix, nnn is the sensor number without padding.
-
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 Modifier and Type Field Description (package private) int
iName
protected DCCppTrafficController
tc
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 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_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 DCCppSensorManager(DCCppSystemConnectionMemo memo)
Create an new DCC++ SensorManager. -
Method Summary
Modifier and Type Method Description boolean
allowMultipleAdditions(String systemName)
Determines if it is possible to add a range of sensors in numerical order.Sensor
createNewSensor(String systemName, String userName)
Internal method to invoke the factory and create a new Sensor based on the system name and optional user name, after all the logic for returning an existing Sensor has been invoked.String
createSystemName(String curAddress, String prefix)
Default Sensor ensures a numeric only system name.void
dispose()
Free resources when no longer used.int
getBitFromSystemName(String systemName)
Get the bit address from the system name.String
getEntryToolTip()
Provide a manager-specific tooltip for the Add new item beantable pane.DCCppSystemConnectionMemo
getMemo()
Get the system connection for this manager.String
getNextValidAddress(String curAddress, String prefix, boolean ignoreInitialExisting)
Provide next valid DCC++ address.void
message(DCCppMessage l)
Listen for the outgoing messages (to the command station)void
message(DCCppReply l)
Listen for sensors, creating them as needed.void
notifyTimeout(DCCppMessage msg)
Member function invoked by an DCCppInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.String
validateSystemNameFormat(String systemName, Locale locale)
Validate the format of name, returning it unchanged if valid.Manager.NameValidity
validSystemNameFormat(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, updateAll
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, deleteBean, deregister, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getObjectCount, getSystemNameList, 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, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat
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.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
Field Details
-
Constructor Details
-
DCCppSensorManager
Create an new DCC++ SensorManager. Has to register for DCC++ events.- Parameters:
memo
- the supporting system connection memo
-
-
Method Details
-
getMemo
Get the system connection for this manager. -
dispose
Description copied from class:AbstractManager
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 public Sensor createNewSensor(@Nonnull String systemName, String userName) throws IllegalArgumentExceptionInternal method to invoke the factory and create a new Sensor based on the system name and optional user name, after all the logic for returning an existing Sensor has been invoked.- 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 or null if unsuccessful
- Throws:
IllegalArgumentException
- when SystemName can't be converted
-
message
Listen for sensors, creating them as needed.- Specified by:
message
in interfaceDCCppListener
- Parameters:
l
- the message to parse
-
message
Listen for the outgoing messages (to the command station)- Specified by:
message
in interfaceDCCppListener
- Parameters:
l
- the message to parse
-
notifyTimeout
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 interfaceDCCppListener
- Parameters:
msg
- the message that timed out.
-
allowMultipleAdditions
Description copied from class:AbstractSensorManager
Determines if it is possible to add a range of sensors in numerical order.- Specified by:
allowMultipleAdditions
in interfaceSensorManager
- Overrides:
allowMultipleAdditions
in classAbstractSensorManager
- Parameters:
systemName
- the system name to check against; appears to be ignored in all implementations- Returns:
- true if possible; false otherwise
-
createSystemName
@Nonnull public String createSystemName(@Nonnull String curAddress, @Nonnull String prefix) throws JmriExceptionDescription 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 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.
-
getNextValidAddress
public String getNextValidAddress(@Nonnull String curAddress, @Nonnull String prefix, boolean ignoreInitialExisting) throws JmriExceptionProvide next valid DCC++ address. Does not enforce any rules on the encoder or input values.- Specified by:
getNextValidAddress
in interfaceSensorManager
- Overrides:
getNextValidAddress
in classAbstractManager<Sensor>
- Parameters:
curAddress
- the current addressprefix
- the system connection prefixignoreInitialExisting
- false to return the starting address if it does not exist, else true to force an increment.- Returns:
- the next valid address after the current address
- Throws:
JmriException
- if unable to get the current / next address, or more than 10 next addresses in use.
-
validSystemNameFormat
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
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
Get the bit address from the system name.- Parameters:
systemName
- a valid Sensor System Name- Returns:
- the sensor number extracted from the system name
-
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
-