jmri.jmrix.xpa
Class XpaThrottle

java.lang.Object
  jmri.jmrix.AbstractThrottle
      jmri.jmrix.xpa.XpaThrottle

All Implemented Interfaces:

DccThrottle, Throttle

public class XpaThrottle
extends AbstractThrottle

An XPA+Modem implementation of the Throttle for XPressNet Systems

Author:

Paul Bender Copyright (C) 2004

Field Summary

Fields inherited from class jmri.jmrix.AbstractThrottle

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

Fields inherited from interface jmri.DccThrottle

SpeedStepMode128, SpeedStepMode14, SpeedStepMode27, SpeedStepMode28

Constructor Summary

XpaThrottle(LocoAddress address)
Constructor

Method Summary

LocoAddress	getLocoAddress() Locomotive address.
void	sendFunctionGroup1() Send the message to set the state of functions F0, F1, F2, F3, F4.
void	sendFunctionGroup2() Send the message to set the state of functions F5, F6, F7, F8.
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.
void	setF0(boolean f0)
void	setF1(boolean f1)
void	setF10(boolean f10)
void	setF11(boolean f11)
void	setF12(boolean f12)
void	setF2(boolean f2)
void	setF3(boolean f3)
void	setF4(boolean f4)
void	setF5(boolean f5)
void	setF6(boolean f6)
void	setF7(boolean f7)
void	setF8(boolean f8)
void	setF9(boolean f9)
void	setIsForward(boolean forward)
void	setSpeedSetting(float speed) Set the speed & direction.

Methods inherited from class jmri.jmrix.AbstractThrottle

addPropertyChangeListener, dispatch, dispose, getF0, getF0Momentary, getF1, getF10, getF10Momentary, getF11, getF11Momentary, getF12, getF12Momentary, getF13, getF13Momentary, getF14, getF14Momentary, getF15, getF15Momentary, getF16, getF16Momentary, getF17, getF17Momentary, getF18, getF18Momentary, getF19, getF19Momentary, getF1Momentary, getF2, getF20, getF20Momentary, getF21, getF21Momentary, getF22, getF22Momentary, getF23, getF23Momentary, getF24, getF24Momentary, getF25, getF25Momentary, getF26, getF26Momentary, getF27, getF27Momentary, getF28, getF28Momentary, getF2Momentary, getF3, getF3Momentary, getF4, getF4Momentary, getF5, getF5Momentary, getF6, getF6Momentary, getF7, getF7Momentary, getF8, getF8Momentary, getF9, getF9Momentary, getIsForward, getSpeedIncrement, getSpeedSetting, getSpeedStepMode, notifyPropertyChangeListener, release, removePropertyChangeListener, sendFunctionGroup4, sendFunctionGroup5, sendMomentaryFunctionGroup1, sendMomentaryFunctionGroup2, sendMomentaryFunctionGroup3, sendMomentaryFunctionGroup4, sendMomentaryFunctionGroup5, setF0Momentary, setF10Momentary, setF11Momentary, setF12Momentary, setF13, setF13Momentary, setF14, setF14Momentary, setF15, setF15Momentary, setF16, setF16Momentary, setF17, setF17Momentary, setF18, setF18Momentary, setF19, setF19Momentary, setF1Momentary, setF20, setF20Momentary, setF21, setF21Momentary, setF22, setF22Momentary, setF23, setF23Momentary, setF24, setF24Momentary, setF25, setF25Momentary, setF26, setF26Momentary, setF27, setF27Momentary, setF28, setF28Momentary, setF2Momentary, setF3Momentary, setF4Momentary, setF5Momentary, setF6Momentary, setF7Momentary, setF8Momentary, setF9Momentary, setSpeedStepMode

Methods inherited from class java.lang.Object

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

Constructor Detail

XpaThrottle

public XpaThrottle(LocoAddress address)

Constructor

Method Detail

setSpeedSetting

public void setSpeedSetting(float speed)

Set the speed & direction.

This intentionally skips the emergency stop value of 1.

Parameters:

speed - Number from 0 to 1; less than zero is emergency stop

setIsForward

public void setIsForward(boolean forward)

setF0

public void setF0(boolean f0)

Specified by:

setF0 in interface Throttle

Overrides:

setF0 in class AbstractThrottle

setF1

public void setF1(boolean f1)

Specified by:

setF1 in interface Throttle

Overrides:

setF1 in class AbstractThrottle

setF2

public void setF2(boolean f2)

Specified by:

setF2 in interface Throttle

Overrides:

setF2 in class AbstractThrottle

setF3

public void setF3(boolean f3)

Specified by:

setF3 in interface Throttle

Overrides:

setF3 in class AbstractThrottle

setF4

public void setF4(boolean f4)

Specified by:

setF4 in interface Throttle

Overrides:

setF4 in class AbstractThrottle

setF5

public void setF5(boolean f5)

Specified by:

setF5 in interface Throttle

Overrides:

setF5 in class AbstractThrottle

setF6

public void setF6(boolean f6)

Specified by:

setF6 in interface Throttle

Overrides:

setF6 in class AbstractThrottle

setF7

public void setF7(boolean f7)

Specified by:

setF7 in interface Throttle

Overrides:

setF7 in class AbstractThrottle

setF8

public void setF8(boolean f8)

Specified by:

setF8 in interface Throttle

Overrides:

setF8 in class AbstractThrottle

setF9

public void setF9(boolean f9)

Specified by:

setF9 in interface Throttle

Overrides:

setF9 in class AbstractThrottle

setF10

public void setF10(boolean f10)

Specified by:

setF10 in interface Throttle

Overrides:

setF10 in class AbstractThrottle

setF11

public void setF11(boolean f11)

Specified by:

setF11 in interface Throttle

Overrides:

setF11 in class AbstractThrottle

setF12

public void setF12(boolean f12)

Specified by:

setF12 in interface Throttle

Overrides:

setF12 in class AbstractThrottle

sendFunctionGroup1

public void sendFunctionGroup1()

Description copied from class: AbstractThrottle

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.

Overrides:

sendFunctionGroup1 in class AbstractThrottle

sendFunctionGroup2

public void sendFunctionGroup2()

Description copied from class: AbstractThrottle

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.

Overrides:

sendFunctionGroup2 in class AbstractThrottle

sendFunctionGroup3

public void sendFunctionGroup3()

Description copied from class: AbstractThrottle

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.

Overrides:

sendFunctionGroup3 in class AbstractThrottle

getLocoAddress

public LocoAddress getLocoAddress()

Description copied from interface: Throttle

Locomotive address. The exact format is defined by the specific implementation, as subclasses of LocoAddress will contain different information. This is an unbound parameter.