jmri.jmrix
Class AbstractThrottle

java.lang.Object
  jmri.jmrix.AbstractThrottle

All Implemented Interfaces:

DccThrottle, Throttle

Direct Known Subclasses:

DebugThrottle, EasyDccThrottle, LocoNetThrottle, NceThrottle, Pr2Throttle, SerialThrottle, SprogCSThrottle, SprogThrottle, SRCPThrottle, Throttle, XNetThrottle, XpaThrottle

public abstract class AbstractThrottle
extends Object
implements DccThrottle

An abstract implementation of DccThrottle. Based on Glen Oberhauser's original LnThrottleManager implementation.

Note that this implements DccThrottle, not Throttle directly, so it has some DCC-specific content.

Author:

Bob Jacobsen Copyright (C) 2001, 2005

Field Summary

protected boolean	active Is this object still usable?
protected boolean	f0
protected boolean	f0Momentary
protected boolean	f1
protected boolean	f10
protected boolean	f10Momentary
protected boolean	f11
protected boolean	f11Momentary
protected boolean	f12
protected boolean	f12Momentary
protected boolean	f13
protected boolean	f13Momentary
protected boolean	f14
protected boolean	f14Momentary
protected boolean	f15
protected boolean	f15Momentary
protected boolean	f16
protected boolean	f16Momentary
protected boolean	f17
protected boolean	f17Momentary
protected boolean	f18
protected boolean	f18Momentary
protected boolean	f19
protected boolean	f19Momentary
protected boolean	f1Momentary
protected boolean	f2
protected boolean	f20
protected boolean	f20Momentary
protected boolean	f21
protected boolean	f21Momentary
protected boolean	f22
protected boolean	f22Momentary
protected boolean	f23
protected boolean	f23Momentary
protected boolean	f24
protected boolean	f24Momentary
protected boolean	f25
protected boolean	f25Momentary
protected boolean	f26
protected boolean	f26Momentary
protected boolean	f27
protected boolean	f27Momentary
protected boolean	f28
protected boolean	f28Momentary
protected boolean	f2Momentary
protected boolean	f3
protected boolean	f3Momentary
protected boolean	f4
protected boolean	f4Momentary
protected boolean	f5
protected boolean	f5Momentary
protected boolean	f6
protected boolean	f6Momentary
protected boolean	f7
protected boolean	f7Momentary
protected boolean	f8
protected boolean	f8Momentary
protected boolean	f9
protected boolean	f9Momentary
protected boolean	isForward
protected float	speedIncrement
protected float	speedSetting
protected int	speedStepMode

Fields inherited from interface jmri.DccThrottle

SpeedStepMode128, SpeedStepMode14, SpeedStepMode27, SpeedStepMode28

Constructor Summary

