alma::acsplugins::alarmsystem::gui::CernSysPanel Class Reference

Inheritance diagram for alma::acsplugins::alarmsystem::gui::CernSysPanel:

Collaboration diagram for alma::acsplugins::alarmsystem::gui::CernSysPanel:

Public Member Functions
	CernSysPanel (AlarmPanel owner, AlSysNotAvailPanel notAvaiPnl)
void	close ()
void	pause () throws Exception
void	resume () throws Exception
void	showMessage (String mesg, boolean red)
void	showAlarmDetails (Alarm alarm)
synchronized void	addSpecialAlarm (Alarm alarm) throws Exception
void	setModel (AlarmTableModel model)
void	connect ()
void	disconnect ()
boolean	isConnecting ()
void	setContainerServices (ContainerServices cs)
void	start () throws Exception
void	stop () throws Exception
Public Attributes
final boolean	ACTIVATE_RDUCTION_RULES = true
Private Member Functions
void	initialize ()
Private Attributes
Toolbar	toolbar
StatusLine	statusLine
AlarmTableModel	model
AlarmTable	alarmTable
AlarmDetailTable	detailTable
AlarmSound	alarmSound
JScrollPane	tableScrollPane
JScrollPane	detailsScrollPane
JSplitPane	splitPane
final AlarmPanel	alarmPanel
volatile boolean	connecting = false
volatile boolean	closed = false
ConnectionListener	connectionListener
Thread	connectThread
Thread	disconnectThread
CategoryClient	categoryClient = null
ContainerServices	contSvc = null
final AlSysNotAvailPanel	notAvaiPnl

Detailed Description

The panel shown while the CERN AS is in use and the alarm client is connected.

Author:: acaproni

Constructor & Destructor Documentation

alma::acsplugins::alarmsystem::gui::CernSysPanel::CernSysPanel	(	AlarmPanel	owner,
		AlSysNotAvailPanel	notAvaiPnl
	)			`[inline]`

Constructor

Parameters:

owner

The panel showing this container

References alarmPanel, and initialize().

Member Function Documentation

synchronized void alma::acsplugins::alarmsystem::gui::CernSysPanel::addSpecialAlarm ( Alarm alarm ) throws Exception [inline]

A method to send alarms to the GUI outside of the alarm service.

At the present it is used by the OMC GUI to send alarms before the alarm service is started.

Deprecated:: this method will be deleted when the alarm system will run as a daemon or as an ACS service.

Parameters:

