Package jmri.jmrix.easydcc
Class EasyDccThrottleManager
java.lang.Object
jmri.jmrix.AbstractThrottleManager
jmri.jmrix.easydcc.EasyDccThrottleManager
- All Implemented Interfaces:
ThrottleManager
public class EasyDccThrottleManager extends AbstractThrottleManager
EasyDCC implementation of a ThrottleManager.
Based on early NCE code.
-
Nested Class Summary
Nested classes/interfaces inherited from class jmri.jmrix.AbstractThrottleManager
AbstractThrottleManager.Addresses
-
Field Summary
-
Constructor Summary
Constructors Constructor Description EasyDccThrottleManager(EasyDccSystemConnectionMemo 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, seereleaseThrottle
anddispatchThrottle
.boolean
hasDispatchFunction()
Check to see if the Dispatch Button should be enabled or not Default to true, override if necessary(package private) static boolean
isLongAddress(int num)
void
requestThrottleSetup(LocoAddress address, 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, dispose, enablePrefSilentShareOption, enablePrefSilentStealOption, failedThrottleRequest, forceDisposeThrottle, getAddress, getAddress, getAddressProtocolTypes, getAddressTypes, getAddressTypeString, getProtocolFromString, getThrottleInfo, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getUserName, hideStealNotifications, makeHardwareDecision, notifyDecisionRequest, notifyThrottleKnown, releaseThrottle, removeListener, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottleSetup, responseThrottleDecision, responseThrottleDecision, responseThrottleDecision, showSessionCancelDialogue, singleUse, stealThrottleRequest, stealThrottleRequest, stealThrottleRequest, stealThrottleRequest, updateNumUsers
-
Constructor Details
-
EasyDccThrottleManager
Constructor- Parameters:
memo
- system connection.
-
-
Method Details
-
requestThrottleSetup
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 classAbstractThrottleManager
- Parameters:
address
- addresscontrol
- false - read only.
-
hasDispatchFunction
Description copied from class:AbstractThrottleManager
Check to see if the Dispatch Button should be enabled or not Default to true, override if necessary- Specified by:
hasDispatchFunction
in interfaceThrottleManager
- Overrides:
hasDispatchFunction
in classAbstractThrottleManager
- Returns:
- true if dispatch is possible; false otherwise
-
canBeLongAddress
Address 100 and above is a long address.- Parameters:
address
- address number to test- Returns:
- true if address can be long; false otherwise
-
canBeShortAddress
Address 99 and below is a short address.- Parameters:
address
- address number to test- Returns:
- true if address can be short; false otherwise
-
addressTypeUnique
Are there any ambiguous addresses (short vs long) on this system?- Returns:
- true if ambiguous addresses are not allowed; false otherwise
-
isLongAddress
-
supportedSpeedModes
Description copied from class:AbstractThrottleManager
What speed modes are supported by this system? value should be xor of possible modes specifed by the DccThrottle interface- Specified by:
supportedSpeedModes
in interfaceThrottleManager
- Overrides:
supportedSpeedModes
in classAbstractThrottleManager
- Returns:
- an XOR of the possible modes specified in the throttle interface
-
disposeThrottle
Description copied from class:AbstractThrottleManager
Not for general use, seereleaseThrottle
anddispatchThrottle
.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 interfaceThrottleManager
- Overrides:
disposeThrottle
in classAbstractThrottleManager
- Parameters:
t
- Throttle being releasedl
- Throttle Listener releasing the throttle- Returns:
- true if the throttle has been disposed of.
-