AbstractThrottle()

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l)
void	dispatch() Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.
void	dispose() Dispose when finished with this object.
boolean	getF0()
boolean	getF0Momentary()
boolean	getF1()
boolean	getF10()
boolean	getF10Momentary()
boolean	getF11()
boolean	getF11Momentary()
boolean	getF12()
boolean	getF12Momentary()
boolean	getF13()
boolean	getF13Momentary()
boolean	getF14()
boolean	getF14Momentary()
boolean	getF15()
boolean	getF15Momentary()
boolean	getF16()
boolean	getF16Momentary()
boolean	getF17()
boolean	getF17Momentary()
boolean	getF18()
boolean	getF18Momentary()
boolean	getF19()
boolean	getF19Momentary()
boolean	getF1Momentary()
boolean	getF2()
boolean	getF20()
boolean	getF20Momentary()
boolean	getF21()
boolean	getF21Momentary()
boolean	getF22()
boolean	getF22Momentary()
boolean	getF23()
boolean	getF23Momentary()
boolean	getF24()
boolean	getF24Momentary()
boolean	getF25()
boolean	getF25Momentary()
boolean	getF26()
boolean	getF26Momentary()
boolean	getF27()
boolean	getF27Momentary()
boolean	getF28()
boolean	getF28Momentary()
boolean	getF2Momentary()
boolean	getF3()
boolean	getF3Momentary()
boolean	getF4()
boolean	getF4Momentary()
boolean	getF5()
boolean	getF5Momentary()
boolean	getF6()
boolean	getF6Momentary()
boolean	getF7()
boolean	getF7Momentary()
boolean	getF8()
boolean	getF8Momentary()
boolean	getF9()
boolean	getF9Momentary()
boolean	getIsForward() direction This is an bound parameter.
float	getSpeedIncrement() to handle quantized speed.
float	getSpeedSetting() speed - expressed as a value 0.0 -> 1.0.
int	getSpeedStepMode()
protected void	notifyPropertyChangeListener(String property, Object oldValue, Object newValue) Trigger the notification of all PropertyChangeListeners
void	release() Finished with this Throttle, tell the layout that the locomotive is available for reuse/reallocation by somebody else.
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	sendFunctionGroup1() Send the message to set the state of functions F0, F1, F2, F3, F4.
protected void	sendFunctionGroup2() Send the message to set the state of functions F5, F6, F7, F8.
protected void	sendFunctionGroup3() Send the message to set the state of functions F9, F10, F11, F12 This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.
protected void	sendFunctionGroup4() Send the message to set the state of functions F13, F14, F15, F16, F17, F18, F19, F20 This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.
protected void	sendFunctionGroup5() Send the message to set the state of functions F21, F22, F23, F24, F25, F26, F27, F28 This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.
protected void	sendMomentaryFunctionGroup1() Send the message to set the momentary state of functions F0, F1, F2, F3, F4.
protected void	sendMomentaryFunctionGroup2() Send the message to set the momentary state of functions F5, F6, F7, F8.
protected void	sendMomentaryFunctionGroup3() Send the message to set the Momentary state of functions F9, F10, F11, F12 This is used in the setFnMomentary implementations provided in this class, but a real implementation needs to be provided if the hardware supports setting functions momentary.
protected void	sendMomentaryFunctionGroup4() Send the message to set the Momentary state of functions F13, F14, F15, F16, F17, F18, F19, F20 This is used in the setFnMomentary implementations provided in this class, but a real implementation needs to be provided if the hardware supports setting functions momentary.
protected void	sendMomentaryFunctionGroup5() Send the message to set the Momentary state of functions F21, F22, F23, F24, F25, F26, F27, F28 This is used in the setFnMomentary implementations provided in this class, but a real implementation needs to be provided if the hardware supports setting functions momentary.
void	setF0(boolean f0)
void	setF0Momentary(boolean f0Momentary)
void	setF1(boolean f1)
void	setF10(boolean f10)
void	setF10Momentary(boolean f10Momentary)
void	setF11(boolean f11)
void	setF11Momentary(boolean f11Momentary)
void	setF12(boolean f12)
void	setF12Momentary(boolean f12Momentary)
void	setF13(boolean f13)
void	setF13Momentary(boolean f13Momentary)
void	setF14(boolean f14)
void	setF14Momentary(boolean f14Momentary)
void	setF15(boolean f15)
void	setF15Momentary(boolean f15Momentary)
void	setF16(boolean f16)
void	setF16Momentary(boolean f16Momentary)
void	setF17(boolean f17)
void	setF17Momentary(boolean f17Momentary)
void	setF18(boolean f18)
void	setF18Momentary(boolean f18Momentary)
void	setF19(boolean f19)
void	setF19Momentary(boolean f19Momentary)
void	setF1Momentary(boolean f1Momentary)
void	setF2(boolean f2)
void	setF20(boolean f20)
void	setF20Momentary(boolean f20Momentary)
void	setF21(boolean f21)
void	setF21Momentary(boolean f21Momentary)
void	setF22(boolean f22)
void	setF22Momentary(boolean f22Momentary)
void	setF23(boolean f23)
void	setF23Momentary(boolean f23Momentary)
void	setF24(boolean f24)
void	setF24Momentary(boolean f24Momentary)
void	setF25(boolean f25)
void	setF25Momentary(boolean f25Momentary)
void	setF26(boolean f26)
void	setF26Momentary(boolean f26Momentary)
void	setF27(boolean f27)
void	setF27Momentary(boolean f27Momentary)
void	setF28(boolean f28)
void	setF28Momentary(boolean f28Momentary)
void	setF2Momentary(boolean f2Momentary)
void	setF3(boolean f3)
void	setF3Momentary(boolean f3Momentary)
void	setF4(boolean f4)
void	setF4Momentary(boolean f4Momentary)
void	setF5(boolean f5)
void	setF5Momentary(boolean f5Momentary)
void	setF6(boolean f6)
void	setF6Momentary(boolean f6Momentary)
void	setF7(boolean f7)
void	setF7Momentary(boolean f7Momentary)
void	setF8(boolean f8)
void	setF8Momentary(boolean f8Momentary)
void	setF9(boolean f9)
void	setF9Momentary(boolean f9Momentary)
void	setSpeedStepMode(int Mode)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.Throttle