alarm The alarm to show in the table (can't be null)

Exceptions:

Exception

In case the alarm is not well formed

References model, and alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::onAlarm().

Referenced by alma::acsplugins::alarmsystem::gui::AlarmPanel::addSpecialAlarm().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::close ( ) [inline]

Closes the panel

References alarmSound, alarmTable, alma::acsplugins::alarmsystem::gui::table::AlarmTable::close(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::close(), alma::acsplugins::alarmsystem::gui::sound::AlarmSound::close(), and model.

Referenced by stop().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::connect ( ) [inline]

Connect

Try to connect to the alarm service until it becomes available

References alma::acsplugins::alarmsystem::gui::AlSysNotAvailPanel::addMessage(), alarmPanel, categoryClient, closed, alma::alarmsystem::clients::CategoryClient::connect(), alma::acsplugins::alarmsystem::gui::ConnectionListener::connected(), alma::acsplugins::alarmsystem::gui::ConnectionListener::connecting(), connecting, connectionListener, contSvc, alma::acsplugins::alarmsystem::gui::ConnectionListener::disconnected(), model, notAvaiPnl, alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::setCategoryClient(), alma::acsplugins::alarmsystem::gui::AlarmPanel::showPanel(), alma::acsplugins::alarmsystem::gui::statusline::StatusLine::start(), and statusLine.

Referenced by alma::acsplugins::alarmsystem::gui::statusline::ConnectionWidget::actionPerformed().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::disconnect ( ) [inline]

Disconnect

References categoryClient, alma::alarmsystem::clients::CategoryClient::close(), connectionListener, connectThread, alma::acsplugins::alarmsystem::gui::ConnectionListener::disconnected(), model, alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::setCategoryClient(), statusLine, and alma::acsplugins::alarmsystem::gui::statusline::StatusLine::stop().

Referenced by alma::acsplugins::alarmsystem::gui::statusline::ConnectionWidget::actionPerformed().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::initialize ( ) [inline, private]

Init the GUI

References ACTIVATE_RDUCTION_RULES, alarmSound, alarmTable, connectionListener, detailsScrollPane, detailTable, model, alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::setConnectionListener(), splitPane, statusLine, tableScrollPane, and toolbar.

Referenced by CernSysPanel().

boolean alma::acsplugins::alarmsystem::gui::CernSysPanel::isConnecting ( ) [inline]

Returns:: true if an attempt to connect is running

References connecting.

Referenced by alma::acsplugins::alarmsystem::gui::AlarmPanel::isConnecting(), and alma::acsplugins::alarmsystem::gui::statusline::ConnectionWidget::StatusLineMouseAdapter::showPopup().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::pause ( ) throws Exception [inline]

See also:: IpauseResume

References model, alma::acsplugins::alarmsystem::gui::statusline::StatusLine::pause(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::pause(), statusLine, toolbar, and alma::acsplugins::alarmsystem::gui::toolbar::Toolbar::updatePauseBtn().

Referenced by alma::acsplugins::alarmsystem::gui::toolbar::Toolbar::actionPerformed(), and alma::acsplugins::alarmsystem::gui::AlarmPanel::pause().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::resume ( ) throws Exception [inline]

See also:: IPauseResume

References model, alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::pause(), alma::acsplugins::alarmsystem::gui::statusline::StatusLine::resume(), statusLine, toolbar, and alma::acsplugins::alarmsystem::gui::toolbar::Toolbar::updatePauseBtn().

Referenced by alma::acsplugins::alarmsystem::gui::toolbar::Toolbar::actionPerformed(), and alma::acsplugins::alarmsystem::gui::AlarmPanel::resume().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::setContainerServices ( ContainerServices cs ) [inline]

Set the ContainerServices

References contSvc.

Referenced by alma::acsplugins::alarmsystem::gui::AlarmPanel::setACSContainerServices(), and alma::acsplugins::alarmsystem::gui::AlarmPanel::setServices().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::setModel ( AlarmTableModel model ) [inline]

void alma::acsplugins::alarmsystem::gui::CernSysPanel::showAlarmDetails ( Alarm alarm ) [inline]

Show the alarm in the details table

Parameters:

alarm The alarm to show in the details panel; if null the details table is cleared.

References detailTable, and alma::acsplugins::alarmsystem::gui::detail::AlarmDetailTable::showAlarmDetails().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTable::changeSelection(), and alma::acsplugins::alarmsystem::gui::AlarmPanel::showAlarmDetails().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::showMessage	(	String	mesg,
		boolean	red
	)			`[inline]`

Show a message in the status line

Parameters:

	mesg
	red

See also:: StatusLine

References alma::acsplugins::alarmsystem::gui::statusline::StatusLine::showMessage(), and statusLine.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTable::search(), and alma::acsplugins::alarmsystem::gui::AlarmPanel::showMessage().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::start ( ) throws Exception [inline]

Connect the Client and listens to the categories.

The CategoryClient is built only if its reference is null. Otherwise it means that the client is still trying to connect and the user restarted the plugin.

See also:: SubsystemPlugin

References categoryClient, closed, connectThread, and contSvc.

Referenced by alma::acsplugins::alarmsystem::gui::AlarmPanel::start().

void alma::acsplugins::alarmsystem::gui::CernSysPanel::stop ( ) throws Exception [inline]

See also:: SubsystemPlugin

References close(), closed, and disconnectThread.

Referenced by alma::acsplugins::alarmsystem::gui::AlarmPanel::stop().

Member Data Documentation

final boolean alma::acsplugins::alarmsystem::gui::CernSysPanel::ACTIVATE_RDUCTION_RULES = true

The startup option for reduction rules

Referenced by initialize().

final AlarmPanel alma::acsplugins::alarmsystem::gui::CernSysPanel::alarmPanel [private]

The panel showing this container

Referenced by CernSysPanel(), and connect().

AlarmSound alma::acsplugins::alarmsystem::gui::CernSysPanel::alarmSound [private]

The object to play sounds for alarms

Referenced by close(), and initialize().

AlarmTable alma::acsplugins::alarmsystem::gui::CernSysPanel::alarmTable [private]

The table of alarms

Referenced by close(), and initialize().

CategoryClient alma::acsplugins::alarmsystem::gui::CernSysPanel::categoryClient = null [private]

The client to listen alarms from categories

Referenced by connect(), disconnect(), and start().

volatile boolean alma::acsplugins::alarmsystem::gui::CernSysPanel::closed = false [private]

true if the panel has been closed. It helps stopping the connection thread

Referenced by connect(), start(), and stop().

volatile boolean alma::acsplugins::alarmsystem::gui::CernSysPanel::connecting = false [private]

Say if there is an attempt to connect

Referenced by connect(), and isConnecting().

ConnectionListener alma::acsplugins::alarmsystem::gui::CernSysPanel::connectionListener [private]

The listener of the connection

Referenced by connect(), disconnect(), and initialize().

Thread alma::acsplugins::alarmsystem::gui::CernSysPanel::connectThread [private]

The thread to connect/disconnect

Referenced by disconnect(), and start().

ContainerServices alma::acsplugins::alarmsystem::gui::CernSysPanel::contSvc = null [private]

The container services

Referenced by connect(), setContainerServices(), and start().

JScrollPane alma::acsplugins::alarmsystem::gui::CernSysPanel::detailsScrollPane [private]

Initial value:

 new JScrollPane(
                        JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
                        JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED)

The scroll pane of the details table

Referenced by initialize().

AlarmDetailTable alma::acsplugins::alarmsystem::gui::CernSysPanel::detailTable [private]

The table with the details of an alarm

Referenced by initialize(), and showAlarmDetails().

Thread alma::acsplugins::alarmsystem::gui::CernSysPanel::disconnectThread [private]

Signal the thread to terminate

Referenced by stop().

AlarmTableModel alma::acsplugins::alarmsystem::gui::CernSysPanel::model [private]

The model of the table of alarms

Referenced by addSpecialAlarm(), close(), connect(), disconnect(), initialize(), pause(), and resume().

final AlSysNotAvailPanel alma::acsplugins::alarmsystem::gui::CernSysPanel::notAvaiPnl [private]

The panel to show messages while connecting

Referenced by connect().

JSplitPane alma::acsplugins::alarmsystem::gui::CernSysPanel::splitPane [private]

The split pane dividing the table of alarms and the detail view

Referenced by initialize().

StatusLine alma::acsplugins::alarmsystem::gui::CernSysPanel::statusLine [private]

The status line

Referenced by connect(), disconnect(), initialize(), pause(), resume(), and showMessage().

JScrollPane alma::acsplugins::alarmsystem::gui::CernSysPanel::tableScrollPane [private]

Initial value:

 new JScrollPane(
                        JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
                        JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED)

The scroll pane of the table

Referenced by initialize().

Toolbar alma::acsplugins::alarmsystem::gui::CernSysPanel::toolbar [private]

The toolbar

Referenced by initialize(), pause(), and resume().

The documentation for this class was generated from the following file:

CernSysPanel.java

alma::acsplugins::alarmsystem::gui::CernSysPanel Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation