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
DccThrottle
objects, which have some additional DCC-specific capabilities.PropertyChangeEvent
s 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.String
F0
Deprecated.UsegetFunctionString(int momentFunctionNum)
instead.static java.lang.String
F0Momentary
Deprecated.UsegetFunctionMomentaryString(int momentFunctionNum)
instead.static java.lang.String
F1
Deprecated.static java.lang.String
F10
Deprecated.static java.lang.String
F10Momentary
Deprecated.static java.lang.String
F11
Deprecated.static java.lang.String
F11Momentary
Deprecated.static java.lang.String
F12
Deprecated.static java.lang.String
F12Momentary
Deprecated.static java.lang.String
F13
Deprecated.static java.lang.String
F13Momentary
Deprecated.static java.lang.String
F14
Deprecated.static java.lang.String
F14Momentary
Deprecated.static java.lang.String
F15
Deprecated.static java.lang.String
F15Momentary
Deprecated.static java.lang.String
F16
Deprecated.static java.lang.String
F16Momentary
Deprecated.static java.lang.String
F17
Deprecated.static java.lang.String
F17Momentary
Deprecated.static java.lang.String
F18
Deprecated.static java.lang.String
F18Momentary
Deprecated.static java.lang.String
F19
Deprecated.static java.lang.String
F19Momentary
Deprecated.static java.lang.String
F1Momentary
Deprecated.static java.lang.String
F2
Deprecated.static java.lang.String
F20
Deprecated.static java.lang.String
F20Momentary
Deprecated.static java.lang.String
F21
Deprecated.static java.lang.String
F21Momentary
Deprecated.static java.lang.String
F22
Deprecated.static java.lang.String
F22Momentary
Deprecated.static java.lang.String
F23
Deprecated.static java.lang.String
F23Momentary
Deprecated.static java.lang.String
F24
Deprecated.static java.lang.String
F24Momentary
Deprecated.static java.lang.String
F25
Deprecated.static java.lang.String
F25Momentary
Deprecated.static java.lang.String
F26
Deprecated.static java.lang.String
F26Momentary
Deprecated.static java.lang.String
F27
Deprecated.static java.lang.String
F27Momentary
Deprecated.static java.lang.String
F28
Deprecated.static java.lang.String
F28Momentary
Deprecated.static java.lang.String
F2Momentary
Deprecated.static java.lang.String
F3
Deprecated.static java.lang.String
F3Momentary
Deprecated.static java.lang.String
F4
Deprecated.static java.lang.String
F4Momentary
Deprecated.static java.lang.String
F5
Deprecated.static java.lang.String
F5Momentary
Deprecated.static java.lang.String
F6
Deprecated.static java.lang.String
F6Momentary
Deprecated.static java.lang.String
F7
Deprecated.static java.lang.String
F7Momentary
Deprecated.static java.lang.String
F8
Deprecated.static java.lang.String
F8Momentary
Deprecated.static java.lang.String
F9
Deprecated.static java.lang.String
F9Momentary
Deprecated.static java.lang.String
ISFORWARD
static java.lang.String
SPEEDINCREMENT
static java.lang.String
SPEEDSETTING
static java.lang.String
SPEEDSTEPMODE
Constant used in getThrottleInfo.static java.lang.String
SPEEDSTEPS
Constant sent by Throttle on Property Change.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description void
dispatch(ThrottleListener l)
Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.void
dispose(ThrottleListener l)
Not for general use, seerelease(ThrottleListener l)
anddispatch(ThrottleListener l)
.default boolean
getF0()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF0Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF1()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF10()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF10Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF11()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF11Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF12()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF12Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF13()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF13Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF14()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF14Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF15()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF15Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF16()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF16Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF17()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF17Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF18()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF18Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF19()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF19Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF1Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF2()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF20()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF20Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF21()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF21Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF22()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF22Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF23()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF23Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF24()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF24Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF25()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF25Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF26()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF26Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF27()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF27Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF28()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF28Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF2Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF3()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF3Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF4()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF4Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF5()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF5Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF6()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF6Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF7()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF7Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF8()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF8Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.default boolean
getF9()
Deprecated.UsegetFunction(int functionNum)
instead.default boolean
getF9Momentary()
Deprecated.UsegetFunctionMomentary(int functionNum)
instead.boolean
getFunction(int functionNum)
Get Loco Function status.boolean
getFunctionMomentary(int fN)
Get the Momentary Function Value.static java.lang.String
getFunctionMomentaryString(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.String
getFunctionString(int functionNum)
Get the Function String for a particular Function number.boolean
getIsForward()
direction This is an bound property.LocoAddress
getLocoAddress()
Locomotive address.BasicRosterEntry
getRosterEntry()
float
getSpeedSetting()
Get the current speed setting, expressed as a value 0.0 -> 1.0. This property is bound to theSPEEDSETTING
name.void
notifyThrottleDispatchEnabled(boolean newVal)
Notify listeners that a Throttle has Dispatch enabled or disabled.void
notifyThrottleReleaseEnabled(boolean newVal)
Notify listeners that a Throttle has Release enabled or disabled.void
release(ThrottleListener l)
Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.default void
setF0(boolean f0)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF0Momentary(boolean f0Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF1(boolean f1)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF10(boolean f10)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF10Momentary(boolean f10Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF11(boolean f11)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF11Momentary(boolean f11Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF12(boolean f12)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF12Momentary(boolean f12Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF13(boolean f13)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF13Momentary(boolean f13Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF14(boolean f14)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF14Momentary(boolean f14Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF15(boolean f15)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF15Momentary(boolean f15Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF16(boolean f16)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF16Momentary(boolean f16Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF17(boolean f17)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF17Momentary(boolean f17Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF18(boolean f18)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF18Momentary(boolean f18Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF19(boolean f19)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF19Momentary(boolean f19Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF1Momentary(boolean f1Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF2(boolean f2)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF20(boolean f20)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF20Momentary(boolean f20Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF21(boolean f21)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF21Momentary(boolean f21Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF22(boolean f22)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF22Momentary(boolean f22Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF23(boolean f23)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF23Momentary(boolean f23Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF24(boolean f24)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF24Momentary(boolean f24Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF25(boolean f25)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF25Momentary(boolean f25Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF26(boolean f26)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF26Momentary(boolean f26Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF27(boolean f27)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF27Momentary(boolean f27Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF28(boolean f28)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF28Momentary(boolean f28Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF2Momentary(boolean f2Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF3(boolean f3)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF3Momentary(boolean f3Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF4(boolean f4)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF4Momentary(boolean f4Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF5(boolean f5)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF5Momentary(boolean f5Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF6(boolean f6)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF6Momentary(boolean f6Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF7(boolean f7)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF7Momentary(boolean f7Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF8(boolean f8)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF8Momentary(boolean f8Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.default void
setF9(boolean f9)
Deprecated.UsesetFunction(int functionNum)
instead.default void
setF9Momentary(boolean f9Momentary)
Deprecated.UsesetFunctionMomentary(int functionNum)
instead.void
setFunction(int functionNum, boolean newState)
Set Loco Function and send to Layout.void
setFunctionMomentary(int momFuncNum, boolean state)
Set Momentary Loco Function and send to Layout.void
setIsForward(boolean forward)
Set direction.void
setRosterEntry(BasicRosterEntry re)
void
setSpeedSetting(float speed)
Set the desired speed setting, expressed as a value 0.0 -> 1.0. Negative means emergency stop.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.void
setSpeedSettingAgain(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 Property Change.- See Also:
- Constant Field Values
-
SPEEDSETTING
static final java.lang.String SPEEDSETTING
- See Also:
- Constant Field Values
-
ISFORWARD
static final java.lang.String ISFORWARD
- See Also:
- Constant Field Values
-
SPEEDINCREMENT
static final java.lang.String SPEEDINCREMENT
- See Also:
- Constant Field Values
-
F0
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F0
Deprecated.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 F1
Deprecated.- See Also:
- Constant Field Values
-
F2
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F2
Deprecated.- See Also:
- Constant Field Values
-
F3
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F3
Deprecated.- See Also:
- Constant Field Values
-
F4
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F4
Deprecated.- See Also:
- Constant Field Values
-
F5
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F5
Deprecated.- See Also:
- Constant Field Values
-
F6
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F6
Deprecated.- See Also:
- Constant Field Values
-
F7
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F7
Deprecated.- See Also:
- Constant Field Values
-
F8
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F8
Deprecated.- See Also:
- Constant Field Values
-
F9
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F9
Deprecated.- See Also:
- Constant Field Values
-
F10
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F10
Deprecated.- See Also:
- Constant Field Values
-
F11
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F11
Deprecated.- See Also:
- Constant Field Values
-
F12
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F12
Deprecated.- See Also:
- Constant Field Values
-
F13
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F13
Deprecated.- See Also:
- Constant Field Values
-
F14
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F14
Deprecated.- See Also:
- Constant Field Values
-
F15
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F15
Deprecated.- See Also:
- Constant Field Values
-
F16
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F16
Deprecated.- See Also:
- Constant Field Values
-
F17
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F17
Deprecated.- See Also:
- Constant Field Values
-
F18
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F18
Deprecated.- See Also:
- Constant Field Values
-
F19
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F19
Deprecated.- See Also:
- Constant Field Values
-
F20
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F20
Deprecated.- See Also:
- Constant Field Values
-
F21
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F21
Deprecated.- See Also:
- Constant Field Values
-
F22
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F22
Deprecated.- See Also:
- Constant Field Values
-
F23
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F23
Deprecated.- See Also:
- Constant Field Values
-
F24
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F24
Deprecated.- See Also:
- Constant Field Values
-
F25
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F25
Deprecated.- See Also:
- Constant Field Values
-
F26
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F26
Deprecated.- See Also:
- Constant Field Values
-
F27
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F27
Deprecated.- See Also:
- Constant Field Values
-
F28
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F28
Deprecated.- See Also:
- Constant Field Values
-
F0Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F0Momentary
Deprecated.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 F1Momentary
Deprecated.- See Also:
- Constant Field Values
-
F2Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F2Momentary
Deprecated.- See Also:
- Constant Field Values
-
F3Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F3Momentary
Deprecated.- See Also:
- Constant Field Values
-
F4Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F4Momentary
Deprecated.- See Also:
- Constant Field Values
-
F5Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F5Momentary
Deprecated.- See Also:
- Constant Field Values
-
F6Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F6Momentary
Deprecated.- See Also:
- Constant Field Values
-
F7Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F7Momentary
Deprecated.- See Also:
- Constant Field Values
-
F8Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F8Momentary
Deprecated.- See Also:
- Constant Field Values
-
F9Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F9Momentary
Deprecated.- See Also:
- Constant Field Values
-
F10Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F10Momentary
Deprecated.- See Also:
- Constant Field Values
-
F11Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F11Momentary
Deprecated.- See Also:
- Constant Field Values
-
F12Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F12Momentary
Deprecated.- See Also:
- Constant Field Values
-
F13Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F13Momentary
Deprecated.- See Also:
- Constant Field Values
-
F14Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F14Momentary
Deprecated.- See Also:
- Constant Field Values
-
F15Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F15Momentary
Deprecated.- See Also:
- Constant Field Values
-
F16Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F16Momentary
Deprecated.- See Also:
- Constant Field Values
-
F17Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F17Momentary
Deprecated.- See Also:
- Constant Field Values
-
F18Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F18Momentary
Deprecated.- See Also:
- Constant Field Values
-
F19Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F19Momentary
Deprecated.- See Also:
- Constant Field Values
-
F20Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F20Momentary
Deprecated.- See Also:
- Constant Field Values
-
F21Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F21Momentary
Deprecated.- See Also:
- Constant Field Values
-
F22Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F22Momentary
Deprecated.- See Also:
- Constant Field Values
-
F23Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F23Momentary
Deprecated.- See Also:
- Constant Field Values
-
F24Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F24Momentary
Deprecated.- See Also:
- Constant Field Values
-
F25Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F25Momentary
Deprecated.- See Also:
- Constant Field Values
-
F26Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F26Momentary
Deprecated.- See Also:
- Constant Field Values
-
F27Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F27Momentary
Deprecated.- See Also:
- Constant Field Values
-
F28Momentary
@Deprecated(since="5.1.2", forRemoval=false) static final java.lang.String F28Momentary
Deprecated.- 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 theSPEEDSETTING
name.- 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 theSPEEDSETTING
name.- 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
-ThrottleListener
to 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
-ThrottleListener
to release. May be null if noThrottleListener
is 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
-ThrottleListener
to 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
-
-