jmri.jmrix.sprog
Class SprogCSThrottleManager

java.lang.Object
  jmri.jmrix.AbstractThrottleManager
      jmri.jmrix.sprog.SprogCSThrottleManager

All Implemented Interfaces:

ThrottleManager

public class SprogCSThrottleManager
extends AbstractThrottleManager

SPROG Command Station implementation of a ThrottleManager.

Author:

Andrew Crosland Copyright (C) 2006

Nested Class Summary

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

AbstractThrottleManager.Addresses

Constructor Summary

SprogCSThrottleManager()
Constructor.

Method Summary

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.
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

Methods inherited from class jmri.jmrix.AbstractThrottleManager

addressReleased, addressStillRequired, attachListener, cancelThrottleRequest, cancelThrottleRequest, dispatchThrottle, failedThrottleRequest, getThrottleInfo, hasDispatchFunction, notifyThrottleKnown, releaseThrottle, removeListener, requestThrottle, requestThrottle, requestThrottle, requestThrottleSetup, singleUse, supportedSpeedModes

Methods inherited from class java.lang.Object

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

Constructor Detail

SprogCSThrottleManager

public SprogCSThrottleManager()

Constructor.

Method Detail

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

canBeLongAddress

public boolean canBeLongAddress(int address)

Address 100 and above is a long address

canBeShortAddress

public boolean canBeShortAddress(int address)

Address 99 and below is a short address

addressTypeUnique

public boolean addressTypeUnique()

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

disposeThrottle

public boolean disposeThrottle(DccThrottle t,
                               ThrottleListener l)

Description copied from interface: ThrottleManager

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.