Package jmri.jmrit.roster.swing.speedprofile

Class SpeedProfilePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.JmriPanel

jmri.jmrit.roster.swing.speedprofile.SpeedProfilePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ThrottleListener

class SpeedProfilePanel
extends JmriPanel
implements ThrottleListener

Set up and run automated speed table calibration.

Uses three sensors in a row (see diagram in window help):

• Start sensor: Track where locomotive starts
• Block sensor: Middle track. This time through this is used to measure the speed.
• Finish sensor: Track where locomotive stops before repeating.

The expected sequence is:

• Start moving with Start sensor on, others off.
• Block (middle) sensor goes active: startListener calls startTiming
• Finish sensor goes active: finishListener calls stopCurrentSpeedStep
• Block (middle) sensor goes inactive: startListener calls stopLoco, which stops loco after 2.5 seconds

After a forward run, the Start and Finish sensors are swapped for a run in reverse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SpeedProfilePanel.SensorDetails
(package private) static class	SpeedProfilePanel.SpeedStep

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface jmri.ThrottleListener

ThrottleListener.DecisionType

Field Summary

Fields

Modifier and Type	Field	Description
(package private) BeanSelectCreatePanel<Block>	blockCPanel
(package private) JButton	cancelButton
(package private) JButton	clearNewDataButton
(package private) JButton	deleteProfileButton
(package private) PropertyChangeListener	finishListener
(package private) Sensor	finishSensor
(package private) int	finishSpeedStep
(package private) long	finishTime
(package private) ArrayList<Double>	forwardOverRuns
(package private) boolean	isForward
(package private) JTextField	lengthField
(package private) SpeedProfilePanel.SensorDetails	middleBlockSensor
(package private) PropertyChangeListener	middleListener
(package private) Timer	overRunTimer
(package private) boolean	profile
protected float	profileBlockLength
(package private) JButton	profileButton
protected float	profileIncrement
protected float	profileSensorDelay
protected float	profileSpeed
protected float	profileSpeedAtStart
protected int	profileSpeedStepMode
protected int	profileStep
(package private) RosterEntry	re
(package private) RosterEntryComboBox	reBox
(package private) JButton	replaceProfileButton
(package private) ArrayList<Double>	reverseOverRuns
(package private) RosterSpeedProfile	rosterSpeedProfile
(package private) boolean	save
(package private) JButton	saveDefaultsButton
(package private) SpeedProfilePanel.SensorDetails	sensorA
(package private) BeanSelectCreatePanel<Sensor>	sensorAPanel
(package private) SpeedProfilePanel.SensorDetails	sensorB
(package private) BeanSelectCreatePanel<Sensor>	sensorBPanel
(package private) BeanSelectCreatePanel<Sensor>	sensorCPanel
(package private) JTextField	sensorDelay
(package private) TreeMap<Integer,SpeedProfilePanel.SpeedStep>	speeds
(package private) JTextField	speedStepFrom
(package private) JTextField	speedStepIncr
(package private) JTextField	speedStepTest
(package private) JTextField	speedStepTestFwd
(package private) JTextField	speedStepTestRev
(package private) JTextField	speedStepTo
(package private) PropertyChangeListener	startListener
(package private) Sensor	startSensor
(package private) long	startTime
(package private) boolean	stepCalculated
protected int	stepIncr
(package private) DccThrottle	t
(package private) SpeedProfileTable	table
(package private) boolean	test
(package private) JButton	testButton
(package private) JButton	testCancelButton
(package private) float	testSpeedFwd
(package private) float	testSpeedRev
(package private) boolean	unmergedNewData
(package private) boolean	unsavedUpdatedProfile
(package private) JPanel	update
(package private) JButton	updateProfileButton
(package private) JButton	viewButton
(package private) JButton	viewMergedButton
(package private) JButton	viewNewButton
(package private) JLabel	warrentScaleLabel
static final String	XML_NAMESPACE
static final String	XML_ROOT

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
SpeedProfilePanel()

Method Summary

Modifier and Type	Method	Description
(package private) static void	addRow(JPanel main, GridBagLayout gb, GridBagConstraints c, int row, Component left, Component right)
(package private) void	calculateSpeed()
(package private) void	cancelButton()	We are canceling, release throttle, reset sensors.
(package private) void	clearNewData()
(package private) static JPanel	makeLabelPanel(String text, Component comp)
(package private) static JPanel	makePadPanel(Component comp)
void	notifyDecisionRequired(LocoAddress address, ThrottleListener.DecisionType question)	Profiling on a stolen or shared throttle is invalid
void	notifyFailedThrottleRequest(LocoAddress address, String reason)	Get notification that an attempt to request a throttle has failed.
void	notifyThrottleFound(DccThrottle _throttle)	Get notification that a throttle has been found as requested.
(package private) void	removeSpeedProfile()
(package private) void	setButtonStates(boolean state)
(package private) void	setupProfile()
(package private) boolean	speedStepNumOK(int num, String step)
(package private) void	startProfile()
(package private) void	startTiming()
(package private) void	stopCurrentSpeedStep()
(package private) void	stopLoco()
(package private) void	stopTrainTest()
(package private) void	testButton()
(package private) void	updateSpeedProfileWithResults()	Merge the new data into the existing speedprofile, or create if not current, and save.
(package private) void	viewMergedData()	Merge the current profile with the new data in a temp area and show.
(package private) void	viewNewProfileData()	View the new data collected we create a dummy entry and file with collected data
(package private) void	viewRosterProfileData()	View the current speedprofile table entrys

Methods inherited from class jmri.util.swing.JmriPanel

dispose, getHelpTarget, getMenus, getMinimumDimension, getTitle, getWindowInterface, initComponents, initContext, isMultipleInstances, setWindowInterface

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

