Package jmri.jmrix.openlcb.swing.send

Class OpenLcbCanSendPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

jmri.util.swing.JmriPanel

jmri.jmrix.can.swing.CanPanel

jmri.jmrix.openlcb.swing.send.OpenLcbCanSendPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AbstractMRListener, CanListener, CanPanelInterface

public class OpenLcbCanSendPane
extends CanPanel
implements CanListener

User interface for sending OpenLCB CAN frames to exercise the system

When sending a sequence of operations:

• Send the next message and start a timer
• When the timer trips, repeat if buttons still down.

See Also:

• Serialized Form

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ClientActions	actions
(package private) final MemorySpaceSelector	addrSpace
(package private) AliasMap	aliasMap
(package private) JButton	cdiButton
(package private) final JTextField	configAddressField
(package private) final JTextField	configNumberField
(package private) Connection	connection
(package private) final JTextField	datagramContentsField
(package private) OlcbInterface	iface
(package private) final JLabel	jLabel1
(package private) static final int	MAXSEQUENCE
(package private) MemoryConfigurationService	mcs
(package private) final JTextField[]	mDelayField
(package private) int	mNextSequenceElement
(package private) final JTextField[]	mPacketField
(package private) final JToggleButton	mRunButton
(package private) final JCheckBox[]	mUseField
(package private) NodeSelector	nodeSelector
(package private) final JTextField	packetTextField
(package private) final JTextField	readDataField
(package private) final JButton	sendButton
(package private) final JFormattedTextField	sendEventField
(package private) final JTextField	srcAliasField
(package private) NodeID	srcNodeID
(package private) MimicNodeStore	store
(package private) Timer	timer
(package private) final JComboBox<String>	validitySelector
(package private) final JTextField	writeDataField

Fields inherited from class jmri.jmrix.can.swing.CanPanel

memo

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
OpenLcbCanSendPane()

Method Summary

Modifier and Type	Method	Description
(package private) JComponent	addLineLabel(String text)
(package private) JComponent	addLineLabel(String text, JComponent c)
void	clearCache(ActionEvent e)
(package private) CanMessage	createPacket(String s)	Create a well-formed message from a String String is expected to be space seperated hex bytes or CbusAddress, e.g.: 12 34 56 +n4e1
(package private) NodeID	destNodeID()
void	dispose()	When the window closes, stop any sequences running
(package private) EventID	eventID()
String	getHelpTarget()	Provide a help target string which an enclosing frame can provide as a help reference.
String	getTitle()	Provide a recommended title for an enclosing frame.
void	initComponents(CanSystemConnectionMemo memo)	2nd stage of initialization, invoked after the Constructor is complete.
void	message(CanMessage m)	Don't pay attention to messages
void	openCdiPane()
void	readPerformed(ActionEvent e)
void	reply(CanReply m)	Don't pay attention to replies
void	restartNode(ActionEvent e)
protected void	restartTimer(int delay)	Internal routine to handle timer starts and restarts
void	runButtonActionPerformed(ActionEvent e)	Run button pressed down, start the sequence operation
void	sendButtonActionPerformed(ActionEvent e)
void	sendCimPerformed(ActionEvent e)
void	sendConsumerID(ActionEvent e)
void	sendDatagramPerformed(ActionEvent e)
void	sendDatagramReply(ActionEvent e)
void	sendEventPerformed(ActionEvent e)
void	sendGlobalIdentifyEvents(ActionEvent e)
(package private) void	sendNextItem()	Send next item; may be used for the first item or when a delay has elapsed.
void	sendProducerID(ActionEvent e)
void	sendReqConsumers(ActionEvent e)
void	sendReqProducers(ActionEvent e)
void	sendRequestEvents(ActionEvent e)
void	sendRequestPip(ActionEvent e)
void	sendRequestSnip(ActionEvent e)
void	sendVerifyNodeGlobal(ActionEvent e)
void	sendVerifyNodeGlobalID(ActionEvent e)
protected void	setCdiButton()	Set whether Open CDI button is enabled based on whether the selected node has CDI in its PIP
(package private) void	startSequenceDelay()	Echo has been heard, start delay for next packet
protected void	timeout()	Internal routine to handle a timeout and send next item
(package private) EventState	validity()
void	writePerformed(ActionEvent e)

Methods inherited from class jmri.jmrix.can.swing.CanPanel

getMemo, initContext, prependConnToString

Methods inherited from class jmri.util.swing.JmriPanel

getMenus, getMinimumDimension, getWindowInterface, initComponents, 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

Methods inherited from interface jmri.jmrix.can.CanListener

addTc, addTc, removeTc, removeTc

Field Details

jLabel1

final JLabel jLabel1

sendButton

final JButton sendButton

packetTextField

final JTextField packetTextField

MAXSEQUENCE

static final int MAXSEQUENCE

See Also:

• Constant Field Values

mPacketField

final JTextField[] mPacketField

mUseField

final JCheckBox[] mUseField

mDelayField

