cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent Class Reference

Collaboration diagram for cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent:

[legend]

List of all members.

Public Member Functions
	DisplayableChangeEvent (String name)
	DisplayableChangeEvent (String name, Integer privateIdent, boolean isActive, String faultFamily, String faultMember, int faultCode)
String	getName ()
String	getDisplayName ()
Integer	getPrivateIdentifier ()
int	getPriority ()
void	setPriority (int priority)
Collection	getCategories ()
String	getResponsiblePerson ()
String	getLocation ()
String	getProblemDescription ()
String	getSource ()
String	getFaultFamily ()
String	getFaultMember ()
int	getFaultCode ()
long	getTimestamp ()
long	getSourceTimestamp ()
String	getSourceHostName ()
String	getUserData ()
boolean	isActive ()
boolean	isMasked ()
boolean	isNodeChild ()
boolean	isNodeParent ()
boolean	isNodeReduced ()
boolean	isMultiplicityReduced ()
boolean	isMultiplicityParent ()
boolean	isMultiplicityChild ()
boolean	isMaintenanceMasked ()
boolean	isModeMasked ()
boolean	isReduced ()
String	toShortString ()
String	toString ()
Object	clone () throws CloneNotSupportedException
Public Attributes
int	priority = -1
Private Attributes
String	name = null
Integer	privateIdent = null
boolean	isActive = true
String	faultFamily = null
String	faultMember = null
int	faultCode = -1
boolean	isMasked = false

---

Detailed Description

This is test class. In final version should be replaced by cern.laser.business.alarm.data.DisplayableChangeEvent;

Adapter class wrapping DisplayableChangeEvent. Follows the JavaBeans specifications. Actual properties are all the one contained in the StaticInfo, DynamicInfo & StatusInfo classes

should not be used

Author:

claustre

---

Constructor & Destructor Documentation

cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::DisplayableChangeEvent

(

String

name

)

[inline]

Creates new DisplayableChangeEventAdapter from an AlarmDisplayableChangeEvent Creates new empty DisplayableChangeEventAdapter Should be removed as soon as the tests will be done with an external alarm generator. In this case, the Dummy bean creted in CustomiseFields class should use the other constructor: DisplayableChangeEventAdapter(null).

WARNING: this constructor should not be used

cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::DisplayableChangeEvent	(	String	name,
		Integer	privateIdent,
		boolean	isActive,
		String	faultFamily,
		String	faultMember,
		int	faultCode
	)			[inline]

---

Member Function Documentation

Object cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::clone

(

)

throws CloneNotSupportedException [inline]

Return the object hashcode

Returns:

the object hashcode

Collection cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getCategories

(

)

[inline]

getter for the categories to which the alarm belongs

Returns:

a collection containing the names of the categories to which dsplyChngEvt. alarm belongs

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getDisplayName

(

)

[inline]

At the moment, the field chosen to be the "Display Name of an Alarm" is the problem description

Returns:

DisplayName

int cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getFaultCode

(

)

[inline]

getter for the fault code

Returns:

the "fault code" of the alarm (as defined in the LEP alarm system)

References faultCode.

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getFaultFamily

(

)

[inline]

getter for the fault family

Returns:

the "fault family" of the alarm (as defined in the LEP alarm system)

References faultFamily.

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getFaultMember

(

)

[inline]

getter for the fault Member

Returns:

the "fault member" of the alarm (as defined in the LEP alarm system)

References faultMember.

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getLocation

(

)

[inline]

getter for the location of the equipment

Returns:

the location of the equipment

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getName

(

)

[inline]

The private identifier is the name of the node

Returns:

Name

References name.

int cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getPriority

(

)

[inline]

References priority.

Integer cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getPrivateIdentifier

(

)

[inline]

Returns:

the private identifier as an int

References privateIdent.

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getProblemDescription

(

)

[inline]

getter for the problem description

Returns:

the description of the problem from static info

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getResponsiblePerson

(

)

[inline]

getter for the responsible person for this equipement

Returns:

the name of the repsonsible person from the static info

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getSource

(

)

[inline]

getter for the alarm source

Returns:

the alarm source from static info

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getSourceHostName

(

)

[inline]

Returns:

source name from the DynamicInfo class

long cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getSourceTimestamp

(

)

[inline]

Returns:

SourceTimestamp from the DynamicInfo class

long cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getTimestamp

(

)

[inline]

Returns:

Timestamp from the DynamicInfo class

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::getUserData

(

)

[inline]

Returns:

UserData from the DynamicInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isActive

(

)

[inline]

Returns:

isActive field from the StatusInfo class

Referenced by toString().

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMaintenanceMasked

(

)

[inline]

Returns:

isMaintenanceMasked field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMasked

(

)

[inline]

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isModeMasked

(

)

[inline]

Returns:

isModeMasked field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMultiplicityChild

(

)

[inline]

Returns:

isMultiplicityChild field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMultiplicityParent

(

)

[inline]

Returns:

isMultiplicityParent field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMultiplicityReduced

(

)

[inline]

Returns:

isMultiplicityReduced field from the StatusInfo class

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isNodeChild

(

)

[inline]

Tests if the alarm is a node child

Returns:

boolean

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isNodeParent

(

)

[inline]

Tests if the alarm is a node parent

Returns:

boolean

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isNodeReduced

(

)

[inline]

Tests if a node reduction is applied on this alarm

Returns:

boolean

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isReduced

(

)

[inline]

Returns:

isReduced field from the StatusInfo class

void cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::setPriority

(

int

priority

)

[inline]

this is method only for testing

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::toShortString

(

)

[inline]

Checks for equality

Returns:

boolean: 1 if the object is equal, 0 else

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::toString

(

)

[inline]

References faultCode, faultFamily, faultMember, isActive(), name, and privateIdent.

---

Member Data Documentation

int cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::faultCode = -1 [private]

Referenced by getFaultCode(), and toString().

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::faultFamily = null [private]

Referenced by getFaultFamily(), and toString().

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::faultMember = null [private]

Referenced by getFaultMember(), and toString().

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isActive = true [private]

boolean cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::isMasked = false [private]

Returns:

isMasked field from the StatusInfo class

String cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::name = null [private]

will have to be private. But at the moment, it must be public to set internaly some parameters (no set function must be written to make the fields not editable)

Referenced by getName(), and toString().

int cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::priority = -1

getter for the priority of the alarm

Returns:

the priority of the alarm

Referenced by getPriority().

Integer cern::laser::guiplatform::alarms::helpers::DisplayableChangeEvent::privateIdent = null [private]

Referenced by getPrivateIdentifier(), and toString().

---

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

• DisplayableChangeEvent.java