Package jmri.jmrix.tmcc

Class SerialThrottleManager

java.lang.Object

jmri.jmrix.AbstractThrottleManager

jmri.jmrix.tmcc.SerialThrottleManager

All Implemented Interfaces:

ThrottleManager

public class SerialThrottleManager
extends AbstractThrottleManager

Implementation of a TMCC ThrottleManager.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractThrottleManager

AbstractThrottleManager.Addresses

Field Summary

Fields inherited from class jmri.jmrix.AbstractThrottleManager

adapterMemo, userName

Constructor Summary

Constructors

Constructor	Description
SerialThrottleManager(TmccSystemConnectionMemo memo)	Create a throttle manager.

Method Summary

Modifier and Type	Method	Description
boolean	addressTypeUnique()	Are there any ambiguous addresses (short vs long) on this system?
boolean	canBeLongAddress(int address)	Address 1 and above can be long.
boolean	canBeShortAddress(int address)	The full range of short addresses are available.
void	dispose()	Allow to cleanly release the traffic controller in ThrottleManager Tests remove listeners, if any stop timers, is any
LocoAddress.Protocol[]	getAddressProtocolTypes()	Get a list of different protocols supported by the system, to include short vs long or DCC vs Selectrix vs Motorola.
String[]	getAddressTypes()	By default, only DCC in this implementation
void	requestThrottleSetup(LocoAddress a, boolean control)	Abstract member to actually do the work of configuring a new throttle, usually via interaction with the DCC system.
EnumSet<SpeedStepMode>	supportedSpeedModes()	What speed modes are supported by this system?

Methods inherited from class jmri.jmrix.AbstractThrottleManager

addressReleased, addressStillRequired, addressStillRequired, addressStillRequired, addressStillRequired, attachListener, cancelThrottleRequest, cancelThrottleRequest, cancelThrottleRequest, cancelThrottleRequest, dispatchThrottle, disposeThrottle, enablePrefSilentShareOption, enablePrefSilentStealOption, failedThrottleRequest, forceDisposeThrottle, getAddress, getAddress, getAddressTypeString, getProtocolFromString, getThrottleInfo, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getUserName, hasDispatchFunction, hideStealNotifications, makeHardwareDecision, notifyDecisionRequest, notifyThrottleKnown, releaseThrottle, removeListener, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottleSetup, responseThrottleDecision, responseThrottleDecision, responseThrottleDecision, showSessionCancelDialogue, singleUse, updateNumUsers

Methods inherited from class java.lang.Object

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

Constructor Details

SerialThrottleManager

public SerialThrottleManager(TmccSystemConnectionMemo memo)

Create a throttle manager.

Parameters:

memo - the memo for the connection this tm will use

Method Details

dispose

public void dispose()

Allow to cleanly release the traffic controller in ThrottleManager Tests

• remove listeners, if any
• stop timers, is any

Specified by:

dispose in interface ThrottleManager

Overrides:

dispose in class AbstractThrottleManager

requestThrottleSetup

public void requestThrottleSetup(LocoAddress a,
 boolean control)

Description copied from class: AbstractThrottleManager

Abstract member to actually do the work of configuring a new throttle, usually via interaction with the DCC system.

Specified by:

requestThrottleSetup in class AbstractThrottleManager

Parameters:

a - address

control - false - read only.

canBeLongAddress

public boolean canBeLongAddress(int address)

Address 1 and above can be long.

Parameters:

address - address number to test

Returns:

true if address can be long; false otherwise

canBeShortAddress

public boolean canBeShortAddress(int address)

The full range of short addresses are available.

Parameters:

address - address number to test

Returns:

true if address can be short; false otherwise

addressTypeUnique

public boolean addressTypeUnique()

Are there any ambiguous addresses (short vs long) on this system?

Returns:

true if ambiguous addresses are not allowed; false otherwise

getAddressTypes

public String[] getAddressTypes()

Description copied from class: AbstractThrottleManager

By default, only DCC in this implementation

Specified by:

getAddressTypes in interface ThrottleManager

Overrides:

getAddressTypes in class AbstractThrottleManager

Returns:

the list of supported address protocols

getAddressProtocolTypes

public LocoAddress.Protocol[] getAddressProtocolTypes()

Description copied from class: AbstractThrottleManager

Get a list of different protocols supported by the system, to include short vs long or DCC vs Selectrix vs Motorola.

Specified by:

getAddressProtocolTypes in interface ThrottleManager

Overrides:

getAddressProtocolTypes in class AbstractThrottleManager

Returns:

a list of supported address protocols

supportedSpeedModes

public EnumSet<SpeedStepMode> supportedSpeedModes()

What speed modes are supported by this system? value should be xor of possible modes specifed by the DccThrottle interface

Specified by:

supportedSpeedModes in interface ThrottleManager

Overrides:

supportedSpeedModes in class AbstractThrottleManager

Returns:

an XOR of the possible modes specified in the throttle interface