Package jmri.jmrix.lenz

Class XNetThrottleManager

java.lang.Object

jmri.jmrix.AbstractThrottleManager

jmri.jmrix.lenz.XNetThrottleManager

All Implemented Interfaces:

java.util.EventListener, AbstractMRListener, XNetListener, ThrottleManager

Direct Known Subclasses:

EliteXNetThrottleManager, RocoXNetThrottleManager

public class XNetThrottleManager
extends AbstractThrottleManager
implements XNetListener

XNet implementation of a ThrottleManager based on the AbstractThrottleManager.

Nested Class Summary

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

AbstractThrottleManager.Addresses

Field Summary

Fields

Modifier and Type	Field	Description
protected XNetTrafficController	tc
protected java.util.HashMap<LocoAddress,XNetThrottle>	throttles

Fields inherited from class jmri.jmrix.AbstractThrottleManager

adapterMemo, userName

Constructor Summary

Constructors

Constructor	Description
XNetThrottleManager(XNetSystemConnectionMemo memo)	Constructor.

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 100 and above is a long address.
boolean	canBeShortAddress(int address)	Address 99 and below is a short address.
boolean	disposeThrottle(DccThrottle t, ThrottleListener l)	Not for general use, see releaseThrottle and dispatchThrottle.
boolean	hasDispatchFunction()	XpressNet based systems DO NOT use the Dispatch Function.
protected static boolean	isLongAddress(int num)	Local method for deciding short/long address
void	message(XNetMessage l)	Listen for the messages to the LI100/LI101.
void	message(XNetReply r)	Handle incoming messages for throttles.
void	notifyTimeout(XNetMessage msg)	Handle a timeout notification.
void	releaseThrottle(DccThrottle t, ThrottleListener l)	The specified Throttle Listener has finished using a given throttle and no longer requires access to it.
void	requestThrottleSetup(LocoAddress address, boolean control)	Request a new throttle object be creaetd for the address, and let the throttle listeners know about it.
protected boolean	singleUse()	XpressNet based systems can have multiple throttles for the same device.
java.util.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, dispose, enablePrefSilentShareOption, enablePrefSilentStealOption, failedThrottleRequest, forceDisposeThrottle, getAddress, getAddress, getAddressProtocolTypes, getAddressTypes, getAddressTypeString, getProtocolFromString, getThrottleInfo, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getUserName, hideStealNotifications, makeHardwareDecision, notifyDecisionRequest, notifyThrottleKnown, removeListener, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottleSetup, responseThrottleDecision, responseThrottleDecision, responseThrottleDecision, showSessionCancelDialogue, updateNumUsers

Methods inherited from class java.lang.Object

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

Field Detail

throttles

protected final java.util.HashMap<LocoAddress,XNetThrottle> throttles

tc

protected XNetTrafficController tc

Constructor Detail

XNetThrottleManager

public XNetThrottleManager(XNetSystemConnectionMemo memo)

Constructor.

Parameters:

memo - system connection.

Method Detail

requestThrottleSetup

public void requestThrottleSetup(LocoAddress address,
                                 boolean control)

Request a new throttle object be creaetd for the address, and let the throttle listeners know about it.

Specified by:

requestThrottleSetup in class AbstractThrottleManager

Parameters:

address - address

control - false - read only.

hasDispatchFunction

public boolean hasDispatchFunction()

XpressNet based systems DO NOT use the Dispatch Function.

Specified by:

hasDispatchFunction in interface ThrottleManager

Overrides:

hasDispatchFunction in class AbstractThrottleManager

Returns:

true if dispatch is possible; false otherwise

singleUse

protected boolean singleUse()

XpressNet based systems can have multiple throttles for the same device.

Does this DCC system allow a Throttle (e.g. an address) to be used by only one user at a time?

Overrides:

singleUse in class AbstractThrottleManager

Returns:

true or false

canBeLongAddress

public boolean canBeLongAddress(int address)

Address 100 and above is a long address.

Specified by:

canBeLongAddress in interface ThrottleManager

Parameters:

address - address number to test

Returns:

true if address can be long; false otherwise

canBeShortAddress

public boolean canBeShortAddress(int address)

Address 99 and below is a short address.

Specified by:

canBeShortAddress in interface ThrottleManager

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?

Specified by:

addressTypeUnique in interface ThrottleManager

Returns:

true if ambiguous addresses are not allowed; false otherwise

isLongAddress

protected static boolean isLongAddress(int num)

Local method for deciding short/long address

Parameters:

num - address to examine

Returns:

true if can be long address

supportedSpeedModes

public java.util.EnumSet<SpeedStepMode> supportedSpeedModes()

What speed modes are supported by this system? value should be xor of possible modes specifed by the DccThrottle interface XpressNet supports 14,27,28 and 128 speed step modes

Specified by:

supportedSpeedModes in interface ThrottleManager

Overrides:

supportedSpeedModes in class AbstractThrottleManager

Returns:

an XOR of the possible modes specified in the throttle interface

message

public void message(XNetReply r)

Handle incoming messages for throttles.

Specified by:

message in interface XNetListener

Parameters:

r - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.

message

public void message(XNetMessage l)

Listen for the messages to the LI100/LI101.

Specified by:

message in interface XNetListener

Parameters:

l - The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.

notifyTimeout

public void notifyTimeout(XNetMessage msg)

Handle a timeout notification.

Specified by:

notifyTimeout in interface XNetListener

Parameters:

msg - message which has timed out.

releaseThrottle

public void releaseThrottle(DccThrottle t,
                            ThrottleListener l)

Description copied from class: AbstractThrottleManager

The specified Throttle Listener has finished using a given throttle and no longer requires access to it.

After releasing the throttle, the manager will perform further checks to see if it is in use by any other listeners or if there are any PropertyChangeListeners attached. If there are no other uses of the throttle then it is disposed of.

Normally, release ends with a call to dispose.

Specified by:

releaseThrottle in interface ThrottleManager

Overrides:

releaseThrottle in class AbstractThrottleManager

Parameters:

t - Throttle being released

l - Throttle Listener releasing the throttle

disposeThrottle

public boolean disposeThrottle(DccThrottle t,
                               ThrottleListener l)

Description copied from class: AbstractThrottleManager

Not for general use, see releaseThrottle and dispatchThrottle.

Dispose of object when finished it. This will free up hardware resource

Used for handling certain internal error conditions, where the object still exists but hardware is not associated with it.

After this, further usage of this Throttle object will result in a JmriException.

Specified by:

disposeThrottle in interface ThrottleManager

Overrides:

disposeThrottle in class AbstractThrottleManager

Parameters:

t - Throttle being released

l - Throttle Listener releasing the throttle

Returns:

true if the throttle has been disposed of.