final JTextField[] mDelayField

mRunButton

final JToggleButton mRunButton

srcAliasField

final JTextField srcAliasField

nodeSelector

NodeSelector nodeSelector

sendEventField

final JFormattedTextField sendEventField

datagramContentsField

final JTextField datagramContentsField

configNumberField

final JTextField configNumberField

configAddressField

final JTextField configAddressField

readDataField

final JTextField readDataField

writeDataField

final JTextField writeDataField

addrSpace

final MemorySpaceSelector addrSpace

validitySelector

final JComboBox<String> validitySelector

cdiButton

JButton cdiButton

connection

Connection connection

aliasMap

AliasMap aliasMap

srcNodeID

NodeID srcNodeID

mcs

MemoryConfigurationService mcs

store

MimicNodeStore store

iface

OlcbInterface iface

actions

ClientActions actions

mNextSequenceElement

int mNextSequenceElement

timer

Timer timer

Constructor Details

OpenLcbCanSendPane

public OpenLcbCanSendPane()

Method Details

initComponents

public void initComponents(CanSystemConnectionMemo memo)

Description copied from class: CanPanel

2nd stage of initialization, invoked after the Constructor is complete.

This needs to be connected to the initContext() method in implementing classes.

Specified by:

initComponents in interface CanPanelInterface

Overrides:

initComponents in class CanPanel

Parameters:

memo - system connection.

setCdiButton

protected void setCdiButton()

Set whether Open CDI button is enabled based on whether the selected node has CDI in its PIP

getHelpTarget

public String getHelpTarget()

Description copied from class: JmriPanel

Provide a help target string which an enclosing frame can provide as a help reference.

This automatically provides a reference to the usual place for JMRI window-specific help pages that are named for the implementing class, but note this is a Pane class, not a Frame class.

Overrides:

getHelpTarget in class JmriPanel

Returns:

the target String

getTitle

public String getTitle()

Description copied from class: JmriPanel

Provide a recommended title for an enclosing frame.

Overrides:

getTitle in class JmriPanel

Returns:

the title; a null value will be treated as "" by the enclosing frame

addLineLabel

JComponent addLineLabel(String text)

addLineLabel

JComponent addLineLabel(String text,
 JComponent c)

sendButtonActionPerformed

public void sendButtonActionPerformed(ActionEvent e)

sendCimPerformed

public void sendCimPerformed(ActionEvent e)

destNodeID

NodeID destNodeID()

eventID

EventID eventID()

sendVerifyNodeGlobal

public void sendVerifyNodeGlobal(ActionEvent e)

sendVerifyNodeGlobalID

public void sendVerifyNodeGlobalID(ActionEvent e)

sendRequestEvents

public void sendRequestEvents(ActionEvent e)

sendRequestPip

public void sendRequestPip(ActionEvent e)

sendRequestSnip

public void sendRequestSnip(ActionEvent e)

sendGlobalIdentifyEvents

public void sendGlobalIdentifyEvents(ActionEvent e)

sendEventPerformed

public void sendEventPerformed(ActionEvent e)

sendReqConsumers

public void sendReqConsumers(ActionEvent e)

validity

EventState validity()

sendConsumerID

public void sendConsumerID(ActionEvent e)

sendReqProducers

public void sendReqProducers(ActionEvent e)

sendProducerID

public void sendProducerID(ActionEvent e)

sendDatagramPerformed

public void sendDatagramPerformed(ActionEvent e)

sendDatagramReply

public void sendDatagramReply(ActionEvent e)

restartNode

public void restartNode(ActionEvent e)

clearCache

public void clearCache(ActionEvent e)

readPerformed

public void readPerformed(ActionEvent e)

writePerformed

public void writePerformed(ActionEvent e)

openCdiPane

public void openCdiPane()

restartTimer

protected void restartTimer(int delay)

Internal routine to handle timer starts and restarts

Parameters:

delay - milliseconds to delay

timeout

protected void timeout()

Internal routine to handle a timeout and send next item

runButtonActionPerformed

public void runButtonActionPerformed(ActionEvent e)

Run button pressed down, start the sequence operation

Parameters:

e - event from GUI

startSequenceDelay

void startSequenceDelay()

Echo has been heard, start delay for next packet

sendNextItem

void sendNextItem()

Send next item; may be used for the first item or when a delay has elapsed.

createPacket

CanMessage createPacket(String s)

Create a well-formed message from a String String is expected to be space seperated hex bytes or CbusAddress, e.g.: 12 34 56 +n4e1

Parameters:

s - string of spaced hex byte codes

Returns:

The packet, with contents filled-in

message

public void message(CanMessage m)

Don't pay attention to messages

Specified by:

message in interface CanListener

Parameters:

m - the CanMessage being sent.

reply

public void reply(CanReply m)

Don't pay attention to replies

Specified by:

reply in interface CanListener

Parameters:

m - the CanReply being received.

dispose

public void dispose()

When the window closes, stop any sequences running

Overrides:

dispose in class JmriPanel