Interface Throttle
-
- All Superinterfaces:
PropertyChangeProvider
- All Known Subinterfaces:
DccThrottle
- All Known Implementing Classes:
AbstractThrottle,BiDiBThrottle,CbusThrottle,DCCppThrottle,DebugThrottle,EasyDccThrottle,EcosDccThrottle,EliteXNetThrottle,Ib1Throttle,Ib2Throttle,LocoNetThrottle,MarklinThrottle,MqttThrottle,MrcThrottle,Mx1Throttle,NceThrottle,OlcbThrottle,Pr2Throttle,RocoXNetThrottle,SerialThrottle,SprogCSThrottle,SprogThrottle,SRCPThrottle,TamsThrottle,Throttle,XNetThrottle,XpaThrottle,Z21XNetThrottle
public interface Throttle extends PropertyChangeProvider
A Throttle object can be manipulated to change the speed, direction and functions of a single locomotive.A Throttle implementation provides the actual control mechanism. These are obtained via a
ThrottleManager.With some control systems, there are only a limited number of Throttle's available.
On DCC systems, Throttles are often actually
DccThrottleobjects, which have some additional DCC-specific capabilities.PropertyChangeEvents that can be listened to include- SpeedSetting, SpeedSteps, isForward
- F0, F1, F2 .. F27, F28, F29, F30 ..
- F0Momentary, F1Momentary, F2Momentary .. F28Momentary .. F29Momentary ..
- ThrottleAssigned, throttleRemoved, throttleConnected, throttleNotFoundInRemoval
- DispatchEnabled, ReleaseEnabled
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCONNECTEDConstant sent by Throttle on Connected Property Change.static java.lang.StringDISPATCH_ENABLEDConstant sent by Throttle on Dispatch Enabled Property Change.static java.lang.StringF0Deprecated.UsegetFunctionString(int momentFunctionNum)instead.static java.lang.StringF0MomentaryDeprecated.UsegetFunctionMomentaryString(int momentFunctionNum)instead.static java.lang.StringF1Deprecated.static java.lang.StringF10Deprecated.static java.lang.StringF10MomentaryDeprecated.static java.lang.StringF11Deprecated.static java.lang.StringF11MomentaryDeprecated.static java.lang.StringF12Deprecated.static java.lang.StringF12MomentaryDeprecated.static java.lang.StringF13Deprecated.static java.lang.StringF13MomentaryDeprecated.static java.lang.StringF14Deprecated.static java.lang.StringF14MomentaryDeprecated.static java.lang.StringF15Deprecated.static java.lang.StringF15MomentaryDeprecated.static java.lang.StringF16Deprecated.static java.lang.StringF16MomentaryDeprecated.static java.lang.StringF17Deprecated.static java.lang.StringF17MomentaryDeprecated.static java.lang.StringF18Deprecated.static java.lang.StringF18MomentaryDeprecated.static java.lang.StringF19Deprecated.static java.lang.StringF19MomentaryDeprecated.static java.lang.StringF1MomentaryDeprecated.static java.lang.StringF2Deprecated.static java.lang.StringF20Deprecated.static java.lang.StringF20MomentaryDeprecated.static java.lang.StringF21Deprecated.static java.lang.StringF21MomentaryDeprecated.static java.lang.StringF22Deprecated.static java.lang.StringF22MomentaryDeprecated.static java.lang.StringF23Deprecated.static java.lang.StringF23MomentaryDeprecated.static java.lang.StringF24Deprecated.static java.lang.StringF24MomentaryDeprecated.static java.lang.StringF25Deprecated.static java.lang.StringF25MomentaryDeprecated.static java.lang.StringF26Deprecated.static java.lang.StringF26MomentaryDeprecated.static java.lang.StringF27Deprecated.static java.lang.StringF27MomentaryDeprecated.static java.lang.StringF28Deprecated.static java.lang.StringF28MomentaryDeprecated.static java.lang.StringF2MomentaryDeprecated.static java.lang.StringF3Deprecated.static java.lang.StringF3MomentaryDeprecated.static java.lang.StringF4Deprecated.static java.lang.StringF4MomentaryDeprecated.static java.lang.StringF5Deprecated.static java.lang.StringF5MomentaryDeprecated.static java.lang.StringF6Deprecated.static java.lang.StringF6MomentaryDeprecated.static java.lang.StringF7Deprecated.static java.lang.StringF7MomentaryDeprecated.static java.lang.StringF8Deprecated.static java.lang.StringF8MomentaryDeprecated.static java.lang.StringF9Deprecated.static java.lang.StringF9MomentaryDeprecated.static java.lang.StringISFORWARDConstant sent by Throttle on Direction Property Change.static java.lang.StringRELEASE_ENABLEDConstant sent by Throttle on Release Enabled Property Change.static java.lang.StringSPEEDINCREMENTConstant sent by Throttle on Speed Increment Property Change.static java.lang.StringSPEEDSETTINGConstant sent by Throttle on Speed Setting Property Change.static java.lang.StringSPEEDSTEPMODEConstant used in getThrottleInfo.static java.lang.StringSPEEDSTEPSConstant sent by Throttle on Speed Steps Property Change.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description voiddispatch(ThrottleListener l)Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.voiddispose(ThrottleListener l)Not for general use, seerelease(ThrottleListener l)anddispatch(ThrottleListener l).default booleangetF0()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF0Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF1()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF10()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF10Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF11()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF11Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF12()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF12Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF13()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF13Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF14()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF14Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF15()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF15Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF16()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF16Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF17()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF17Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF18()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF18Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF19()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF19Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF1Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF2()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF20()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF20Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF21()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF21Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF22()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF22Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF23()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF23Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF24()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF24Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF25()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF25Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF26()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF26Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF27()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF27Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF28()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF28Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF2Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF3()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF3Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF4()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF4Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF5()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF5Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF6()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF6Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF7()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF7Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF8()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF8Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.default booleangetF9()Deprecated.UsegetFunction(int functionNum)instead.default booleangetF9Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.booleangetFunction(int functionNum)Get Loco Function status.booleangetFunctionMomentary(int fN)Get the Momentary Function Value.static java.lang.StringgetFunctionMomentaryString(int momentFunctionNum)Get the Momentary Function String for a particular Function number.boolean[]getFunctions()Get copy of function array.boolean[]getFunctionsMomentary()Get copy of function momentary status array.static java.lang.StringgetFunctionString(int functionNum)Get the Function String for a particular Function number.booleangetIsForward()direction This is an bound property.LocoAddressgetLocoAddress()Locomotive address.BasicRosterEntrygetRosterEntry()floatgetSpeedSetting()Get the current speed setting, expressed as a value 0.0 -> 1.0. This property is bound to theSPEEDSETTINGname.voidnotifyThrottleDispatchEnabled(boolean newVal)Notify listeners that a Throttle has Dispatch enabled or disabled.voidnotifyThrottleReleaseEnabled(boolean newVal)Notify listeners that a Throttle has Release enabled or disabled.voidrelease(ThrottleListener l)Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.default voidsetF0(boolean f0)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF0Momentary(boolean f0Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF1(boolean f1)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF10(boolean f10)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF10Momentary(boolean f10Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF11(boolean f11)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF11Momentary(boolean f11Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF12(boolean f12)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF12Momentary(boolean f12Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF13(boolean f13)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF13Momentary(boolean f13Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF14(boolean f14)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF14Momentary(boolean f14Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF15(boolean f15)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF15Momentary(boolean f15Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF16(boolean f16)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF16Momentary(boolean f16Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF17(boolean f17)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF17Momentary(boolean f17Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF18(boolean f18)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF18Momentary(boolean f18Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF19(boolean f19)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF19Momentary(boolean f19Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF1Momentary(boolean f1Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF2(boolean f2)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF20(boolean f20)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF20Momentary(boolean f20Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF21(boolean f21)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF21Momentary(boolean f21Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF22(boolean f22)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF22Momentary(boolean f22Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF23(boolean f23)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF23Momentary(boolean f23Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF24(boolean f24)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF24Momentary(boolean f24Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF25(boolean f25)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF25Momentary(boolean f25Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF26(boolean f26)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF26Momentary(boolean f26Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF27(boolean f27)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF27Momentary(boolean f27Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF28(boolean f28)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF28Momentary(boolean f28Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF2Momentary(boolean f2Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF3(boolean f3)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF3Momentary(boolean f3Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF4(boolean f4)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF4Momentary(boolean f4Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF5(boolean f5)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF5Momentary(boolean f5Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF6(boolean f6)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF6Momentary(boolean f6Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF7(boolean f7)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF7Momentary(boolean f7Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF8(boolean f8)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF8Momentary(boolean f8Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.default voidsetF9(boolean f9)Deprecated.UsesetFunction(int functionNum)instead.default voidsetF9Momentary(boolean f9Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.voidsetFunction(int functionNum, boolean newState)Set Loco Function and send to Layout.voidsetFunctionMomentary(int momFuncNum, boolean state)Set Momentary Loco Function and send to Layout.voidsetIsForward(boolean forward)Set direction.voidsetRosterEntry(BasicRosterEntry re)voidsetSpeedSetting(float speed)Set the desired speed setting, expressed as a value 0.0 -> 1.0. Negative means emergency stop.voidsetSpeedSetting(float speed, boolean allowDuplicates, boolean allowDuplicatesOnStop)Set the desired speed, expressed as a value 0.0 -> 1.0., with extra control over the messages to the layout.voidsetSpeedSettingAgain(float speed)Set the speed, and on systems which normally suppress the sending of a message make sure the message gets sent.-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
-
-
-
Field Detail
-
SPEEDSTEPMODE
static final java.lang.String SPEEDSTEPMODE
Constant used in getThrottleInfo.- See Also:
- Constant Field Values
-
SPEEDSTEPS
static final java.lang.String SPEEDSTEPS
Constant sent by Throttle on Speed Steps Property Change.- See Also:
- Constant Field Values
-
SPEEDSETTING
static final java.lang.String SPEEDSETTING
Constant sent by Throttle on Speed Setting Property Change.- See Also:
- Constant Field Values
-
ISFORWARD
static final java.lang.String ISFORWARD
Constant sent by Throttle on Direction Property Change.- See Also:
- Constant Field Values
-
SPEEDINCREMENT
static final java.lang.String SPEEDINCREMENT
Constant sent by Throttle on Speed Increment Property Change.- See Also:
- Constant Field Values
-
CONNECTED
static final java.lang.String CONNECTED
Constant sent by Throttle on Connected Property Change.- See Also:
- Constant Field Values
-
DISPATCH_ENABLED
static final java.lang.String DISPATCH_ENABLED
Constant sent by Throttle on Dispatch Enabled Property Change.- See Also:
- Constant Field Values
-
RELEASE_ENABLED
static final java.lang.String RELEASE_ENABLED
Constant sent by Throttle on Release Enabled Property Change.- See Also:
- Constant Field Values
-
F0
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F0Deprecated.UsegetFunctionString(int momentFunctionNum)instead.Constants to represent the functions F0 through F28.- See Also:
- Constant Field Values
-
F1
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F1Deprecated.- See Also:
- Constant Field Values
-
F2
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F2Deprecated.- See Also:
- Constant Field Values
-
F3
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F3Deprecated.- See Also:
- Constant Field Values
-
F4
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F4Deprecated.- See Also:
- Constant Field Values
-
F5
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F5Deprecated.- See Also:
- Constant Field Values
-
F6
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F6Deprecated.- See Also:
- Constant Field Values
-
F7
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F7Deprecated.- See Also:
- Constant Field Values
-
F8
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F8Deprecated.- See Also:
- Constant Field Values
-
F9
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F9Deprecated.- See Also:
- Constant Field Values
-
F10
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F10Deprecated.- See Also:
- Constant Field Values
-
F11
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F11Deprecated.- See Also:
- Constant Field Values
-
F12
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F12Deprecated.- See Also:
- Constant Field Values
-
F13
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F13Deprecated.- See Also:
- Constant Field Values
-
F14
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F14Deprecated.- See Also:
- Constant Field Values
-
F15
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F15Deprecated.- See Also:
- Constant Field Values
-
F16
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F16Deprecated.- See Also:
- Constant Field Values
-
F17
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F17Deprecated.- See Also:
- Constant Field Values
-
F18
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F18Deprecated.- See Also:
- Constant Field Values
-
F19
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F19Deprecated.- See Also:
- Constant Field Values
-
F20
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F20Deprecated.- See Also:
- Constant Field Values
-
F21
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F21Deprecated.- See Also:
- Constant Field Values
-
F22
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F22Deprecated.- See Also:
- Constant Field Values
-
F23
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F23Deprecated.- See Also:
- Constant Field Values
-
F24
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F24Deprecated.- See Also:
- Constant Field Values
-
F25
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F25Deprecated.- See Also:
- Constant Field Values
-
F26
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F26Deprecated.- See Also:
- Constant Field Values
-
F27
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F27Deprecated.- See Also:
- Constant Field Values
-
F28
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F28Deprecated.- See Also:
- Constant Field Values
-
F0Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F0MomentaryDeprecated.UsegetFunctionMomentaryString(int momentFunctionNum)instead.Constants to represent the functions F0 through F28.- See Also:
- Constant Field Values
-
F1Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F1MomentaryDeprecated.- See Also:
- Constant Field Values
-
F2Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F2MomentaryDeprecated.- See Also:
- Constant Field Values
-
F3Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F3MomentaryDeprecated.- See Also:
- Constant Field Values
-
F4Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F4MomentaryDeprecated.- See Also:
- Constant Field Values
-
F5Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F5MomentaryDeprecated.- See Also:
- Constant Field Values
-
F6Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F6MomentaryDeprecated.- See Also:
- Constant Field Values
-
F7Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F7MomentaryDeprecated.- See Also:
- Constant Field Values
-
F8Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F8MomentaryDeprecated.- See Also:
- Constant Field Values
-
F9Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F9MomentaryDeprecated.- See Also:
- Constant Field Values
-
F10Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F10MomentaryDeprecated.- See Also:
- Constant Field Values
-
F11Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F11MomentaryDeprecated.- See Also:
- Constant Field Values
-
F12Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F12MomentaryDeprecated.- See Also:
- Constant Field Values
-
F13Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F13MomentaryDeprecated.- See Also:
- Constant Field Values
-
F14Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F14MomentaryDeprecated.- See Also:
- Constant Field Values
-
F15Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F15MomentaryDeprecated.- See Also:
- Constant Field Values
-
F16Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F16MomentaryDeprecated.- See Also:
- Constant Field Values
-
F17Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F17MomentaryDeprecated.- See Also:
- Constant Field Values
-
F18Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F18MomentaryDeprecated.- See Also:
- Constant Field Values
-
F19Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F19MomentaryDeprecated.- See Also:
- Constant Field Values
-
F20Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F20MomentaryDeprecated.- See Also:
- Constant Field Values
-
F21Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F21MomentaryDeprecated.- See Also:
- Constant Field Values
-
F22Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F22MomentaryDeprecated.- See Also:
- Constant Field Values
-
F23Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F23MomentaryDeprecated.- See Also:
- Constant Field Values
-
F24Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F24MomentaryDeprecated.- See Also:
- Constant Field Values
-
F25Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F25MomentaryDeprecated.- See Also:
- Constant Field Values
-
F26Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F26MomentaryDeprecated.- See Also:
- Constant Field Values
-
F27Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F27MomentaryDeprecated.- See Also:
- Constant Field Values
-
F28Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F28MomentaryDeprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getFunctionString
static java.lang.String getFunctionString(int functionNum)
Get the Function String for a particular Function number. Commonly used string in Throttle property change listeners.- Parameters:
functionNum- Function Number, minimum 0.- Returns:
- function string, e.g. "F0" or "F7".
-
getFunctionMomentaryString
static java.lang.String getFunctionMomentaryString(int momentFunctionNum)
Get the Momentary Function String for a particular Function number. Commonly used string in Throttle property change listeners.- Parameters:
momentFunctionNum- Momentary Function Number, minimum 0.- Returns:
- momentary function string, e.g. "F0Momentary" or "F7Momentary".
-
getFunctions
@Nonnull boolean[] getFunctions()
Get copy of function array. Typically returns array length of 29, i.e. 0-28.- Returns:
- function array, length dependant by hardware type.
-
getFunctionsMomentary
@Nonnull boolean[] getFunctionsMomentary()
Get copy of function momentary status array. Typically returns array length of 29, i.e. 0-28.- Returns:
- momentary function array, length dependant by hardware type.
-
getSpeedSetting
float getSpeedSetting()
Get the current speed setting, expressed as a value 0.0 -> 1.0. This property is bound to theSPEEDSETTINGname.- Returns:
- the speed as a 0.0 -> 1.0. fraction of maximum possible speed or -1 for emergency stop.
-
setSpeedSetting
void setSpeedSetting(float speed)
Set the desired speed setting, expressed as a value 0.0 -> 1.0. Negative means emergency stop. This property is bound to theSPEEDSETTINGname.- Parameters:
speed- the speed as a 0.0 -> 1.0. fraction of maximum possible speed or -1 for emergency stop.
-
setSpeedSetting
void setSpeedSetting(float speed, boolean allowDuplicates, boolean allowDuplicatesOnStop)
Set the desired speed, expressed as a value 0.0 -> 1.0., with extra control over the messages to the layout. Negative means emergency stop. On systems which normally suppress the sending of a message if the new speed won't (appear to JMRI to) make any difference, the two extra options allow the calling method to insist the message is sent under some circumstances.- Parameters:
speed- the speed as a 0.0 -> 1.0. fraction of maximum possible speed or -1 for emergency stop.allowDuplicates- if true, don't suppress messages that should have no effectallowDuplicatesOnStop- if true, and the new speed is idle or estop, don't suppress messages
-
setSpeedSettingAgain
void setSpeedSettingAgain(float speed)
Set the speed, and on systems which normally suppress the sending of a message make sure the message gets sent.- Parameters:
speed- the speed as a 0.0 -> 1.0. fraction of maximum possible speed or -1 for emergency stop.
-
getIsForward
boolean getIsForward()
direction This is an bound property.- Returns:
- true if forward, false if reverse or undefined
-
setIsForward
void setIsForward(boolean forward)
Set direction.- Parameters:
forward- true if forward, false if reverse or undefined
-
setFunction
void setFunction(int functionNum, boolean newState)
Set Loco Function and send to Layout.- Parameters:
functionNum- Function Number, 0-28newState- New Function State. True on, false off.
-
getFunction
boolean getFunction(int functionNum)
Get Loco Function status.- Parameters:
functionNum- Function Number, 0-28- Returns:
- Function State. True on, false off.
-
setFunctionMomentary
void setFunctionMomentary(int momFuncNum, boolean state)
Set Momentary Loco Function and send to Layout.- Parameters:
momFuncNum- Momentary Function Number, 0-28state- New Function State. True on, false off.
-
getFunctionMomentary
boolean getFunctionMomentary(int fN)
Get the Momentary Function Value.- Parameters:
fN- Momentary function number- Returns:
- true if momentary function is on, else false.
-
getF0
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF0()Deprecated.UsegetFunction(int functionNum)instead.Get Function 0 Status.- Returns:
- true for Function On, false for Function Off.
-
getF1
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF1()Deprecated.UsegetFunction(int functionNum)instead.Get Function 1 Status.- Returns:
- true for Function On, false for Function Off.
-
getF2
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF2()Deprecated.UsegetFunction(int functionNum)instead.Get Function 2 Status.- Returns:
- true for Function On, false for Function Off.
-
getF3
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF3()Deprecated.UsegetFunction(int functionNum)instead.Get Function 3 Status.- Returns:
- true for Function On, false for Function Off.
-
getF4
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF4()Deprecated.UsegetFunction(int functionNum)instead.Get Function 4 Status.- Returns:
- true for Function On, false for Function Off.
-
getF5
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF5()Deprecated.UsegetFunction(int functionNum)instead.Get Function 5 Status.- Returns:
- true for Function On, false for Function Off.
-
getF6
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF6()Deprecated.UsegetFunction(int functionNum)instead.Get Function 6 Status.- Returns:
- true for Function On, false for Function Off.
-
getF7
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF7()Deprecated.UsegetFunction(int functionNum)instead.Get Function 7 Status.- Returns:
- true for Function On, false for Function Off.
-
getF8
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF8()Deprecated.UsegetFunction(int functionNum)instead.Get Function 8 Status.- Returns:
- true for Function On, false for Function Off.
-
getF9
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF9()Deprecated.UsegetFunction(int functionNum)instead.Get Function 9 Status.- Returns:
- true for Function On, false for Function Off.
-
getF10
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF10()Deprecated.UsegetFunction(int functionNum)instead.Get Function 10 Status.- Returns:
- true for Function On, false for Function Off.
-
getF11
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF11()Deprecated.UsegetFunction(int functionNum)instead.Get Function 11 Status.- Returns:
- true for Function On, false for Function Off.
-
getF12
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF12()Deprecated.UsegetFunction(int functionNum)instead.Get Function 12 Status.- Returns:
- true for Function On, false for Function Off.
-
getF13
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF13()Deprecated.UsegetFunction(int functionNum)instead.Get Function 13 Status.- Returns:
- true for Function On, false for Function Off.
-
getF14
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF14()Deprecated.UsegetFunction(int functionNum)instead.Get Function 14 Status.- Returns:
- true for Function On, false for Function Off.
-
getF15
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF15()Deprecated.UsegetFunction(int functionNum)instead.Get Function 15 Status.- Returns:
- true for Function On, false for Function Off.
-
getF16
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF16()Deprecated.UsegetFunction(int functionNum)instead.Get Function 16 Status.- Returns:
- true for Function On, false for Function Off.
-
getF17
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF17()Deprecated.UsegetFunction(int functionNum)instead.Get Function 17 Status.- Returns:
- true for Function On, false for Function Off.
-
getF18
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF18()Deprecated.UsegetFunction(int functionNum)instead.Get Function 18 Status.- Returns:
- true for Function On, false for Function Off.
-
getF19
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF19()Deprecated.UsegetFunction(int functionNum)instead.Get Function 19 Status.- Returns:
- true for Function On, false for Function Off.
-
getF20
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF20()Deprecated.UsegetFunction(int functionNum)instead.Get Function 20 Status.- Returns:
- true for Function On, false for Function Off.
-
getF21
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF21()Deprecated.UsegetFunction(int functionNum)instead.Get Function 21 Status.- Returns:
- true for Function On, false for Function Off.
-
getF22
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF22()Deprecated.UsegetFunction(int functionNum)instead.Get Function 22 Status.- Returns:
- true for Function On, false for Function Off.
-
getF23
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF23()Deprecated.UsegetFunction(int functionNum)instead.Get Function 23 Status.- Returns:
- true for Function On, false for Function Off.
-
getF24
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF24()Deprecated.UsegetFunction(int functionNum)instead.Get Function 24 Status.- Returns:
- true for Function On, false for Function Off.
-
getF25
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF25()Deprecated.UsegetFunction(int functionNum)instead.Get Function 25 Status.- Returns:
- true for Function On, false for Function Off.
-
getF26
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF26()Deprecated.UsegetFunction(int functionNum)instead.Get Function 26 Status.- Returns:
- true for Function On, false for Function Off.
-
getF27
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF27()Deprecated.UsegetFunction(int functionNum)instead.Get Function 27 Status.- Returns:
- true for Function On, false for Function Off.
-
getF28
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF28()Deprecated.UsegetFunction(int functionNum)instead.Get Function 28 Status.- Returns:
- true for Function On, false for Function Off.
-
setF0
@Deprecated(since="5.1.2", forRemoval=false) default void setF0(boolean f0)Deprecated.UsesetFunction(int functionNum)instead.Set Function 0 Status.- Parameters:
f0- true for Function On, false for Function Off.
-
setF1
@Deprecated(since="5.1.2", forRemoval=false) default void setF1(boolean f1)Deprecated.UsesetFunction(int functionNum)instead.Set Function 1 Status.- Parameters:
f1- true for Function On, false for Function Off.
-
setF2
@Deprecated(since="5.1.2", forRemoval=false) default void setF2(boolean f2)Deprecated.UsesetFunction(int functionNum)instead.Set Function 2 Status.- Parameters:
f2- true for Function On, false for Function Off.
-
setF3
@Deprecated(since="5.1.2", forRemoval=false) default void setF3(boolean f3)Deprecated.UsesetFunction(int functionNum)instead.Set Function 3 Status.- Parameters:
f3- true for Function On, false for Function Off.
-
setF4
@Deprecated(since="5.1.2", forRemoval=false) default void setF4(boolean f4)Deprecated.UsesetFunction(int functionNum)instead.Set Function 4 Status.- Parameters:
f4- true for Function On, false for Function Off.
-
setF5
@Deprecated(since="5.1.2", forRemoval=false) default void setF5(boolean f5)Deprecated.UsesetFunction(int functionNum)instead.Set Function 5 Status.- Parameters:
f5- true for Function On, false for Function Off.
-
setF6
@Deprecated(since="5.1.2", forRemoval=false) default void setF6(boolean f6)Deprecated.UsesetFunction(int functionNum)instead.Set Function 6 Status.- Parameters:
f6- true for Function On, false for Function Off.
-
setF7
@Deprecated(since="5.1.2", forRemoval=false) default void setF7(boolean f7)Deprecated.UsesetFunction(int functionNum)instead.Set Function 7 Status.- Parameters:
f7- true for Function On, false for Function Off.
-
setF8
@Deprecated(since="5.1.2", forRemoval=false) default void setF8(boolean f8)Deprecated.UsesetFunction(int functionNum)instead.Set Function 8 Status.- Parameters:
f8- true for Function On, false for Function Off.
-
setF9
@Deprecated(since="5.1.2", forRemoval=false) default void setF9(boolean f9)Deprecated.UsesetFunction(int functionNum)instead.Set Function 9 Status.- Parameters:
f9- true for Function On, false for Function Off.
-
setF10
@Deprecated(since="5.1.2", forRemoval=false) default void setF10(boolean f10)Deprecated.UsesetFunction(int functionNum)instead.Set Function 10 Status.- Parameters:
f10- true for Function On, false for Function Off.
-
setF11
@Deprecated(since="5.1.2", forRemoval=false) default void setF11(boolean f11)Deprecated.UsesetFunction(int functionNum)instead.Set Function 11 Status.- Parameters:
f11- true for Function On, false for Function Off.
-
setF12
@Deprecated(since="5.1.2", forRemoval=false) default void setF12(boolean f12)Deprecated.UsesetFunction(int functionNum)instead.Set Function 12 Status.- Parameters:
f12- true for Function On, false for Function Off.
-
setF13
@Deprecated(since="5.1.2", forRemoval=false) default void setF13(boolean f13)Deprecated.UsesetFunction(int functionNum)instead.Set Function 13 Status.- Parameters:
f13- true for Function On, false for Function Off.
-
setF14
@Deprecated(since="5.1.2", forRemoval=false) default void setF14(boolean f14)Deprecated.UsesetFunction(int functionNum)instead.Set Function 14 Status.- Parameters:
f14- true for Function On, false for Function Off.
-
setF15
@Deprecated(since="5.1.2", forRemoval=false) default void setF15(boolean f15)Deprecated.UsesetFunction(int functionNum)instead.Set Function 15 Status.- Parameters:
f15- true for Function On, false for Function Off.
-
setF16
@Deprecated(since="5.1.2", forRemoval=false) default void setF16(boolean f16)Deprecated.UsesetFunction(int functionNum)instead.Set Function 16 Status.- Parameters:
f16- true for Function On, false for Function Off.
-
setF17
@Deprecated(since="5.1.2", forRemoval=false) default void setF17(boolean f17)Deprecated.UsesetFunction(int functionNum)instead.Set Function 17 Status.- Parameters:
f17- true for Function On, false for Function Off.
-
setF18
@Deprecated(since="5.1.2", forRemoval=false) default void setF18(boolean f18)Deprecated.UsesetFunction(int functionNum)instead.Set Function 18 Status.- Parameters:
f18- true for Function On, false for Function Off.
-
setF19
@Deprecated(since="5.1.2", forRemoval=false) default void setF19(boolean f19)Deprecated.UsesetFunction(int functionNum)instead.Set Function 19 Status.- Parameters:
f19- true for Function On, false for Function Off.
-
setF20
@Deprecated(since="5.1.2", forRemoval=false) default void setF20(boolean f20)Deprecated.UsesetFunction(int functionNum)instead.Set Function 20 Status.- Parameters:
f20- true for Function On, false for Function Off.
-
setF21
@Deprecated(since="5.1.2", forRemoval=false) default void setF21(boolean f21)Deprecated.UsesetFunction(int functionNum)instead.Set Function 21 Status.- Parameters:
f21- true for Function On, false for Function Off.
-
setF22
@Deprecated(since="5.1.2", forRemoval=false) default void setF22(boolean f22)Deprecated.UsesetFunction(int functionNum)instead.Set Function 22 Status.- Parameters:
f22- true for Function On, false for Function Off.
-
setF23
@Deprecated(since="5.1.2", forRemoval=false) default void setF23(boolean f23)Deprecated.UsesetFunction(int functionNum)instead.Set Function 23 Status.- Parameters:
f23- true for Function On, false for Function Off.
-
setF24
@Deprecated(since="5.1.2", forRemoval=false) default void setF24(boolean f24)Deprecated.UsesetFunction(int functionNum)instead.Set Function 24 Status.- Parameters:
f24- true for Function On, false for Function Off.
-
setF25
@Deprecated(since="5.1.2", forRemoval=false) default void setF25(boolean f25)Deprecated.UsesetFunction(int functionNum)instead.Set Function 25 Status.- Parameters:
f25- true for Function On, false for Function Off.
-
setF26
@Deprecated(since="5.1.2", forRemoval=false) default void setF26(boolean f26)Deprecated.UsesetFunction(int functionNum)instead.Set Function 26 Status.- Parameters:
f26- true for Function On, false for Function Off.
-
setF27
@Deprecated(since="5.1.2", forRemoval=false) default void setF27(boolean f27)Deprecated.UsesetFunction(int functionNum)instead.Set Function 27 Status.- Parameters:
f27- true for Function On, false for Function Off.
-
setF28
@Deprecated(since="5.1.2", forRemoval=false) default void setF28(boolean f28)Deprecated.UsesetFunction(int functionNum)instead.Set Function 28 Status.- Parameters:
f28- true for Function On, false for Function Off.
-
getF0Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF0Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 0 Status.- Returns:
- true for Momentary Function On, else false.
-
getF1Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF1Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 1 Status.- Returns:
- true for Momentary Function On, else false.
-
getF2Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF2Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 2 Status.- Returns:
- true for Momentary Function On, else false.
-
getF3Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF3Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 3 Status.- Returns:
- true for Momentary Function On, else false.
-
getF4Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF4Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 4 Status.- Returns:
- true for Momentary Function On, else false.
-
getF5Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF5Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 5 Status.- Returns:
- true for Momentary Function On, else false.
-
getF6Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF6Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 6 Status.- Returns:
- true for Momentary Function On, else false.
-
getF7Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF7Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 7 Status.- Returns:
- true for Momentary Function On, else false.
-
getF8Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF8Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 8 Status.- Returns:
- true for Momentary Function On, else false.
-
getF9Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF9Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 9 Status.- Returns:
- true for Momentary Function On, else false.
-
getF10Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF10Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 10 Status.- Returns:
- true for Momentary Function On, else false.
-
getF11Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF11Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 11 Status.- Returns:
- true for Momentary Function On, else false.
-
getF12Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF12Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 12 Status.- Returns:
- true for Momentary Function On, else false.
-
getF13Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF13Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 13 Status.- Returns:
- true for Momentary Function On, else false.
-
getF14Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF14Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 14 Status.- Returns:
- true for Momentary Function On, else false.
-
getF15Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF15Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 15 Status.- Returns:
- true for Momentary Function On, else false.
-
getF16Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF16Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 16 Status.- Returns:
- true for Momentary Function On, else false.
-
getF17Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF17Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 17 Status.- Returns:
- true for Momentary Function On, else false.
-
getF18Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF18Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 18 Status.- Returns:
- true for Momentary Function On, else false.
-
getF19Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF19Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 19 Status.- Returns:
- true for Momentary Function On, else false.
-
getF20Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF20Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 20 Status.- Returns:
- true for Momentary Function On, else false.
-
getF21Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF21Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 21 Status.- Returns:
- true for Momentary Function On, else false.
-
getF22Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF22Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 22 Status.- Returns:
- true for Momentary Function On, else false.
-
getF23Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF23Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 23 Status.- Returns:
- true for Momentary Function On, else false.
-
getF24Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF24Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 24 Status.- Returns:
- true for Momentary Function On, else false.
-
getF25Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF25Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 25 Status.- Returns:
- true for Momentary Function On, else false.
-
getF26Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF26Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 26 Status.- Returns:
- true for Momentary Function On, else false.
-
getF27Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF27Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 27 Status.- Returns:
- true for Momentary Function On, else false.
-
getF28Momentary
@Deprecated(since="5.1.2", forRemoval=false) default boolean getF28Momentary()Deprecated.UsegetFunctionMomentary(int functionNum)instead.Get Momentary Function 28 Status.- Returns:
- true for Momentary Function On, else false.
-
setF0Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF0Momentary(boolean f0Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 0 Status.- Parameters:
f0Momentary- true for Momentary Function On, else false.
-
setF1Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF1Momentary(boolean f1Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 1 Status.- Parameters:
f1Momentary- true for Momentary Function On, else false.
-
setF2Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF2Momentary(boolean f2Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 2 Status.- Parameters:
f2Momentary- true for Momentary Function On, else false.
-
setF3Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF3Momentary(boolean f3Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 3 Status.- Parameters:
f3Momentary- true for Momentary Function On, else false.
-
setF4Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF4Momentary(boolean f4Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 4 Status.- Parameters:
f4Momentary- true for Momentary Function On, else false.
-
setF5Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF5Momentary(boolean f5Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 5 Status.- Parameters:
f5Momentary- true for Momentary Function On, else false.
-
setF6Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF6Momentary(boolean f6Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 6 Status.- Parameters:
f6Momentary- true for Momentary Function On, else false.
-
setF7Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF7Momentary(boolean f7Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 7 Status.- Parameters:
f7Momentary- true for Momentary Function On, else false.
-
setF8Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF8Momentary(boolean f8Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 8 Status.- Parameters:
f8Momentary- true for Momentary Function On, else false.
-
setF9Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF9Momentary(boolean f9Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 9 Status.- Parameters:
f9Momentary- true for Momentary Function On, else false.
-
setF10Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF10Momentary(boolean f10Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 10 Status.- Parameters:
f10Momentary- true for Momentary Function On, else false.
-
setF11Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF11Momentary(boolean f11Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 11 Status.- Parameters:
f11Momentary- true for Momentary Function On, else false.
-
setF12Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF12Momentary(boolean f12Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 12 Status.- Parameters:
f12Momentary- true for Momentary Function On, else false.
-
setF13Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF13Momentary(boolean f13Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 13 Status.- Parameters:
f13Momentary- true for Momentary Function On, else false.
-
setF14Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF14Momentary(boolean f14Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 14 Status.- Parameters:
f14Momentary- true for Momentary Function On, else false.
-
setF15Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF15Momentary(boolean f15Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 15 Status.- Parameters:
f15Momentary- true for Momentary Function On, else false.
-
setF16Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF16Momentary(boolean f16Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 16 Status.- Parameters:
f16Momentary- true for Momentary Function On, else false.
-
setF17Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF17Momentary(boolean f17Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 17 Status.- Parameters:
f17Momentary- true for Momentary Function On, else false.
-
setF18Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF18Momentary(boolean f18Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 18 Status.- Parameters:
f18Momentary- true for Momentary Function On, else false.
-
setF19Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF19Momentary(boolean f19Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 19 Status.- Parameters:
f19Momentary- true for Momentary Function On, else false.
-
setF20Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF20Momentary(boolean f20Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 20 Status.- Parameters:
f20Momentary- true for Momentary Function On, else false.
-
setF21Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF21Momentary(boolean f21Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 21 Status.- Parameters:
f21Momentary- true for Momentary Function On, else false.
-
setF22Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF22Momentary(boolean f22Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 22 Status.- Parameters:
f22Momentary- true for Momentary Function On, else false.
-
setF23Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF23Momentary(boolean f23Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 23 Status.- Parameters:
f23Momentary- true for Momentary Function On, else false.
-
setF24Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF24Momentary(boolean f24Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 24 Status.- Parameters:
f24Momentary- true for Momentary Function On, else false.
-
setF25Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF25Momentary(boolean f25Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 25 Status.- Parameters:
f25Momentary- true for Momentary Function On, else false.
-
setF26Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF26Momentary(boolean f26Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 26 Status.- Parameters:
f26Momentary- true for Momentary Function On, else false.
-
setF27Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF27Momentary(boolean f27Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 27 Status.- Parameters:
f27Momentary- true for Momentary Function On, else false.
-
setF28Momentary
@Deprecated(since="5.1.2", forRemoval=false) default void setF28Momentary(boolean f28Momentary)Deprecated.UsesetFunctionMomentary(int functionNum)instead.Set Momentary Function 28 Status.- Parameters:
f28Momentary- true for Momentary Function On, else false.
-
getLocoAddress
LocoAddress getLocoAddress()
Locomotive address. The exact format is defined by the specific implementation, as subclasses of LocoAddress will contain different information.This is an unbound property.
- Returns:
- The locomotive address
-
dispose
void dispose(ThrottleListener l)
Not for general use, seerelease(ThrottleListener l)anddispatch(ThrottleListener l).Dispose of object when finished it. This does not free any hardware resources used; rather, it just cleans up the software implementation.
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.
- Parameters:
l-ThrottleListenerto dispose of
-
release
void release(ThrottleListener l)
Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.After this, further usage of this Throttle object will result in a JmriException. Do not call dispose after release.
Normally, release ends with a call to dispose.
- Parameters:
l-ThrottleListenerto release. May be null if noThrottleListeneris currently held.
-
dispatch
void dispatch(ThrottleListener l)
Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else. If possible, tell the layout that this locomotive has been dispatched to another user. Not all layouts will implement this, in which case it is synonymous withrelease(jmri.ThrottleListener).After this, further usage of this Throttle object will result in a JmriException.
Normally, dispatch ends with a call to dispose.
- Parameters:
l-ThrottleListenerto dispatch
-
setRosterEntry
void setRosterEntry(BasicRosterEntry re)
-
getRosterEntry
BasicRosterEntry getRosterEntry()
-
notifyThrottleReleaseEnabled
void notifyThrottleReleaseEnabled(boolean newVal)
Notify listeners that a Throttle has Release enabled or disabled.For systems where release availability is variable.
- Parameters:
newVal- true if Release enabled, else false
-
notifyThrottleDispatchEnabled
void notifyThrottleDispatchEnabled(boolean newVal)
Notify listeners that a Throttle has Dispatch enabled or disabled.For systems where dispatch availability is variable.
- Parameters:
newVal- true if Dispatch enabled, else false
-
-