org.lsst.ccs.subsystems.fcs.ui.commons

Class GeneralGUI

java.lang.Object

org.lsst.ccs.subsystems.fcs.ui.commons.GeneralGUI

All Implemented Interfaces:

org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.DataStatusListener, org.lsst.ccs.messaging.EncodedStatusListens, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener

Direct Known Subclasses:

AutochangerGeneralGUI, CarouselGUI, LoaderGUI

public abstract class GeneralGUI
extends Object
implements org.lsst.ccs.messaging.DataStatusListener, org.lsst.ccs.messaging.StatusMessageListener, org.lsst.ccs.messaging.AgentPresenceListener

This class gathers the common stuff for all FCS GUIs.

Author:

virieux

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GeneralGUI.CommandSwingWorker To send command which takes time from a JButton.

Field Summary

Fields

Modifier and Type	Field and Description
long	abortTimeout
protected org.lsst.ccs.messaging.AgentMessagingLayer	aml
protected String	destination
protected static org.lsst.ccs.utilities.logging.Logger	fcslog
long	initializationTimeout
protected boolean	initialized
protected PrintWriter	out
JScrollPane	pane
protected boolean	panelStateInitialized
protected TopPanel	topPanel
long	updateStateWithSensorsTimeout

Constructor Summary

Constructors

Constructor and Description
GeneralGUI(String name, String destination, org.lsst.ccs.messaging.AgentMessagingLayer aml)

Method Summary

Modifier and Type	Method and Description
void	abortAction()
void	completeInitialization()
void	connecting(org.lsst.ccs.bus.messages.AgentInfo agent)
void	disconnecting(org.lsst.ccs.bus.messages.AgentInfo agent)
JComponent	getGuiLayout()
String	getName()
void	initGui()
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage s)
void	postInitGui() This method can be called in the initialization methods of the FCS GUI.
void	resetGui()
void	sendAsynchronousCommand(org.lsst.ccs.bus.messages.CommandRequest cmd)
Object	sendCommand(org.lsst.ccs.bus.messages.CommandRequest cmd, long timeout)
void	sendCommandSwingWorker(String commandName, long timeout)
void	sendCommandSwingWorker(String commandName, long timeout, String moduleName)
void	setPrintWriter(PrintWriter out)
void	shutdownMyDestinationSubsystem()
void	stopMyDestinationSubsystem()
void	updateStateWithSensors()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.messaging.DataStatusListener

onDataArrival

Field Detail

fcslog

protected static final org.lsst.ccs.utilities.logging.Logger fcslog

destination

protected final String destination

out

protected PrintWriter out

topPanel

protected TopPanel topPanel

initialized

protected boolean initialized

panelStateInitialized

protected boolean panelStateInitialized

pane

public JScrollPane pane

abortTimeout

public long abortTimeout

updateStateWithSensorsTimeout

public long updateStateWithSensorsTimeout

aml

protected org.lsst.ccs.messaging.AgentMessagingLayer aml

initializationTimeout

public long initializationTimeout

Constructor Detail

GeneralGUI

public GeneralGUI(String name,
                  String destination,
                  org.lsst.ccs.messaging.AgentMessagingLayer aml)

Method Detail

getName

public String getName()

initGui

public void initGui()

postInitGui

public void postInitGui()

This method can be called in the initialization methods of the FCS GUI. When the GUI starts after the subsystem, it's not initialized with the data coming from the sensors. This methods send the updateStateWithSensors command to the subsystem.

getGuiLayout

public JComponent getGuiLayout()

resetGui

public void resetGui()

shutdownMyDestinationSubsystem

public void shutdownMyDestinationSubsystem()

abortAction

public void abortAction()

stopMyDestinationSubsystem

public void stopMyDestinationSubsystem()

updateStateWithSensors

public void updateStateWithSensors()

completeInitialization

public void completeInitialization()

sendCommandSwingWorker

public void sendCommandSwingWorker(String commandName,
                                   long timeout,
                                   String moduleName)

sendCommandSwingWorker

public void sendCommandSwingWorker(String commandName,
                                   long timeout)

setPrintWriter

public void setPrintWriter(PrintWriter out)

sendAsynchronousCommand

public void sendAsynchronousCommand(org.lsst.ccs.bus.messages.CommandRequest cmd)

sendCommand

public Object sendCommand(org.lsst.ccs.bus.messages.CommandRequest cmd,
                          long timeout)

onStatusMessage

public void onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage s)

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.DataStatusListener

Specified by:

onStatusMessage in interface org.lsst.ccs.messaging.StatusMessageListener

connecting

public void connecting(org.lsst.ccs.bus.messages.AgentInfo agent)

Specified by:

connecting in interface org.lsst.ccs.messaging.AgentPresenceListener

disconnecting

public void disconnecting(org.lsst.ccs.bus.messages.AgentInfo agent)

Specified by:

disconnecting in interface org.lsst.ccs.messaging.AgentPresenceListener