XML_ROOT

public static final String XML_ROOT

See Also:

• Constant Field Values

XML_NAMESPACE

public static final String XML_NAMESPACE

See Also:

• Constant Field Values

profileButton

JButton profileButton

cancelButton

JButton cancelButton

testButton

JButton testButton

testCancelButton

JButton testCancelButton

clearNewDataButton

JButton clearNewDataButton

viewNewButton

JButton viewNewButton

viewMergedButton

JButton viewMergedButton

viewButton

JButton viewButton

updateProfileButton

JButton updateProfileButton

replaceProfileButton

JButton replaceProfileButton

deleteProfileButton

JButton deleteProfileButton

saveDefaultsButton

JButton saveDefaultsButton

lengthField

JTextField lengthField

sensorDelay

JTextField sensorDelay

speedStepTest

JTextField speedStepTest

speedStepTestFwd

JTextField speedStepTestFwd

speedStepTestRev

JTextField speedStepTestRev

speedStepFrom

JTextField speedStepFrom

speedStepTo

JTextField speedStepTo

speedStepIncr

JTextField speedStepIncr

warrentScaleLabel

JLabel warrentScaleLabel

sensorAPanel

BeanSelectCreatePanel<Sensor> sensorAPanel

sensorBPanel

BeanSelectCreatePanel<Sensor> sensorBPanel

blockCPanel

BeanSelectCreatePanel<Block> blockCPanel

sensorCPanel

BeanSelectCreatePanel<Sensor> sensorCPanel

reBox

RosterEntryComboBox reBox

table

SpeedProfileTable table

profile

boolean profile

test

boolean test

testSpeedFwd

float testSpeedFwd

testSpeedRev

float testSpeedRev

save

boolean save

unmergedNewData

boolean unmergedNewData

unsavedUpdatedProfile

boolean unsavedUpdatedProfile

sensorA

SpeedProfilePanel.SensorDetails sensorA

sensorB

SpeedProfilePanel.SensorDetails sensorB

re

RosterEntry re

t

DccThrottle t

finishSpeedStep

int finishSpeedStep

stepIncr

protected int stepIncr

profileStep

protected int profileStep

profileSpeed

protected float profileSpeed

profileIncrement

protected float profileIncrement

profileSpeedStepMode

protected int profileSpeedStepMode

profileSensorDelay

protected float profileSensorDelay

profileBlockLength

protected float profileBlockLength

rosterSpeedProfile

RosterSpeedProfile rosterSpeedProfile

profileSpeedAtStart

protected float profileSpeedAtStart

overRunTimer

Timer overRunTimer

startListener

PropertyChangeListener startListener

finishListener

PropertyChangeListener finishListener

middleListener

PropertyChangeListener middleListener

startSensor

Sensor startSensor

finishSensor

Sensor finishSensor

middleBlockSensor

SpeedProfilePanel.SensorDetails middleBlockSensor

isForward

boolean isForward

stepCalculated

boolean stepCalculated

startTime

long startTime

finishTime

long finishTime

forwardOverRuns

ArrayList<Double> forwardOverRuns

reverseOverRuns

ArrayList<Double> reverseOverRuns

update

JPanel update

speeds

TreeMap<Integer,SpeedProfilePanel.SpeedStep> speeds

Constructor Details

SpeedProfilePanel

public SpeedProfilePanel()

Method Details

addRow

static void addRow(JPanel main,
 GridBagLayout gb,
 GridBagConstraints c,
 int row,
 Component left,
 Component right)

makePadPanel

static JPanel makePadPanel(Component comp)

makeLabelPanel

static JPanel makeLabelPanel(String text,
 Component comp)

setupProfile

void setupProfile()

speedStepNumOK

boolean speedStepNumOK(int num,
 String step)

notifyThrottleFound

public void notifyThrottleFound(DccThrottle _throttle)

Description copied from interface: ThrottleListener

Get notification that a throttle has been found as requested.

Specified by:

notifyThrottleFound in interface ThrottleListener

Parameters:

_throttle - the throttle with the requested address

setButtonStates

void setButtonStates(boolean state)

notifyFailedThrottleRequest

public void notifyFailedThrottleRequest(LocoAddress address,
 String reason)

Description copied from interface: ThrottleListener

Get notification that an attempt to request a throttle has failed.

Specified by:

notifyFailedThrottleRequest in interface ThrottleListener

Parameters:

address - address of the failed request

reason - failure cause

notifyDecisionRequired

public void notifyDecisionRequired(LocoAddress address,
 ThrottleListener.DecisionType question)

Profiling on a stolen or shared throttle is invalid

Get notification that a throttle request is in use by another device, and a "steal", "share", or "steal/share" decision may be required.

Specified by:

notifyDecisionRequired in interface ThrottleListener

Parameters:

address - The LocoAddress that needs the decision.

question - The question being asked, steal / cancel, share / cancel, steal / share / cancel

startProfile

void startProfile()

startTiming

void startTiming()

stopCurrentSpeedStep

void stopCurrentSpeedStep()

stopLoco

void stopLoco()

calculateSpeed

void calculateSpeed()

updateSpeedProfileWithResults

void updateSpeedProfileWithResults()

Merge the new data into the existing speedprofile, or create if not current, and save. Clear new data.

viewMergedData

void viewMergedData()

Merge the current profile with the new data in a temp area and show.

clearNewData

void clearNewData()

removeSpeedProfile

void removeSpeedProfile()

viewNewProfileData

void viewNewProfileData()

View the new data collected we create a dummy entry and file with collected data

viewRosterProfileData

void viewRosterProfileData()

View the current speedprofile table entrys

cancelButton

void cancelButton()

We are canceling, release throttle, reset sensors.

testButton

void testButton()

stopTrainTest

void stopTrainTest()