Package jmri.jmrix.mqtt

Class MqttSensor

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSensor

jmri.jmrix.mqtt.MqttSensor

All Implemented Interfaces:

java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, DigitalIO, MqttEventListener, NamedBean, Sensor

public class MqttSensor
extends AbstractSensor
implements MqttEventListener

Implementation of the Sensor interface for MQTT layouts.

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Nested classes/interfaces inherited from interface jmri.Sensor

Sensor.PullResistance

Field Summary

Fields

Modifier and Type	Field	Description
(package private) MqttContentParser<Sensor>	parser

Fields inherited from class jmri.implementation.AbstractSensor

_inverted, _knownState, _rawState, r, sensorDebounceGoingActive, sensorDebounceGoingInActive, thr, useDefaultTimerSettings

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

Fields inherited from interface jmri.DigitalIO

OFF, ON

Fields inherited from interface jmri.NamedBean

DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_COMMENT, PROPERTY_ENABLED, PROPERTY_KNOWN_STATE, PROPERTY_STATE, PROPERTY_USERNAME, QUOTED_NAME_FORMAT, UNKNOWN

Fields inherited from interface jmri.Sensor

ACTIVE, INACTIVE, MAX_DEBOUNCE, PROPERTY_ACTIVE_TIMER, PROPERTY_GLOBAL_TIMER, PROPERTY_INACTIVE_TIMER, PROPERTY_SENSOR_INVERTED

Constructor Summary

Constructors

Constructor	Description
MqttSensor(MqttAdapter ma, java.lang.String systemName, java.lang.String sendTopic, java.lang.String rcvTopic)	Requires, but does not check, that the system name and topic be consistent

Method Summary

Modifier and Type	Method	Description
boolean	canInvert()	By default, all implementations based on this can invert
void	dispose()	Deactivate this object, so that it releases as many resources as possible and no longer effects others.
void	notifyMqttMessage(java.lang.String receivedTopic, java.lang.String message)
void	requestUpdateFromLayout()	The request is just swallowed
void	setKnownState(int s)	Perform setKnownState(int) for implementations that can't actually do it on the layout.
void	setParser(MqttContentParser<Sensor> parser)

Methods inherited from class jmri.implementation.AbstractSensor

describeState, getBeanType, getInverted, getKnownState, getPullResistance, getRawState, getReporter, getSensorDebounceGoingActiveTimer, getSensorDebounceGoingInActiveTimer, getState, getUseDefaultTimerSettings, sensorDebounce, setInverted, setOwnState, setPullResistance, setReporter, setSensorDebounceGoingActiveTimer, setSensorDebounceGoingInActiveTimer, setState, setUseDefaultTimerSettings, stateChangeCheck

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, equals, firePropertyChange, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getPropertyKeys, getSystemName, getUserName, hashCode, removeProperty, removePropertyChangeListener, removePropertyChangeListener, setComment, setProperty, setUserName, toString, toStringSuffix, updateListenerRef, vetoableChange

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.NamedBean

addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, compareTo, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUsageReport, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef, vetoableChange

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface jmri.Sensor

getCommandedState, isConsistentState, setCommandedState

Field Detail

parser

MqttContentParser<Sensor> parser

Constructor Detail

MqttSensor

MqttSensor(MqttAdapter ma,
           java.lang.String systemName,
           java.lang.String sendTopic,
           java.lang.String rcvTopic)

Requires, but does not check, that the system name and topic be consistent

Parameters:

ma - Adapter to specific connection

systemName - System Name for this Sensor

sendTopic - Topic string to be used when sending from JMRI

rcvTopic - Topic string to be used when receiving by JMRI

Method Detail

setParser

public void setParser(MqttContentParser<Sensor> parser)

canInvert

public boolean canInvert()

Description copied from class: AbstractSensor

By default, all implementations based on this can invert

Specified by:

canInvert in interface Sensor

Overrides:

canInvert in class AbstractSensor

Returns:

true if can be inverted; false otherwise

requestUpdateFromLayout

public void requestUpdateFromLayout()

The request is just swallowed

Specified by:

requestUpdateFromLayout in interface DigitalIO

setKnownState

public void setKnownState(int s)

Description copied from class: AbstractSensor

Perform setKnownState(int) for implementations that can't actually do it on the layout. Not intended for use by implementations that can.

Specified by:

setKnownState in interface Sensor

Overrides:

setKnownState in class AbstractSensor

Parameters:

s - the state to set

notifyMqttMessage

public void notifyMqttMessage(java.lang.String receivedTopic,
                              java.lang.String message)

Specified by:

notifyMqttMessage in interface MqttEventListener

dispose

public void dispose()

Description copied from class: AbstractNamedBean

Deactivate this object, so that it releases as many resources as possible and no longer effects others.

For example, if this object has listeners, after a call to this method it should no longer notify those listeners. Any native or system-wide resources it maintains should be released, including threads, files, etc.

It is an error to invoke any other methods on this object once dispose() has been called. Note, however, that there is no guarantee about behavior in that case.

Afterwards, references to this object may still exist elsewhere, preventing its garbage collection. But it's formally dead, and shouldn't be keeping any other objects alive. Therefore, this method should null out any references to other objects that this NamedBean contained.

Specified by:

dispose in interface NamedBean

Specified by:

dispose in interface Sensor

Overrides:

dispose in class AbstractSensor