alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer Class Reference

Inheritance diagram for alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer:

Collaboration diagram for alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer:

Public Member Functions
	AlarmsReductionContainer (int max)
synchronized int	size (boolean reduced)
synchronized void	add (AlarmTableEntry entry) throws AlarmContainerException
void	setCategoryClient (CategoryClient client)
synchronized AlarmTableEntry	get (int pos, boolean reduced)
synchronized void	clear ()
synchronized void	remove (AlarmTableEntry alarm) throws AlarmContainerException
synchronized AlarmTableEntry	removeOldest () throws AlarmContainerException
synchronized void	replace (AlarmTableEntry newAlarm) throws AlarmContainerException
CategoryClient	getCategoryClient ()
synchronized int	hasNotAckAlarms (boolean reduced)
Private Member Functions
void	addAlarm (AlarmTableEntry alarm)
void	hideReducedChildren (AlarmTableEntry entry)
void	showActiveChildren (AlarmTableEntry alarm, int pos)
Private Attributes
final Vector< String >	indexWithReduction = new Vector<String>()
CategoryClient	categoryClient = null

Detailed Description

Extends AlarmsContainer for the reduced alarms.

Author:: acaproni

Constructor & Destructor Documentation

alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::AlarmsReductionContainer ( int max ) [inline]

Constructor

Parameters:

max

See also:: AlarmsContainer

Member Function Documentation

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::add ( AlarmTableEntry entry ) throws AlarmContainerException [inline]

Add an entry (i.e a alarm) in the collection.

If there is no room available in the container, an exception is thrown: checking if there is enough room must be done by the caller.

Parameters:

entry The not null entry to add

Exceptions:

{@link

AlarmContainerException} If the entry is already in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

References addAlarm().

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::addAlarm(), alma::acs::alarm::test::panel::AlarmContainerTest::populateContainer(), and alma::acs::alarm::test::panel::AlarmContainerTest::testContainerSize().

void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::addAlarm ( AlarmTableEntry alarm ) [inline, private]

Add an alarm to the reduction container

Parameters:

alarm

The alarm to add to the container

References alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAlarmId(), alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getStatus(), hideReducedChildren(), indexWithReduction, and cern::laser::client::data::Status::isReduced().

Referenced by add(), and replace().

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::clear ( ) [inline]

Remove all the elements in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

References indexWithReduction.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::clear(), alma::acs::alarm::test::panel::AlarmContainerTest::tearDown(), alma::acs::alarm::test::panel::AlarmContainerTest::testContainerSize(), and alma::acs::alarm::test::panel::AlarmContainerTest::testRemoveInactivAls().

synchronized AlarmTableEntry alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::get	(	int	pos,
		boolean	reduced
	)			`[inline]`

Return the entry in the given position

Parameters:

	pos	The position of the alarm in the container
	reduced	`true` if the alarms in the table are reduced

Returns:: The AlarmTableEntry in the given position

References indexWithReduction.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::alarmSelected(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getAlarmAt(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getRowEntry(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::isRowAlarmNew(), alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::replaceAlarm(), and alma::acs::alarm::test::panel::AlarmContainerTest::testReplaceAlarm().

CategoryClient alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::getCategoryClient ( ) [inline]

Returns:: the categoryClient

References categoryClient.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::getCategoryClient().

synchronized int alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hasNotAckAlarms ( boolean reduced ) [inline]

Check if the container has alarm not yet acknowledged.

if there are active alarms to be acknowledged by the user, this method returns the highest of their priorities. Note that for alarm system the highest priority is 0.

Returns:: -1 if there are not alarm to acknowledge; the highest priority of the alarm to acknowledge

See also:: AlarmContainer::hasNotAckAlarms()

References alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getPriority(), alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getStatus(), indexWithReduction, cern::laser::client::data::Status::isActive(), and alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNew.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::hasNotAckAlarms().

void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::hideReducedChildren ( AlarmTableEntry entry ) [inline, private]

Hide the active alarms of this entry.

Parameters:

entry The not null entry to hide active children

References categoryClient, alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAlarmId(), alma::alarmsystem::clients::CategoryClient::getChildren(), indexWithReduction, alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isMultiplicityParent(), and alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::isNodeParent().

Referenced by addAlarm(), and replace().

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::remove ( AlarmTableEntry alarm ) throws AlarmContainerException [inline]

Remove the entry for the passed alarm

Parameters:

alarm

The alarm whose entry must be removed

Exceptions:

AlarmContainerException

If the alarm is not in the container

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

References indexWithReduction.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::acknowledge(), and alma::acs::alarm::test::panel::AlarmContainerTest::testAlarmsRemove().

synchronized AlarmTableEntry alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::removeOldest ( ) throws AlarmContainerException [inline]

Remove the oldest entry in the container

Returns:: The removed item

Exceptions:

AlarmContainerException

If the container is empty

Reimplemented from alma::acsplugins::alarmsystem::gui::table::AlarmsContainer.

References alma::acsplugins::alarmsystem::gui::table::AlarmTableEntry::getAlarmId(), and indexWithReduction.

Referenced by alma::acsplugins::alarmsystem::gui::table::AlarmTableModel::run(), and alma::acs::alarm::test::panel::AlarmContainerTest::testRemoveOldest().

synchronized void alma::acsplugins::alarmsystem::gui::table::AlarmsReductionContainer::replace ( AlarmTableEntry newAlarm ) throws AlarmContainerException [inline]