Class BasicSpeedTableSpeedMatcher
- java.lang.Object
-
- jmri.jmrix.bachrus.speedmatcher.SpeedMatcher
-
- jmri.jmrix.bachrus.speedmatcher.basic.BasicSpeedMatcher
-
- jmri.jmrix.bachrus.speedmatcher.basic.BasicSpeedTableSpeedMatcher
-
- All Implemented Interfaces:
java.util.EventListener
,ProgListener
,ThrottleListener
public class BasicSpeedTableSpeedMatcher extends BasicSpeedMatcher
This is a simple speed matcher which will speed match a locomotive to a given start and top speed using the 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
BasicSpeedTableSpeedMatcher.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, 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 BasicSpeedTableSpeedMatcher(BasicSpeedMatcherConfig config)
Constructs the BasicSpeedTableSpeedMatcher from a BasicSpeedMatcherConfig
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
cleanUpSpeedMatcher()
Cleans up the speed matcher when speed matching is stopped or is finishedprotected void
initNextSpeedMatcherState(BasicSpeedTableSpeedMatcher.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 stateboolean
isSpeedMatcherIdle()
Indicates if the speed matcher is idle (not currently speed matching)void
notifyThrottleFound(DccThrottle t)
Called when a throttle is foundboolean
startSpeedMatcher()
Starts the speed matching processvoid
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, resetSpeedMatchError, setSpeedMatchError, setSpeedMatchStateTimerDuration, setThrottle, startSpeedMatchStateTimer, stopSpeedMatchStateTimer, updateCurrentSpeed, writeForwardTrim, writeMomentumAccel, writeMomentumDecel, writeReverseTrim, writeSpeedTableStep, writeVHigh, writeVMid, writeVStart
-
-
-
-
Constructor Detail
-
BasicSpeedTableSpeedMatcher
public BasicSpeedTableSpeedMatcher(BasicSpeedMatcherConfig config)
Constructs the BasicSpeedTableSpeedMatcher from a BasicSpeedMatcherConfig- Parameters:
config
- SpeedStepScaleSpeedMatcherConfig
-
-
Method Detail
-
startSpeedMatcher
public boolean startSpeedMatcher()
Starts the speed matching process- Specified by:
startSpeedMatcher
in classSpeedMatcher
- Returns:
- true if speed matching started successfully, false otherwise
-
stopSpeedMatcher
public void stopSpeedMatcher()
Stops the speed matching process- Specified by:
stopSpeedMatcher
in classSpeedMatcher
-
isSpeedMatcherIdle
public boolean isSpeedMatcherIdle()
Indicates if the speed matcher is idle (not currently speed matching)- Specified by:
isSpeedMatcherIdle
in classSpeedMatcher
- 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 classSpeedMatcher
-
notifyThrottleFound
public void notifyThrottleFound(DccThrottle t)
Called when a throttle is found- Specified by:
notifyThrottleFound
in interfaceThrottleListener
- Overrides:
notifyThrottleFound
in classSpeedMatcher
- Parameters:
t
- the requested DccThrottle
-
initNextSpeedMatcherState
protected void initNextSpeedMatcherState(BasicSpeedTableSpeedMatcher.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
-
-