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

Class GeneralGUI

java.lang.Object

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

All Implemented Interfaces:

Serializable, org.lsst.ccs.messaging.AgentPresenceListener, org.lsst.ccs.messaging.MessageListener, org.lsst.ccs.messaging.StatusMessageListener

Direct Known Subclasses:

AutochangerGUI, CarouselGUI, FcsGUI, LoaderGUI

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

This class gathers the common stuff for all FCS GUIs.

Author:

virieux

See Also:

Serialized Form

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 org.lsst.ccs.messaging.ConcurrentMessagingUtils	cmu
protected String	destination
protected GeneralPanel	generalPanel
long	initializationTimeout
JScrollPane	pane
protected boolean	panelStateInitialized
protected String	role
long	updateStateWithSensorsTimeout

Constructor Summary

Constructors

Constructor and Description
GeneralGUI(String name, String role, org.lsst.ccs.messaging.AgentMessagingLayer aml) Contructor of a GeneralGUI with a name, a subsystem name (destination, and an AgentMessagingLayer.

Method Summary

Modifier and Type	Method and Description
void	abortAction()
void	connected(org.lsst.ccs.bus.data.AgentInfo... agents)
void	disconnected(org.lsst.ccs.bus.data.AgentInfo... agents)
List<String>	getAcSensorsNamesList() Sends a command to retrieve the list of sensors connected to acPlutoGateway.
JComponent	getGuiLayout()
List<String>	getLoSensorsNamesList() Sends a command to retrieve the list of sensors connected to loader PLutoGateway.
String	getName()
void	initGui() Initialize GUI
void	onStatusMessage(org.lsst.ccs.bus.messages.StatusMessage s) To update the Subsystem state panel only when the subsytem state has changed.
void	sendCommand(String commandName, long timeout) send a command to my subsystem with a timeout
void	sendCommand(String commandName, long timeout, String componentName) send a command to my subsystem with a timeout and the name of a component of my subsystem
void	sendCommandSwingWorker(String commandName, long timeout)
void	sendCommandSwingWorker(String commandName, long timeout, String moduleName)
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.AgentPresenceListener

connecting, disconnecting

Field Detail

destination

protected String destination

role

protected final String role

generalPanel

protected GeneralPanel generalPanel

panelStateInitialized

protected boolean panelStateInitialized

pane

public JScrollPane pane

abortTimeout

public long abortTimeout

updateStateWithSensorsTimeout

public long updateStateWithSensorsTimeout

aml

protected transient org.lsst.ccs.messaging.AgentMessagingLayer aml

cmu

protected final transient org.lsst.ccs.messaging.ConcurrentMessagingUtils cmu

initializationTimeout

public long initializationTimeout

Constructor Detail

GeneralGUI

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

Contructor of a GeneralGUI with a name, a subsystem name (destination, and an AgentMessagingLayer.

Parameters:

name -

role -

aml -

Method Detail

sendCommand

public void sendCommand(String commandName,
                        long timeout)

send a command to my subsystem with a timeout

Parameters:

commandName -

timeout -

sendCommand

public void sendCommand(String commandName,
                        long timeout,
                        String componentName)

send a command to my subsystem with a timeout and the name of a component of my subsystem

Parameters:

commandName -

timeout -

componentName -

getName

public String getName()

initGui

public void initGui()

Initialize GUI

getGuiLayout

public JComponent getGuiLayout()

shutdownMyDestinationSubsystem

public void shutdownMyDestinationSubsystem()

abortAction

public void abortAction()

stopMyDestinationSubsystem

public void stopMyDestinationSubsystem()

updateStateWithSensors

public void updateStateWithSensors()

sendCommandSwingWorker

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

sendCommandSwingWorker

public void sendCommandSwingWorker(String commandName,
                                   long timeout)

onStatusMessage

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

To update the Subsystem state panel only when the subsytem state has changed.

Specified by:

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

Parameters:

s -

connected

public void connected(org.lsst.ccs.bus.data.AgentInfo... agents)

Specified by:

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

getAcSensorsNamesList

public List<String> getAcSensorsNamesList()

Sends a command to retrieve the list of sensors connected to acPlutoGateway. It sends a command to the worker subsystem.

Returns:

a list of sensors names

getLoSensorsNamesList

public List<String> getLoSensorsNamesList()

Sends a command to retrieve the list of sensors connected to loader PLutoGateway. It sends a command to the worker subsystem.

Returns:

a list of sensors names

disconnected

public void disconnected(org.lsst.ccs.bus.data.AgentInfo... agents)

Specified by:

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