Package jmri.jmrix.bachrus.speedmatcher.speedStepScale

Class SpeedStepScaleESUTableSpeedMatcher

java.lang.Object

jmri.jmrix.bachrus.speedmatcher.SpeedMatcher

jmri.jmrix.bachrus.speedmatcher.speedStepScale.SpeedStepScaleSpeedMatcher

jmri.jmrix.bachrus.speedmatcher.speedStepScale.SpeedStepScaleESUTableSpeedMatcher

All Implemented Interfaces:

java.util.EventListener, ProgListener, ThrottleListener

public class SpeedStepScaleESUTableSpeedMatcher
extends SpeedStepScaleSpeedMatcher

This is a speed step scale speed matcher which will speed match a locomotive such that its speed in mph/kph will be equal to its speed step in 128 speed step mode. This uses ESU's implementation of the complex speed table, and the locomotive's speed will plateau at either its actual top speed or the set max speed, whichever is lower.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SpeedStepScaleESUTableSpeedMatcher.SpeedMatcherState

Nested classes/interfaces inherited from class jmri.jmrix.bachrus.speedmatcher.SpeedMatcher

SpeedMatcher.ProgrammerState, SpeedMatcher.SpeedMatcherCV, SpeedMatcher.SpeedTableStep

Nested classes/interfaces inherited from interface jmri.ThrottleListener

ThrottleListener.DecisionType

Field Summary

Fields inherited from class jmri.jmrix.bachrus.speedmatcher.speedStepScale.SpeedStepScaleSpeedMatcher

actualMaxSpeedField, measuredMaxSpeedKPH, speedMatchMaxSpeedKPH, speedUnit, targetMaxSpeedKPH, targetMaxSpeedStep

Fields inherited from class jmri.jmrix.bachrus.speedmatcher.SpeedMatcher

ALLOWED_SPEED_MATCH_ERROR, currentSpeedKPH, dccLocoAddress, INITIAL_MOMENTUM, Kd, Ki, Kp, lastSpeedMatchError, opsModeProgrammer, powerManager, programmerState, REVERSE_TRIM_MAX, REVERSE_TRIM_MIN, speedMatchDerivative, speedMatchError, speedMatchIntegral, startStopButton, statusLabel, stepDuration, Td, Ti, trimReverseSpeed, warmUpForwardSeconds, warmUpReverseSeconds

Fields inherited from interface jmri.ProgListener

CommError, ConfirmFailed, FailedTimeout, NoAck, NoLocoDetected, NotImplemented, OK, ProgrammerBusy, ProgrammingShort, SequenceError, UnknownError, UserAborted

Constructor Summary

Constructors

Constructor	Description
SpeedStepScaleESUTableSpeedMatcher(SpeedStepScaleSpeedMatcherConfig config)	Constructs the SpeedStepScaleESUTableSpeedMatcher from a SpeedStepScaleSpeedMatcherConfig

Method Summary

Modifier and Type	Method	Description
protected void	cleanUpSpeedMatcher()	Cleans up the speed matcher when speed matching is stopped or is finished
protected void	initNextSpeedMatcherState(SpeedStepScaleESUTableSpeedMatcher.SpeedMatcherState nextState)	Sets up the speed match state by clearing the speed match error, clearing the step duration, setting the timer duration, and setting the next state
boolean	isSpeedMatcherIdle()	Indicates if the speed matcher is idle (not currently speed matching)
void	notifyThrottleFound(DccThrottle t)	Called when a throttle is found
boolean	startSpeedMatcher()	Starts the speed matching process
void	stopSpeedMatcher()	Stops the speed matching process

Methods inherited from class jmri.jmrix.bachrus.speedmatcher.speedStepScale.SpeedStepScaleSpeedMatcher

getNextLowestSpeedTableStepForSpeed, getSpeedForSpeedTableStep, getSpeedStepLinearValue, getSpeedStepScaleSpeedInKPH, validate

Methods inherited from class jmri.jmrix.bachrus.speedmatcher.SpeedMatcher

getNextSpeedMatchValue, initializeAndStartSpeedMatcher, notifyDecisionRequired, notifyFailedThrottleRequest, programmingOpReply, resetSpeedMatchError, setSpeedMatchError, setSpeedMatchStateTimerDuration, setThrottle, startSpeedMatchStateTimer, stopSpeedMatchStateTimer, updateCurrentSpeed, writeForwardTrim, writeMomentumAccel, writeMomentumDecel, writeReverseTrim, writeSpeedTableStep, writeVHigh, writeVMid, writeVStart

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeedStepScaleESUTableSpeedMatcher

public SpeedStepScaleESUTableSpeedMatcher(SpeedStepScaleSpeedMatcherConfig config)

Constructs the SpeedStepScaleESUTableSpeedMatcher from a SpeedStepScaleSpeedMatcherConfig

Parameters:

config - SpeedStepScaleSpeedMatcherConfig

Method Detail

startSpeedMatcher

public boolean startSpeedMatcher()

Starts the speed matching process

Specified by:

startSpeedMatcher in class SpeedMatcher

Returns:

true if speed matching started successfully, false otherwise

stopSpeedMatcher

public void stopSpeedMatcher()

Stops the speed matching process

Specified by:

stopSpeedMatcher in class SpeedMatcher

isSpeedMatcherIdle

public boolean isSpeedMatcherIdle()

Indicates if the speed matcher is idle (not currently speed matching)

Specified by:

isSpeedMatcherIdle in class SpeedMatcher

Returns:

true if idle, false otherwise

cleanUpSpeedMatcher

protected void cleanUpSpeedMatcher()

Cleans up the speed matcher when speed matching is stopped or is finished

Overrides:

cleanUpSpeedMatcher in class SpeedMatcher

notifyThrottleFound

public void notifyThrottleFound(DccThrottle t)

Called when a throttle is found

Specified by:

notifyThrottleFound in interface ThrottleListener

Overrides:

notifyThrottleFound in class SpeedMatcher

Parameters:

t - the requested DccThrottle

initNextSpeedMatcherState

protected void initNextSpeedMatcherState(SpeedStepScaleESUTableSpeedMatcher.SpeedMatcherState nextState)

Sets up the speed match state by clearing the speed match error, clearing the step duration, setting the timer duration, and setting the next state

Parameters:

nextState - - next SpeedMatcherState to set