getLocoAddress, setIsForward, setSpeedSetting

Field Detail

speedSetting

protected float speedSetting

speedIncrement

protected float speedIncrement

speedStepMode

protected int speedStepMode

isForward

protected boolean isForward

f0

protected boolean f0

f1

protected boolean f1

f2

protected boolean f2

f3

protected boolean f3

f4

protected boolean f4

f5

protected boolean f5

f6

protected boolean f6

f7

protected boolean f7

f8

protected boolean f8

f9

protected boolean f9

f10

protected boolean f10

f11

protected boolean f11

f12

protected boolean f12

f13

protected boolean f13

f14

protected boolean f14

f15

protected boolean f15

f16

protected boolean f16

f17

protected boolean f17

f18

protected boolean f18

f19

protected boolean f19

f20

protected boolean f20

f21

protected boolean f21

f22

protected boolean f22

f23

protected boolean f23

f24

protected boolean f24

f25

protected boolean f25

f26

protected boolean f26

f27

protected boolean f27

f28

protected boolean f28

f0Momentary

protected boolean f0Momentary

f1Momentary

protected boolean f1Momentary

f2Momentary

protected boolean f2Momentary

f3Momentary

protected boolean f3Momentary

f4Momentary

protected boolean f4Momentary

f5Momentary

protected boolean f5Momentary

f6Momentary

protected boolean f6Momentary

f7Momentary

protected boolean f7Momentary

f8Momentary

protected boolean f8Momentary

f9Momentary

protected boolean f9Momentary

f10Momentary

protected boolean f10Momentary

f11Momentary

protected boolean f11Momentary

f12Momentary

protected boolean f12Momentary

f13Momentary

protected boolean f13Momentary

f14Momentary

protected boolean f14Momentary

f15Momentary

protected boolean f15Momentary

f16Momentary

protected boolean f16Momentary

f17Momentary

protected boolean f17Momentary

f18Momentary

protected boolean f18Momentary

f19Momentary

protected boolean f19Momentary

f20Momentary

protected boolean f20Momentary

f21Momentary

protected boolean f21Momentary

f22Momentary

protected boolean f22Momentary

f23Momentary

protected boolean f23Momentary

f24Momentary

protected boolean f24Momentary

f25Momentary

protected boolean f25Momentary

f26Momentary

protected boolean f26Momentary

f27Momentary

protected boolean f27Momentary

f28Momentary

protected boolean f28Momentary

active

protected boolean active

Is this object still usable? Set false after dispose, this variable is used to check for incorrect usage.

Constructor Detail

AbstractThrottle

public AbstractThrottle()

Method Detail

getSpeedSetting

public float getSpeedSetting()

speed - expressed as a value 0.0 -> 1.0. Negative means emergency stop. This is an bound parameter.

Specified by:

getSpeedSetting in interface Throttle

getIsForward

public boolean getIsForward()

direction This is an bound parameter.

Specified by:

getIsForward in interface Throttle

getF0

public boolean getF0()

Specified by:

getF0 in interface Throttle

getF1

public boolean getF1()

Specified by:

getF1 in interface Throttle

getF2

public boolean getF2()

Specified by:

getF2 in interface Throttle

getF3

public boolean getF3()

Specified by:

getF3 in interface Throttle

getF4

public boolean getF4()

Specified by:

getF4 in interface Throttle

getF5

public boolean getF5()

Specified by:

getF5 in interface Throttle

getF6

public boolean getF6()

Specified by:

getF6 in interface Throttle

getF7

public boolean getF7()

Specified by:

getF7 in interface Throttle

getF8

public boolean getF8()

Specified by:

getF8 in interface Throttle

getF9

public boolean getF9()

Specified by:

getF9 in interface Throttle

getF10

public boolean getF10()

Specified by:

getF10 in interface Throttle

getF11

public boolean getF11()

Specified by:

getF11 in interface Throttle

getF12

public boolean getF12()

Specified by:

getF12 in interface Throttle

getF13

public boolean getF13()

Specified by:

getF13 in interface Throttle

getF14

public boolean getF14()

Specified by:

