cern::laser::console::CommentedAlarm Class Reference

Inheritance diagram for cern::laser::console::CommentedAlarm:
Inheritance graph
[legend]
Collaboration diagram for cern::laser::console::CommentedAlarm:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CommentedAlarm ()
 CommentedAlarm (cern.laser.client.data.Alarm alarm, Comment comment)
cern.laser.client.data.Alarm getAlarm ()
void setAlarm (cern.laser.client.data.Alarm newAlarm)
Comment getComment ()
void setComment (Comment newComment)
String toString ()
Object clone ()

Private Attributes

cern.laser.client.data.Alarm alarm
Comment comment

Detailed Description

A generic commented alarm.

Author:
F.Calderini
See also:
cern.laser.console.CommentedAlarmMap
cern.laser.console.Comment

Constructor & Destructor Documentation

cern::laser::console::CommentedAlarm::CommentedAlarm (  )  [inline]

Default constructor.

References alarm, and comment.

cern::laser::console::CommentedAlarm::CommentedAlarm ( cern.laser.client.data.Alarm  alarm,
Comment  comment 
) [inline]

Constructor.

Parameters:
alarm the alarm
comment the alarm comment

References alarm.

Member Function Documentation

Object cern::laser::console::CommentedAlarm::clone (  )  [inline]

References alarm, cern::laser::console::Comment::clone(), comment, setAlarm(), and setComment().

Referenced by cern::laser::guiplatform::alarms::AlarmBean::clone(), and cern::laser::console::TestCommentedAlarm::TestCommentedAlarm().

cern.laser.client.data.Alarm cern::laser::console::CommentedAlarm::getAlarm (  )  [inline]

Accessor method.

Returns:
the alarm

References alarm.

Referenced by cern::laser::console::impl::ConfigurationImpl::buildCommentedAlarmCollection(), cern::laser::guiplatform::alarms::AlarmContainer::clearAutoHighlightedList(), cern::laser::guiplatform::alarms::AlarmContainer::clearInhibitList(), cern::laser::guiplatform::alarms::AlarmContainer::clearMaskList(), cern::laser::guiplatform::actions::alarms::ShowHelpUrlInBrowserAction::enable(), cern::laser::guiplatform::alarms::AlarmBean::getAlarmId(), cern::laser::guiplatform::alarms::AlarmBean::getCategories(), cern::laser::guiplatform::alarms::AlarmBean::getDynamicInfo(), cern::laser::guiplatform::alarms::AlarmBean::getFaultCode(), cern::laser::guiplatform::alarms::AlarmBean::getFaultFamily(), cern::laser::guiplatform::alarms::AlarmBean::getFaultMember(), cern::laser::guiplatform::alarms::AlarmBean::getIdentifier(), cern::laser::guiplatform::alarms::AlarmBean::getLocation(), cern::laser::guiplatform::alarms::InfoAlarmBean::getName(), cern::laser::guiplatform::alarms::AlarmBean::getName(), cern::laser::guiplatform::alarms::AlarmBean::getNodeActions(), cern::laser::guiplatform::alarms::AlarmBean::getPrefix(), cern::laser::guiplatform::alarms::AlarmBean::getPriority(), cern::laser::guiplatform::alarms::AlarmBean::getProblemDescription(), cern::laser::guiplatform::alarms::AlarmBean::getResponsiblePerson(), cern::laser::guiplatform::alarms::AlarmBean::getSource(), cern::laser::guiplatform::alarms::AlarmBean::getSourceHostName(), cern::laser::guiplatform::alarms::AlarmBean::getSourceName(), cern::laser::guiplatform::alarms::AlarmBean::getSourceTimestamp(), cern::laser::guiplatform::alarms::AlarmBean::getStaticInfo(), cern::laser::guiplatform::alarms::AlarmBean::getSuffix(), cern::laser::guiplatform::alarms::AlarmBean::getSystemName(), cern::laser::guiplatform::alarms::AlarmBean::getTimestamp(), cern::laser::guiplatform::alarms::AlarmBean::getTimestampForSorting(), cern::laser::guiplatform::alarms::AlarmBean::getTimestamps(), cern::laser::guiplatform::alarms::AlarmBean::getUserData(), cern::laser::guiplatform::alarms::AlarmBean::getUserTimestamp(), cern::laser::guiplatform::alarms::AlarmBean::hashCode(), cern::laser::guiplatform::alarms::AlarmContainer::inhibit(), cern::laser::guiplatform::alarms::AlarmContainer::initContainer(), cern::laser::guiplatform::alarms::InfoAlarmBean::isActive(), cern::laser::guiplatform::alarms::AlarmBean::isActive(), cern::laser::guiplatform::alarms::AlarmBean::isMasked(), cern::laser::guiplatform::alarms::AlarmBean::isMultiplicityChild(), cern::laser::guiplatform::alarms::AlarmBean::isMultiplicityParent(), cern::laser::guiplatform::alarms::AlarmBean::isNodeChild(), cern::laser::guiplatform::alarms::AlarmBean::isNodeParent(), cern::laser::guiplatform::alarms::AlarmBean::isNodeReduced(), cern::laser::guiplatform::alarms::AlarmBean::isReduced(), cern::laser::guiplatform::alarms::AlarmContainer::mask(), cern::laser::guiplatform::alarms::AlarmBean::prepareIcon(), cern::laser::console::CommentedAlarmMap::put(), cern::laser::console::CommentedAlarmMap::putAll(), cern::laser::guiplatform::alarms::AlarmContainer::reloadContainer(), cern::laser::guiplatform::alarms::AlarmContainer::removeNewOrTerminatedAlarms(), cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration(), cern::laser::guiplatform::alarms::AlarmContainer::unhighlightAndKlaxon(), and cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmMaskedOnList().

Comment cern::laser::console::CommentedAlarm::getComment (  )  [inline]

Accessor method.

Returns:
the alarm comment

References comment.

Referenced by cern::laser::console::impl::ConfigurationImpl::buildCommentedAlarmCollection().

void cern::laser::console::CommentedAlarm::setAlarm ( cern.laser.client.data.Alarm  newAlarm  )  [inline]

Accessor method.

Parameters:
newAlarm the alarm

References alarm.

Referenced by clone(), cern::laser::guiplatform::alarms::AlarmContainer::uninhibit(), cern::laser::guiplatform::alarms::AlarmContainer::unmask(), cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmOnActiveList(), and cern::laser::guiplatform::alarms::AlarmContainer::updateAlarmOnInstantList().

void cern::laser::console::CommentedAlarm::setComment ( Comment  newComment  )  [inline]

Accessor method.

Parameters:
newComment the alarm comment

References comment.

Referenced by cern::laser::guiplatform::alarms::AlarmContainer::acknowledge(), clone(), cern::laser::guiplatform::alarms::AlarmContainer::highlightAndKlaxon(), cern::laser::guiplatform::alarms::AlarmContainer::inhibit(), and cern::laser::guiplatform::alarms::AlarmContainer::mask().

String cern::laser::console::CommentedAlarm::toString (  )  [inline]

Returns a string representation.

Returns:
a string representation.

References alarm, comment, and cern::laser::console::Comment::toString().

Member Data Documentation

cern.laser.client.data.Alarm cern::laser::console::CommentedAlarm::alarm [private]

Referenced by clone(), CommentedAlarm(), getAlarm(), setAlarm(), and toString().

Comment cern::laser::console::CommentedAlarm::comment [private]

Referenced by clone(), CommentedAlarm(), getComment(), setComment(), and toString().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2