Package jmri.jmrix.secsi

Class SerialSensorManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Sensor>

jmri.managers.AbstractSensorManager

jmri.jmrix.secsi.SerialSensorManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.beans.VetoableChangeListener, java.util.EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, AbstractMRListener, SerialListener, Manager<Sensor>, NameIncrementingManager, ProvidingManager<Sensor>, SensorManager

public class SerialSensorManager
extends AbstractSensorManager
implements SerialListener

Manage the system-specific SECSI Sensor implementation.

System names are "VSnnnn", where V is the user configurable system prefix, nnnn is the sensor number without padding.

Sensors are numbered from 1.

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) static int	SENSORSPERNODE	Number of sensors per address in the naming scheme.

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
SerialSensorManager(SecsiSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
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	getEntryToolTip()	Provide a manager-specific tooltip for the Add new item beantable pane.
SecsiSystemConnectionMemo	getMemo()	Get the system connection for this manager.
void	message(SerialMessage r)	Dummy routine
void	registerSensorsForNode(SerialNode node)	Register any orphan Sensors when a new Serial Node is created.
void	reply(SerialReply r)	Process a reply to a poll of Sensors of one node.
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

createSystemName, 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, dispose, 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

allowMultipleAdditions, getNextValidSystemName

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.SensorManager

dispose, 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

SENSORSPERNODE

static final int SENSORSPERNODE

Number of sensors per address in the naming scheme.

The first node address uses sensors from 1 to SENSORSPERNODE-1, the second from SENSORSPERNODE+1 to SENSORSPERNODE+(SENSORSPERNODE-1), etc.

Must be more than, and is generally one more than, SerialNode.MAXSENSORS

See Also:

Constant Field Values

Constructor Detail

SerialSensorManager

public SerialSensorManager(SecsiSystemConnectionMemo memo)

Method Detail

getMemo

@Nonnull
public SecsiSystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Sensor>

Overrides:

getMemo in class AbstractManager<Sensor>

Returns:

the system connection for this manager

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.

System name is normalized to ensure uniqueness.

Specified by:

createNewSensor in class AbstractSensorManager

Parameters:

systemName - the system name to use for the new Sensor

userName - the optional user name to use for the new Sensor

Returns:

the new Sensor

Throws:

java.lang.IllegalArgumentException - when SystemName can't be converted

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 return Manager.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 interface Manager<Sensor>

Parameters:

systemName - the system name to validate

locale - 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

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 interface Manager<Sensor>

Overrides:

validSystemNameFormat in class AbstractManager<Sensor>

Parameters:

systemName - the system name

Returns:

Manager.NameValidity.INVALID if system name does not start with Manager.getSystemNamePrefix(); Manager.NameValidity.VALID_AS_PREFIX_ONLY if system name equals Manager.getSystemNamePrefix(); otherwise Manager.NameValidity.VALID to allow Managers that do not perform more specific validation to be considered valid.

message

public void message(SerialMessage r)

Dummy routine

Specified by:

message in interface SerialListener

reply

public void reply(SerialReply r)

Process a reply to a poll of Sensors of one node.

Specified by:

reply in interface SerialListener

registerSensorsForNode

public void registerSensorsForNode(SerialNode node)

Register any orphan Sensors when a new Serial Node is created.

Parameters:

node - node to register.

getEntryToolTip

public java.lang.String getEntryToolTip()

Provide a manager-specific tooltip for the Add new item beantable pane.

Specified by:

getEntryToolTip in interface Manager<Sensor>

Specified by:

getEntryToolTip in interface SensorManager

Overrides:

getEntryToolTip in class AbstractSensorManager

Returns:

the tool tip or null to disable the tool tip