getF14 in interface Throttle

getF15

public boolean getF15()

Specified by:

getF15 in interface Throttle

getF16

public boolean getF16()

Specified by:

getF16 in interface Throttle

getF17

public boolean getF17()

Specified by:

getF17 in interface Throttle

getF18

public boolean getF18()

Specified by:

getF18 in interface Throttle

getF19

public boolean getF19()

Specified by:

getF19 in interface Throttle

getF20

public boolean getF20()

Specified by:

getF20 in interface Throttle

getF21

public boolean getF21()

Specified by:

getF21 in interface Throttle

getF22

public boolean getF22()

Specified by:

getF22 in interface Throttle

getF23

public boolean getF23()

Specified by:

getF23 in interface Throttle

getF24

public boolean getF24()

Specified by:

getF24 in interface Throttle

getF25

public boolean getF25()

Specified by:

getF25 in interface Throttle

getF26

public boolean getF26()

Specified by:

getF26 in interface Throttle

getF27

public boolean getF27()

Specified by:

getF27 in interface Throttle

getF28

public boolean getF28()

Specified by:

getF28 in interface Throttle

getF0Momentary

public boolean getF0Momentary()

Specified by:

getF0Momentary in interface Throttle

getF1Momentary

public boolean getF1Momentary()

Specified by:

getF1Momentary in interface Throttle

getF2Momentary

public boolean getF2Momentary()

Specified by:

getF2Momentary in interface Throttle

getF3Momentary

public boolean getF3Momentary()

Specified by:

getF3Momentary in interface Throttle

getF4Momentary

public boolean getF4Momentary()

Specified by:

getF4Momentary in interface Throttle

getF5Momentary

public boolean getF5Momentary()

Specified by:

getF5Momentary in interface Throttle

getF6Momentary

public boolean getF6Momentary()

Specified by:

getF6Momentary in interface Throttle

getF7Momentary

public boolean getF7Momentary()

Specified by:

getF7Momentary in interface Throttle

getF8Momentary

public boolean getF8Momentary()

Specified by:

getF8Momentary in interface Throttle

getF9Momentary

public boolean getF9Momentary()

Specified by:

getF9Momentary in interface Throttle

getF10Momentary

public boolean getF10Momentary()

Specified by:

getF10Momentary in interface Throttle

getF11Momentary

public boolean getF11Momentary()

Specified by:

getF11Momentary in interface Throttle

getF12Momentary

public boolean getF12Momentary()

Specified by:

getF12Momentary in interface Throttle

getF13Momentary

public boolean getF13Momentary()

Specified by:

getF13Momentary in interface Throttle

getF14Momentary

public boolean getF14Momentary()

Specified by:

getF14Momentary in interface Throttle

getF15Momentary

public boolean getF15Momentary()

Specified by:

getF15Momentary in interface Throttle

getF16Momentary

public boolean getF16Momentary()

Specified by:

getF16Momentary in interface Throttle

getF17Momentary

public boolean getF17Momentary()

Specified by:

getF17Momentary in interface Throttle

getF18Momentary

public boolean getF18Momentary()

Specified by:

getF18Momentary in interface Throttle

getF19Momentary

public boolean getF19Momentary()

Specified by:

getF19Momentary in interface Throttle

getF20Momentary

public boolean getF20Momentary()

Specified by:

getF20Momentary in interface Throttle

getF21Momentary

public boolean getF21Momentary()

Specified by:

getF21Momentary in interface Throttle

getF22Momentary

public boolean getF22Momentary()

Specified by:

getF22Momentary in interface Throttle

getF23Momentary

public boolean getF23Momentary()

Specified by:

getF23Momentary in interface Throttle

getF24Momentary

public boolean getF24Momentary()

Specified by:

getF24Momentary in interface Throttle

getF25Momentary

public boolean getF25Momentary()

Specified by:

getF25Momentary in interface Throttle

getF26Momentary

public boolean getF26Momentary()

Specified by:

getF26Momentary in interface Throttle

getF27Momentary

public boolean getF27Momentary()

Specified by:

getF27Momentary in interface Throttle

getF28Momentary

public boolean getF28Momentary()

Specified by:

getF28Momentary in interface Throttle

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Throttle

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Throttle

notifyPropertyChangeListener

protected void notifyPropertyChangeListener(String property,
                                            Object oldValue,
                                            Object newValue)

Trigger the notification of all PropertyChangeListeners

