Package jmri.jmrix.mqtt

Class MqttConsist

java.lang.Object

jmri.implementation.DccConsist

jmri.jmrix.mqtt.MqttConsist

All Implemented Interfaces:

java.util.EventListener, Consist, ProgListener

public class MqttConsist
extends DccConsist

This is the Consist definition for a consist on an MQTT system.

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	sendTopicPrefix

Fields inherited from class jmri.implementation.DccConsist

consistAddress, consistDir, consistID, consistList, consistPosition, consistRoster, consistType

Fields inherited from interface jmri.Consist

ADVANCED_CONSIST, CS_CONSIST, POSITION_LEAD, POSITION_TRAIL

Fields inherited from interface jmri.ProgListener

CommError, ConfirmFailed, FailedTimeout, NoAck, NoLocoDetected, NotImplemented, OK, ProgrammerBusy, ProgrammingShort, SequenceError, UnknownError, UserAborted

Constructor Summary

Constructors

Constructor	Description
MqttConsist(int address, MqttSystemConnectionMemo memo, java.lang.String sendTopicPrefix)
MqttConsist(DccLocoAddress address, MqttSystemConnectionMemo memo, java.lang.String sendTopicPrefix)

Method Summary

Modifier and Type	Method	Description
void	activate()	Activates the consist for use with a throttle
void	add(DccLocoAddress LocoAddress, boolean directionNormal)	Add a Locomotive to a Consist.
boolean	contains(DccLocoAddress address)	Does the consist contain the specified address?
void	deactivate()	Deactivates and removes the consist from a throttle
void	dispose()	A method for cleaning up the consist
boolean	getLocoDirection(DccLocoAddress address)	Get the relative direction setting for a specific locomotive in the consist.
boolean	isAddressAllowed(DccLocoAddress address)	Is this address allowed?
void	remove(DccLocoAddress LocoAddress)	Remove a Locomotive from this Consist.
void	restore(DccLocoAddress LocoAddress, boolean directionNormal)	Restore a Locomotive to Consist, but don't write to the command station.
void	setConsistType(int consist_type)	Set the Consist Type.
int	sizeLimit()	Is there a size limit for this consist?

Methods inherited from class jmri.implementation.DccConsist

addConsistListener, addToAdvancedConsist, getConsistAddress, getConsistID, getConsistList, getConsistType, getPosition, getRosterId, loadDecoderFile, loadDecoderFromLoco, notifyConsistListeners, programmingOpReply, removeConsistListener, removeFromAdvancedConsist, resetRosterEntryCVValue, restore, reverse, setConsistID, setPosition, setRosterEntryCVValue, setRosterId, updateRosterCV

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sendTopicPrefix

@Nonnull
public java.lang.String sendTopicPrefix

Constructor Detail

MqttConsist

public MqttConsist(int address,
                   MqttSystemConnectionMemo memo,
                   java.lang.String sendTopicPrefix)

MqttConsist

public MqttConsist(DccLocoAddress address,
                   MqttSystemConnectionMemo memo,
                   java.lang.String sendTopicPrefix)

Method Detail

dispose

public void dispose()

Description copied from interface: Consist

A method for cleaning up the consist

Specified by:

dispose in interface Consist

Overrides:

dispose in class DccConsist

setConsistType

public void setConsistType(int consist_type)

Description copied from interface: Consist

Set the Consist Type.

Specified by:

setConsistType in interface Consist

Overrides:

setConsistType in class DccConsist

Parameters:

consist_type - the consist type

isAddressAllowed

public boolean isAddressAllowed(DccLocoAddress address)

Is this address allowed? On MQTT systems, all addresses but 0 can be used in a consist

Specified by:

isAddressAllowed in interface Consist

Overrides:

isAddressAllowed in class DccConsist

Parameters:

address - the address

Returns:

true if allowed; false otherwise

sizeLimit

public int sizeLimit()

Is there a size limit for this consist?

Specified by:

sizeLimit in interface Consist

Overrides:

sizeLimit in class DccConsist

Returns:

-1 for Controller Consists (no limit), 0 for any other consist type

contains

public boolean contains(DccLocoAddress address)

Does the consist contain the specified address?

Specified by:

contains in interface Consist

Overrides:

contains in class DccConsist

Parameters:

address - the address to check

Returns:

true if in consist; false otherwise

getLocoDirection

public boolean getLocoDirection(DccLocoAddress address)

Get the relative direction setting for a specific locomotive in the consist.

Specified by:

getLocoDirection in interface Consist

Overrides:

getLocoDirection in class DccConsist

Parameters:

address - the address to check

Returns:

true if locomotive is in consist in its normal direction of travel; false otherwise

add

public void add(DccLocoAddress LocoAddress,
                boolean directionNormal)

Add a Locomotive to a Consist.

Specified by:

add in interface Consist

Overrides:

add in class DccConsist

Parameters:

LocoAddress - is the Locomotive address to add to the locomotive

directionNormal - is True if the locomotive is traveling the same direction as the consist, or false otherwise.

restore

public void restore(DccLocoAddress LocoAddress,
                    boolean directionNormal)

Restore a Locomotive to Consist, but don't write to the command station. This is used for restoring the consist from a file or adding a consist read from the command station.

Specified by:

restore in interface Consist

Overrides:

restore in class DccConsist

Parameters:

LocoAddress - is the Locomotive address to add to the locomotive

directionNormal - is True if the locomotive is traveling the same direction as the consist, or false otherwise.

remove

public void remove(DccLocoAddress LocoAddress)

Remove a Locomotive from this Consist.

Specified by:

remove in interface Consist

Overrides:

remove in class DccConsist

Parameters:

LocoAddress - is the Locomotive address to add to the locomotive

activate

public void activate()

Activates the consist for use with a throttle

deactivate

public void deactivate()

Deactivates and removes the consist from a throttle