Package jmri.jmrix.sprog

Class SprogThrottleManager

java.lang.Object

jmri.jmrix.AbstractThrottleManager

jmri.jmrix.sprog.SprogThrottleManager

All Implemented Interfaces:

ThrottleManager

public class SprogThrottleManager
extends AbstractThrottleManager

SPROG implementation of a ThrottleManager.

Updated by Andrew Crosland February 2012 to enable 28 step speed packets

Nested Class Summary

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

AbstractThrottleManager.Addresses

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	throttleInUse

Fields inherited from class jmri.jmrix.AbstractThrottleManager

adapterMemo, userName

Constructor Summary

Constructors

Constructor	Description
SprogThrottleManager(SprogSystemConnectionMemo 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)	Addresses 0-10239 can be long.
boolean	canBeShortAddress(int address)	The short addresses 1-127 are available.
boolean	disposeThrottle(DccThrottle t, ThrottleListener l)	Not for general use, see releaseThrottle and dispatchThrottle.
(package private) void	release()
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.
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, 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

Field Detail

throttleInUse

boolean throttleInUse

Constructor Detail

SprogThrottleManager

public SprogThrottleManager(SprogSystemConnectionMemo memo)

Constructor.

Parameters:

memo - system connection.

Method Detail

release

void release()

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.

supportedSpeedModes

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

What speed modes are supported by this system? Value should be one of possible modes specified 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

canBeLongAddress

public boolean canBeLongAddress(int address)

Addresses 0-10239 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 short addresses 1-127 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

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.