Package jmri.jmrix.mqtt

Class MqttSignalMast

java.lang.Object

jmri.implementation.AbstractNamedBean

jmri.implementation.AbstractSignalMast

jmri.jmrix.mqtt.MqttSignalMast

All Implemented Interfaces:

VetoableChangeListener, Comparable<NamedBean>, EventListener, PropertyChangeProvider, NamedBean, Signal, SignalMast

public class MqttSignalMast
extends AbstractSignalMast

SignalMast implemented via MQTT messages

System name specifies the creation information:

 IF$mqm:basic:one-searchlight($0001)
 

The name is a colon-separated series of terms:

• IF$mqm - defines signal masts of this type
• basic - name of the signaling system
• one-searchlight - name of the particular aspect map
• ($0001) - small ordinal number for telling various signal masts apart apart

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.NamedBean

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	sendTopicPrefix

Fields inherited from class jmri.implementation.AbstractSignalMast

aspect, disabledAspects, map, speed

Fields inherited from class jmri.implementation.AbstractNamedBean

listenerRefs, mSystemName, register

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

PROPERTY_HELD, PROPERTY_LIT

Fields inherited from interface jmri.SignalMast

PROPERTY_ASPECT, PROPERTY_ASPECT_DISABLED, PROPERTY_ASPECT_ENABLED, PROPERTY_PERMISSIVE_SML_DISABLED

Constructor Summary

Constructors

Constructor	Description
MqttSignalMast(String systemName)
MqttSignalMast(String systemName, String userName)

Method Summary

Modifier and Type	Method	Description
static int	getLastRef()
protected String	makeSendTopic(String systemName)
void	setAspect(String aspect)	Set aspect to a valid name in the current signal system definition.
void	setHeld(boolean held)	Set the held property of the signal mast.
protected static void	setLastRef(int newVal)
void	setLit(boolean lit)	Set the lit property.
static void	setSendTopicPrefix(String prefix)

Methods inherited from class jmri.implementation.AbstractSignalMast

allowUnLit, configureAspectTable, configureSignalSystemDefinition, getAllKnownAspects, getAppearanceMap, getAspect, getBeanType, getDisabledAspects, getHeld, getLit, getMastType, getSignalSystem, getSpeed, getState, getUsageReport, getValidAspects, isAspectDisabled, isAtStop, isCleared, isPermissiveSmlDisabled, isShowingRestricting, setAllowUnLit, setAspectDisabled, setAspectEnabled, setMastType, setPermissiveSmlDisabled, setState, vetoableChange

Methods inherited from class jmri.implementation.AbstractNamedBean

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, compareSystemNameSuffix, describeState, dispose, 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

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, describeState, dispose, getComment, getDisplayName, getDisplayName, getListenerRef, getListenerRefs, getNumPropertyChangeListeners, getProperty, getPropertyChangeListenersByReference, getPropertyKeys, getRecommendedToolTip, getSystemName, getUserName, removeProperty, setComment, setProperty, setUserName, toString, updateListenerRef

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Field Details

sendTopicPrefix

@Nonnull
public static String sendTopicPrefix

Constructor Details

MqttSignalMast

public MqttSignalMast(String systemName,
 String userName)

MqttSignalMast

public MqttSignalMast(String systemName)

Method Details

setSendTopicPrefix

public static void setSendTopicPrefix(@Nonnull
 String prefix)

makeSendTopic

protected String makeSendTopic(String systemName)

setAspect

public void setAspect(@Nonnull
 String aspect)

Description copied from interface: SignalMast

Set aspect to a valid name in the current signal system definition.

Specified by:

setAspect in interface SignalMast

Overrides:

setAspect in class AbstractSignalMast

Parameters:

aspect - the new aspect shown

setHeld

public void setHeld(boolean held)

Description copied from class: AbstractSignalMast

Set the held property of the signal mast.

Note that this does not directly effect the output on the layout; the held property is a local variable which effects the aspect only via higher-level logic.

Specified by:

setHeld in interface Signal

Specified by:

setHeld in interface SignalMast

Overrides:

setHeld in class AbstractSignalMast

Parameters:

held - the new value of the help property

setLit

public void setLit(boolean lit)

Description copied from class: AbstractSignalMast

Set the lit property.

This acts on all the SignalHeads included in this SignalMast

Specified by:

setLit in interface Signal

Specified by:

setLit in interface SignalMast

Overrides:

setLit in class AbstractSignalMast

Parameters:

lit - the new value of lit

setLastRef

protected static void setLastRef(int newVal)

Parameters:

newVal - for ordinal of all MqttSignalMasts in use

getLastRef

public static int getLastRef()

Returns:

highest ordinal of all MqttSignalMasts in use