dispose

public void dispose()

Dispose when finished with this object. After this, further usage of this Throttle object will result in a JmriException.

Specified by:

dispose in interface Throttle

dispatch

public void dispatch()

Description copied from interface: Throttle

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 synomous with release();

After this, further usage of this Throttle object will result in a JmriException.

Normally, dispatch ends with a call to dispose.

Specified by:

dispatch in interface Throttle

release

public void release()

Description copied from interface: Throttle

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.

Specified by:

release in interface Throttle

getSpeedIncrement

public float getSpeedIncrement()

to handle quantized speed. Note this can change! Valued returned is always positive.

Specified by:

getSpeedIncrement in interface DccThrottle

setF0

public void setF0(boolean f0)

Specified by:

setF0 in interface Throttle

setF1

public void setF1(boolean f1)

Specified by:

setF1 in interface Throttle

setF2

public void setF2(boolean f2)

Specified by:

setF2 in interface Throttle

setF3

public void setF3(boolean f3)

Specified by:

setF3 in interface Throttle

setF4

public void setF4(boolean f4)

Specified by:

setF4 in interface Throttle

setF5

public void setF5(boolean f5)

Specified by:

setF5 in interface Throttle

setF6

public void setF6(boolean f6)

Specified by:

setF6 in interface Throttle

setF7

public void setF7(boolean f7)

Specified by:

setF7 in interface Throttle

setF8

public void setF8(boolean f8)

Specified by:

setF8 in interface Throttle

setF9

public void setF9(boolean f9)

Specified by:

setF9 in interface Throttle

setF10

public void setF10(boolean f10)

Specified by:

setF10 in interface Throttle

setF11

public void setF11(boolean f11)

Specified by:

setF11 in interface Throttle

setF12

public void setF12(boolean f12)

Specified by:

setF12 in interface Throttle

setF13

public void setF13(boolean f13)

Specified by:

setF13 in interface Throttle

setF14

public void setF14(boolean f14)

Specified by:

setF14 in interface Throttle

setF15

public void setF15(boolean f15)

Specified by:

setF15 in interface Throttle

setF16

public void setF16(boolean f16)

Specified by:

setF16 in interface Throttle

setF17

public void setF17(boolean f17)

Specified by:

setF17 in interface Throttle

setF18

public void setF18(boolean f18)

Specified by:

setF18 in interface Throttle

setF19

public void setF19(boolean f19)

Specified by:

setF19 in interface Throttle

setF20

public void setF20(boolean f20)

Specified by:

setF20 in interface Throttle

setF21

public void setF21(boolean f21)

Specified by:

setF21 in interface Throttle

setF22

public void setF22(boolean f22)

Specified by:

setF22 in interface Throttle

setF23

public void setF23(boolean f23)

Specified by:

setF23 in interface Throttle

setF24

public void setF24(boolean f24)

Specified by:

setF24 in interface Throttle

setF25

public void setF25(boolean f25)

Specified by:

setF25 in interface Throttle

setF26

public void setF26(boolean f26)

Specified by:

setF26 in interface Throttle

setF27

public void setF27(boolean f27)

Specified by:

setF27 in interface Throttle

setF28

public void setF28(boolean f28)

Specified by:

setF28 in interface Throttle

sendFunctionGroup1

protected void sendFunctionGroup1()

Send the message to set the state of functions F0, F1, F2, F3, F4.

This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.

sendFunctionGroup2

protected void sendFunctionGroup2()

Send the message to set the state of functions F5, F6, F7, F8.

This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.

sendFunctionGroup3

protected void sendFunctionGroup3()

Send the message to set the state of functions F9, F10, F11, F12

This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.

sendFunctionGroup4

protected void sendFunctionGroup4()

Send the message to set the state of functions F13, F14, F15, F16, F17, F18, F19, F20

This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.

sendFunctionGroup5

protected void sendFunctionGroup5()

Send the message to set the state of functions F21, F22, F23, F24, F25, F26, F27, F28

This is used in the setFn implementations provided in this class, but a real implementation needs to be provided.

setF0Momentary

public void setF0Momentary(boolean f0Momentary)

Specified by:

setF0Momentary in interface Throttle

setF1Momentary

public void setF1Momentary(boolean f1Momentary)

Specified by:

setF1Momentary in interface Throttle

setF2Momentary

public void setF2Momentary(boolean f2Momentary)

Specified by: