Package jmri.jmrix.bachrus.speedmatcher.basic

Class BasicESUTableSpeedMatcher

java.lang.Object

jmri.jmrix.bachrus.speedmatcher.SpeedMatcher

jmri.jmrix.bachrus.speedmatcher.basic.BasicSpeedMatcher

jmri.jmrix.bachrus.speedmatcher.basic.BasicESUTableSpeedMatcher

All Implemented Interfaces:

java.util.EventListener, ProgListener, ThrottleListener

public class BasicESUTableSpeedMatcher
extends BasicSpeedMatcher

This is a simple speed matcher which will speed match a locomotive to a given start and top speed using ESU's complex speed table. Speed steps 1, 10, 19, and 28 will be set according to values interpolated linearly between the given start and to speeds. Values for the remaining CVs will interpolated between these 4 CVs. This is done to reduce the time the speed match takes and to increase likelihood of success.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BasicESUTableSpeedMatcher.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.basic.BasicSpeedMatcher

targetStartSpeedKPH, targetTopSpeedKPH

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

ALLOWED_SPEED_MATCH_ERROR, attempt, currentSpeedKPH, dccLocoAddress, INITIAL_MOMENTUM, opsModeProgrammer, powerManager, programmerState, REVERSE_TRIM_MAX, REVERSE_TRIM_MIN, speedMatchError, speedMatcherValueDelta, startStopButton, statusLabel, stepDuration, 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
BasicESUTableSpeedMatcher(BasicSpeedMatcherConfig config)	Constructs the BasicESUTableSpeedMatcher from a BasicSpeedMatcherConfig

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(BasicESUTableSpeedMatcher.SpeedMatcherState nextState)	Sets up the speed match state by resetting the speed matcher with a value delta of 10, clearing the step duration, setting the timer duration, and setting the next state
protected void	initNextSpeedMatcherState(BasicESUTableSpeedMatcher.SpeedMatcherState nextState, int speedMatchValueDelta)	Sets up the speed match state by resetting the speed matcher with the given value delta, 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.basic.BasicSpeedMatcher

getSpeedForSpeedStep, validate

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

getNextSpeedMatchValue, initializeAndStartSpeedMatcher, notifyDecisionRequired, notifyFailedThrottleRequest, programmingOpReply, resetSpeedMatcher, 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

BasicESUTableSpeedMatcher

public BasicESUTableSpeedMatcher(BasicSpeedMatcherConfig config)

Constructs the BasicESUTableSpeedMatcher from a BasicSpeedMatcherConfig

Parameters:

config - BasicSpeedMatcherConfig

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(BasicESUTableSpeedMatcher.SpeedMatcherState nextState)

Sets up the speed match state by resetting the speed matcher with a value delta of 10, clearing the step duration, setting the timer duration, and setting the next state

Parameters:

nextState - next SpeedMatcherState to set

initNextSpeedMatcherState

protected void initNextSpeedMatcherState(BasicESUTableSpeedMatcher.SpeedMatcherState nextState,
                                         int speedMatchValueDelta)

Sets up the speed match state by resetting the speed matcher with the given value delta, clearing the step duration, setting the timer duration, and setting the next state

Parameters:

nextState - next SpeedMatcherState to set

speedMatchValueDelta - the value delta to use when resetting the speed matcher