Package jmri.jmrix.mqtt

Class MqttSensorManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Sensor>

jmri.managers.AbstractSensorManager

jmri.jmrix.mqtt.MqttSensorManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Sensor>, ProvidingManager<Sensor>, SensorManager

public class MqttSensorManager
extends AbstractSensorManager

Implementation of the MqttSensorManager interface.

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	defaultState
(package private) MqttContentParser<Sensor>	parser
protected String	prefix
String	rcvTopicPrefix
String	sendTopicPrefix

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, 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
MqttSensorManager(SystemConnectionMemo memo)

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.
protected Sensor	createNewSensor(String systemName, String userName)	Create an new sensor object.
String	createSystemName(String topicSuffix, String prefix)	Default Sensor ensures a numeric only system name.
static int	getDefaultStateForNewSensors()
String	getEntryToolTip()	Provide a manager-specific tooltip for the Add new item beantable pane.
MqttSystemConnectionMemo	getMemo()	Get the system connection for this manager.
static void	setDefaultStateForNewSensors(int defaultSetting)
void	setParser(MqttContentParser<Sensor> parser)
void	setRcvTopicPrefix(String rcvTopicPrefix)
void	setSendTopicPrefix(String sendTopicPrefix)
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, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, 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, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.SensorManager

dispose, getByUserName, getNextValidAddress, getNextValidAddress, provide

Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider

setPropertyChangesSilenced

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Details

sendTopicPrefix

@Nonnull public String sendTopicPrefix

rcvTopicPrefix

@Nonnull public String rcvTopicPrefix

defaultState

static int defaultState

prefix

protected String prefix

parser

MqttContentParser<Sensor> parser

Constructor Details

MqttSensorManager

public MqttSensorManager(@Nonnull SystemConnectionMemo memo)

Method Details

getMemo

@Nonnull public MqttSystemConnectionMemo 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

setSendTopicPrefix

public void setSendTopicPrefix(@Nonnull String sendTopicPrefix)

setRcvTopicPrefix

public void setRcvTopicPrefix(@Nonnull String rcvTopicPrefix)

allowMultipleAdditions

public boolean allowMultipleAdditions(String systemName)

Determines if it is possible to add a range of sensors in numerical order.

Specified by:

allowMultipleAdditions in interface SensorManager

Overrides:

allowMultipleAdditions in class AbstractSensorManager

Parameters:

systemName - the system name to check against; appears to be ignored in all implementations

Returns:

true if possible; false otherwise

createSystemName

public String createSystemName(@Nonnull String topicSuffix, @Nonnull 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. Accepts any string.

Specified by:

createSystemName in interface SensorManager

Overrides:

createSystemName in class AbstractSensorManager

Parameters:

topicSuffix - 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.

createNewSensor

@Nonnull protected Sensor createNewSensor(String systemName, String userName) throws IllegalArgumentException

Create an new sensor object. 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 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:

never null

Throws:

IllegalArgumentException - if unsuccessful with reason for fail.

setDefaultStateForNewSensors

public static void setDefaultStateForNewSensors(int defaultSetting)

getDefaultStateForNewSensors

public static int getDefaultStateForNewSensors()

validSystemNameFormat

public Manager.NameValidity validSystemNameFormat(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.

getEntryToolTip

public 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

setParser

public void setParser(MqttContentParser<Sensor> parser)