Interface SensorManager
-
- All Superinterfaces:
Manager<Sensor>
,NameIncrementingManager
,PropertyChangeProvider
,ProvidingManager<Sensor>
,SilenceablePropertyChangeProvider
,VetoableChangeProvider
- All Known Implementing Classes:
AbstractSensorManager
,AcelaSensorManager
,BiDiBSensorManager
,CbusSensorManager
,ConcentratorSensorManager
,Dcc4PcSensorManager
,DCCppSensorManager
,EcosSensorManager
,InternalSensorManager
,IpocsSensorManager
,JMRIClientSensorManager
,LnSensorManager
,LnSensorManager
,MarklinSensorManager
,MqttSensorManager
,NceSensorManager
,OlcbSensorManager
,ProxySensorManager
,RaspberryPiSensorManager
,RfidSensorManager
,RpsSensorManager
,SerialSensorManager
,SerialSensorManager
,SerialSensorManager
,SerialSensorManager
,SerialSensorManager
,SerialSensorManager
,SpecificSensorManager
,SpecificSensorManager
,SpecificSensorManager
,SpecificSensorManager
,SRCPSensorManager
,StandaloneSensorManager
,TamsSensorManager
,XBeeSensorManager
,XNetSensorManager
,Z21SensorManager
public interface SensorManager extends ProvidingManager<Sensor>, NameIncrementingManager
Interface for controlling sensors.
This file is part of JMRI.JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.
JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-
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 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
createSystemName(java.lang.String curAddress, java.lang.String prefix)
Get a system name for a given hardware address and system prefix.void
dispose()
Free resources when no longer used.Sensor
getBySystemName(java.lang.String name)
Get an existing Sensor or return null if it doesn't exist.Sensor
getByUserName(java.lang.String name)
Get an existing Sensor or return null if it doesn't exist.long
getDefaultSensorDebounceGoingActive()
long
getDefaultSensorDebounceGoingInActive()
java.lang.String
getEntryToolTip()
Provide a manager-specific tooltip for the Add new item beantable pane.Sensor
getSensor(java.lang.String name)
Get an existing Sensor or return null if it doesn't exist.boolean
isPullResistanceConfigurable()
Do the sensor objects provided by this manager support configuring an internal pullup or pull down resistor?Sensor
newSensor(java.lang.String systemName, java.lang.String userName)
Return a Sensor with the specified user or system name.default Sensor
provide(java.lang.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.Sensor
provideSensor(java.lang.String name)
Get the Sensor with the user name, then system name if needed; if that fails, create a new Sensor.void
setDefaultSensorDebounceGoingActive(long timer)
void
setDefaultSensorDebounceGoingInActive(long timer)
void
updateAll()
Requests status of all layout sensors under this Sensor Manager.-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, getBeanTypeHandled, getBeanTypeHandled, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanClass, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, getXMLOrder, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat
-
Methods inherited from interface jmri.NameIncrementingManager
allowMultipleAdditions, getNextValidSystemName
-
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
-
-
-
-
Method Detail
-
provideSensor
@Nonnull Sensor provideSensor(@Nonnull java.lang.String name) throws java.lang.IllegalArgumentException
Get the Sensor with the user name, then system name if needed; if that fails, create a new Sensor. If the name is a valid system name, it will be used for the new Sensor. 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.- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
java.lang.IllegalArgumentException
- if Sensor doesn't already exist and the manager cannot create the Sensor due to an illegal name or name that can't be parsed.
-
provide
default Sensor 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)
,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<Sensor>
- 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.
-
getSensor
@CheckReturnValue @CheckForNull Sensor getSensor(@Nonnull java.lang.String name)
Get an existing Sensor or return null if it doesn't exist. Locates via user name, then system name if needed.- Parameters:
name
- User name or system name to match- Returns:
- null if no match found
-
dispose
void dispose()
Description copied from interface:Manager
Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.
-
newSensor
@Nonnull Sensor newSensor(@Nonnull java.lang.String systemName, @CheckForNull java.lang.String userName) throws java.lang.IllegalArgumentException
Return a Sensor with the specified user or system name. Return Sensor by UserName else provide by SystemName.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; 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 Sensor object created; a valid system name must be provided
- If both names are provided, the system name defines the hardware access of the desired sensor, and the user address is associated with it. The system name must be valid.
- Parameters:
systemName
- the desired system nameuserName
- the desired user name- Returns:
- requested Sensor object
- Throws:
java.lang.IllegalArgumentException
- if cannot create the Sensor due to e.g. an illegal name or name that can't be parsed.
-
getByUserName
@CheckReturnValue @CheckForNull Sensor getByUserName(@Nonnull java.lang.String name)
Get an existing Sensor or return null if it doesn't exist. Locates via user name.- Specified by:
getByUserName
in interfaceManager<Sensor>
- Parameters:
name
- User name to match- Returns:
- null if no match found
-
getBySystemName
@CheckReturnValue @CheckForNull Sensor getBySystemName(@Nonnull java.lang.String name)
Get an existing Sensor or return null if it doesn't exist. Locates via system name- Specified by:
getBySystemName
in interfaceManager<Sensor>
- Parameters:
name
- System name to match- Returns:
- null if no match found
-
updateAll
void updateAll()
Requests status of all layout sensors under this Sensor Manager.This method may be invoked whenever the status of sensors needs to be updated from the layout, for example, when an XML configuration file is read in.
This method only needs be implemented in system-specific Sensor Managers where readout of Sensor status from the layout is possible.
-
createSystemName
@Nonnull java.lang.String createSystemName(@Nonnull java.lang.String curAddress, @Nonnull java.lang.String prefix) throws JmriException
Get a system name for a given hardware address and system prefix.- Parameters:
curAddress
- desired hardware addressprefix
- system prefix used in system name- Returns:
- the complete sensor system name for the prefix and current address
- Throws:
JmriException
- if unable to create a system name for the given address, possibly due to invalid address format
-
getDefaultSensorDebounceGoingActive
@CheckReturnValue long getDefaultSensorDebounceGoingActive()
-
getDefaultSensorDebounceGoingInActive
@CheckReturnValue long getDefaultSensorDebounceGoingInActive()
-
setDefaultSensorDebounceGoingActive
void setDefaultSensorDebounceGoingActive(long timer)
-
setDefaultSensorDebounceGoingInActive
void setDefaultSensorDebounceGoingInActive(long timer)
-
isPullResistanceConfigurable
boolean isPullResistanceConfigurable()
Do the sensor objects provided by this manager support configuring an internal pullup or pull down resistor?- Returns:
- true if pull up/pull down configuration is supported.
-
getEntryToolTip
java.lang.String getEntryToolTip()
Provide a manager-specific tooltip for the Add new item beantable pane.- Specified by:
getEntryToolTip
in interfaceManager<Sensor>
- Returns:
- the tool tip or null to disable the tool tip
-
-