ilog.tgo.model
Class IltAlarm.State

java.lang.Object
  ilog.tgo.model.IltState
      ilog.tgo.model.IltAlarmSystem.State
          ilog.tgo.model.IltAlarm.State

All Implemented Interfaces:

IltDecorationSource, IlWithProperties, Cloneable

Enclosing class:

IltAlarm

public static class IltAlarm.State
extends IltAlarmSystem.State

This class provides a representation model for the alarm state carried by a telecom object.

In this context:

• 'New alarm' refers to an 'unacknowledged alarm'.
• 'Outstanding alarms' refer to all alarms, whether acknowledged or not.
• 'Raw alarm' refers to the usual alarm as defined by the ITU-T Recommendation X.733.
• 'Impact alarm' refers to alarms not generated by the equipment, but rather induced by and deduced from specific conditions that occur in one or several other equipments, and that have an impact on the behavior of the former equipment.

For each known alarm severity, this model provides a counter of new alarms and a counter of acknowledged alarms.

It also stores two boolean statuses that modify the way the afore-mentionned counters are to be interpreted:

• lossOfConnectivity indicates that the connection with the telecom equipment has been interrupted. As a result, a number of alarms are in an unreliable state.
• notReporting indicates that the equipment is no longer sending out alarms or alarms are being ignored. As a result, a display not showing any alarms must not be taken into account.

The alarm counters can be automatically computed from the list of IltAlarms associated to the managed object, or directly updated by the back-end. For a given managed object, these modes are exclusive. The mode is controlled by the computedFromAlarmList property.

When the counters are automatically computed from the list of alarms:

• The updates of alarms in the back-end must be propagated to the corresponding IltAlarm objects.
• To prevent any discrepancies, direct modifications of the alarm counters are forbidden. If you attempt to use the corresponding APIs, IllegalStateExceptions are triggered.

Field Summary

protected boolean	computedFromAlarmList
protected boolean	counterModificationAllowed
protected static IlpFilter	ImpactSeverityFilter
static IltStateInfo	metainfo Contains metainformation about this IltState class.
protected static IlpFilter	RawSeverityFilter

Fields inherited from class ilog.tgo.model.IltAlarmSystem.State

_alarmValues, _notifier

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

IltAlarm.State()
Creates an IltAlarm.State with severity counters to zero and lossOfConnectivity and notReporting to false.

IltAlarm.State(ilog.tgo.model.internal.IltAggregateStateValue value)
Creates an alarm state based on a given state value.

IltAlarm.State(int newCriticalAlarmCount, int newMajorAlarmCount, int newMinorAlarmCount, int newWarningAlarmCount, int acknowledgedCriticalAlarmCount, int acknowledgedMajorAlarmCount, int acknowledgedMinorAlarmCount, int acknowledgedWarningAlarmCount, boolean lossOfConnectivity, boolean notReporting)
Deprecated. This constructor is obsolete, please use another constructor.

IltAlarm.State(int newCriticalAlarmCount, int newMajorAlarmCount, int newMinorAlarmCount, int newWarningAlarmCount, int newUnknownAlarmCount, int newClearedAlarmCount, int acknowledgedCriticalAlarmCount, int acknowledgedMajorAlarmCount, int acknowledgedMinorAlarmCount, int acknowledgedWarningAlarmCount, int acknowledgedUnknownAlarmCount, int acknowledgedClearedAlarmCount, boolean lossOfConnectivity, boolean notReporting)
Creates an IltAlarm.State with the given counts of new alarms and acknowledged alarms for each severity, as well as for the lossOfCconnectivity and notReporting statuses.

IltAlarm.State(int newCriticalAlarmCount, int newMajorAlarmCount, int newMinorAlarmCount, int newWarningAlarmCount, int newUnknownAlarmCount, int newClearedAlarmCount, int acknowledgedCriticalAlarmCount, int acknowledgedMajorAlarmCount, int acknowledgedMinorAlarmCount, int acknowledgedWarningAlarmCount, int acknowledgedUnknownAlarmCount, int acknowledgedClearedAlarmCount, int newCriticalHighImpactAlarmCount, int newCriticalLowImpactAlarmCount, int newMajorHighImpactAlarmCount, int newMajorLowImpactAlarmCount, int newMinorHighImpactAlarmCount, int newMinorLowImpactAlarmCount, int newWarningHighImpactAlarmCount, int newWarningLowImpactAlarmCount, int newUnknownImpactAlarmCount, int newClearedImpactAlarmCount, int acknowledgedCriticalHighImpactAlarmCount, int acknowledgedCriticalLowImpactAlarmCount, int acknowledgedMajorHighImpactAlarmCount, int acknowledgedMajorLowImpactAlarmCount, int acknowledgedMinorHighImpactAlarmCount, int acknowledgedMinorLowImpactAlarmCount, int acknowledgedWarningHighImpactAlarmCount, int acknowledgedWarningLowImpactAlarmCount, int acknowledgedUnknownImpactAlarmCount, int acknowledgedClearedImpactAlarmCount, boolean lossOfConnectivity, boolean notReporting)
Creates an IltAlarm.State with the given counts of new alarms and acknowledged alarms for each severity, as well as for the lossOfConnectivity and notReporting statuses.

Method Summary

void	acknowledgeAlarm(IltAlarmSeverity severity) Acknowledges an alarm of a given severity.
void	acknowledgeAllAlarms() Acknowledges all alarms, including raw and impact alarms.
void	acknowledgeAllAlarms(IltAlarmSeverity severity) Acknowledges all alarms of a given severity.
void	acknowledgeAllImpactAlarms() Acknowledges all impact alarms.
void	acknowledgeAllRawAlarms() Acknowledges all raw alarms.
void	addAcknowledgedAlarm(IltAlarmSeverity severity) Adds an acknowledged alarm of a given severity.
void	addNewAlarm(IltAlarmSeverity severity) Adds a new alarm of a given severity.
void	alarmAdded(IltAlarm alarm) An alarm was added to the list of alarms of the managed object.
void	alarmChanged(IltAlarm alarm, IlpAttribute attribute, Object oldValue) An alarm from the list of alarms of the managed object was changed.
void	alarmRemoved(IltAlarm alarm) An alarm was removed from the list of alarms of the managed object.
protected void	checkComputationState() Checks whether alarm counter modifications are legal or not.
Object	clone() Creates a copy of this object.
boolean	equals(Object obj) Compares this object with another object.
int	getAcknowledgedAlarmCount() Returns the number of acknowledged alarms, that are either raw or impact alarms, irrespective of their severity.
int	getAcknowledgedImpactAlarmCount() Returns the number of acknowledged impact alarms, irrespective of their severity.
int	getAcknowledgedRawAlarmCount() Returns the number of acknowledged raw alarms, irrespective of their severity.
int	getAlarmCount() Returns the count of all alarms, acknowledged or not, that are either raw or impact alarms, irrespective of their severity.
IltAlarmSystem	getAlarmSystem() System for which the values are being handled by this state.
IltAlarmSeverity	getHighestAcknowledgedAlarmSeverity() Returns the highest severity for which the number of acknowledged alarms is nonzero, including raw and impact alarms.
IltAlarmSeverity	getHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below for which the number of acknowledged alarms is nonzero, including raw and impact alarms.
IltAlarm.ImpactSeverity	getHighestAcknowledgedImpactAlarmSeverity() Returns the highest severity of impact alarm for which the number of acknowledged alarms is nonzero.
IltAlarm.ImpactSeverity	getHighestAcknowledgedImpactAlarmSeverity(IltAlarm.ImpactSeverity below) Returns the highest severity of impact alarm, less than below, and for which the number of acknowledged alarms is nonzero.
IltAlarm.Severity	getHighestAcknowledgedRawAlarmSeverity() Returns the highest severity of raw alarms for which the number of acknowledged alarms is nonzero.
IltAlarm.Severity	getHighestAcknowledgedRawAlarmSeverity(IltAlarm.Severity below) Returns the highest severity of raw alarm, less than below, and for which the number of acknowledged alarms is nonzero.
IltAlarmSeverity	getHighestAlarmSeverity() Returns the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero, including raw and impact alarms.
IltAlarmSeverity	getHighestAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below for which the number of alarms, acknowledged or otherwise, is nonzero, including raw and impact alarms.
IltAlarm.ImpactSeverity	getHighestImpactAlarmSeverity() Returns the highest severity for which the number of impact alarms, acknowledged or otherwise, is nonzero.
IltAlarm.ImpactSeverity	getHighestImpactAlarmSeverity(IltAlarm.ImpactSeverity below) Returns the highest severity less than below for which the number of impact alarms, acknowledged or otherwise, is nonzero.
IltAlarmSeverity	getHighestNewAlarmSeverity() Returns the highest severity for which the number of new alarms is nonzero, including raw and impact alarms.
IltAlarmSeverity	getHighestNewAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below for which the number of new alarms is nonzero, including raw and impact alarms.
IltAlarm.ImpactSeverity	getHighestNewImpactAlarmSeverity() Returns the highest severity for which the number of new impact alarms is nonzero.
IltAlarm.ImpactSeverity	getHighestNewImpactAlarmSeverity(IltAlarm.ImpactSeverity below) Returns the highest severity less than below for which the number of new impact alarms is nonzero.
IltAlarm.Severity	getHighestNewRawAlarmSeverity() Returns the highest severity for which the number of new raw alarms is nonzero.
IltAlarm.Severity	getHighestNewRawAlarmSeverity(IltAlarm.Severity below) Returns the highest severity less than below for which the number of new raw alarms is nonzero.
IltAlarm.Severity	getHighestRawAlarmSeverity() Returns the highest severity for which the number of raw alarms, acknowledged or otherwise, is nonzero.
IltAlarm.Severity	getHighestRawAlarmSeverity(IltAlarm.Severity below) Returns the highest severity less than below for which the number of raw alarms, acknowledged or otherwise, is nonzero.
int	getImpactAlarmCount() Returns the count of impact alarms, acknowledged or not, irrespective of their severity.
boolean	getLossOfConnectivity() Returns the lossOfConnectivity status.
int	getNewAlarmCount() Returns the number of new alarms, that are either raw or impact alarms, irrespective of their severity.
int	getNewImpactAlarmCount() Returns the number of new impact alarms, irrespective of their severity.
int	getNewRawAlarmCount() Returns the number of new raw alarms, irrespective of their severity.
boolean	getNotReporting() Returns the notReporting status.
int	getRawAlarmCount() Returns the count of raw alarms, acknowledged or not, irrespective of their severity.
boolean	isComputedFromAlarmList() Returns the activation status of the automatic computation of alarm counters from the list of alarms.
protected boolean	isCounterModificationAllowed()
void	removeAcknowledgedAlarm(IltAlarmSeverity severity) Removes an acknowledged alarm of a given severity.
void	removeAllAcknowledgedAlarms() Removes all acknowledged alarms, that are either raw or impact alarms, irrespective of their severity.
void	removeAllAcknowledgedAlarms(IltAlarmSeverity severity) Removes all acknowledged alarms of a given severity.
void	removeAllAcknowledgedImpactAlarms() Removes all acknowledged impact alarms, irrespective of their severity.
void	removeAllAcknowledgedRawAlarms() Removes all acknowledged raw alarms, irrespective of their severity.
void	removeAllAlarms() Removes all alarms, that are either raw or impact alarms, irrespective of their severity.
void	removeAllImpactAlarms() Removes all impact alarms, irrespective of their severity.
void	removeAllNewAlarms() Removes all new alarms, including raw and impact alarms.
void	removeAllNewAlarms(IltAlarmSeverity severity) Removes all new alarms of a given severity.
void	removeAllNewImpactAlarms() Removes all new impact alarms.
void	removeAllNewRawAlarms() Removes all new raw alarms.
void	removeAllRawAlarms() Removes all raw alarms, irrespective of their severity.
void	removeNewAlarm(IltAlarmSeverity severity) Removes a new alarm of a given severity.
void	reset() Resets the alarms counters to zero and the statuses to false.
void	setAcknowledgedAlarmCount(IltAlarmSeverity severity, int value) Sets the number of acknowledged alarms of a given severity.
void	setComputedFromAlarmList(boolean value) Enables or disables the automatic computation of alarm counters from the list of alarms.
protected void	setCounterModificationAllowed(boolean value)
void	setLossOfConnectivity(boolean value) Sets the lossOfConnectivity status.
void	setNewAlarmCount(IltAlarmSeverity severity, int value) Sets the number of new alarms of a given severity.
void	setNotReporting(boolean value) Sets the notReporting status.

Methods inherited from class ilog.tgo.model.IltAlarmSystem.State

acknowledgeAllAlarms, getAcknowledgedAlarmCount, getAlarmCount, getCount, getNewAlarmCount, getNotifier, getValue, hasNotifier, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, removeAllAcknowledgedAlarms, removeAllAlarms, removeAllNewAlarms, setNotifier

Methods inherited from class ilog.tgo.model.IltState

copy, CreateNameFilter, CreateStateFilter, createValue, getAliases, getAllPaths, getAltName, getDefault, getDescription, getName, getProperty, getStateInfo, getToolTipText, getToolTipText, hasDefault, hasDescription, hashCode, intern, isInside, IsPropertyTransient, isValid, list, removeProperty, setAltName, setDescription, setMessage, setName, setProperty, SetPropertyTransient, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RawSeverityFilter

protected static final IlpFilter RawSeverityFilter

Internal method or field: do not use!

ImpactSeverityFilter

protected static final IlpFilter ImpactSeverityFilter

Internal method or field: do not use!

metainfo

public static IltStateInfo metainfo

Contains metainformation about this IltState class.

Internal method or field: do not use!

computedFromAlarmList

protected boolean computedFromAlarmList

Internal method or field: do not use!

counterModificationAllowed

protected boolean counterModificationAllowed

Internal method or field: do not use!

Constructor Detail

IltAlarm.State

public IltAlarm.State(int newCriticalAlarmCount,
                      int newMajorAlarmCount,
                      int newMinorAlarmCount,
                      int newWarningAlarmCount,
                      int acknowledgedCriticalAlarmCount,
                      int acknowledgedMajorAlarmCount,
                      int acknowledgedMinorAlarmCount,
                      int acknowledgedWarningAlarmCount,
                      boolean lossOfConnectivity,
                      boolean notReporting)

Deprecated. This constructor is obsolete, please use another constructor.

Creates an IltAlarm.State with the given counts of new alarms and acknowledged alarms for each severity, as well as for the lossOfConnectivity and notReporting statuses.

Deprecated Since:

JTGO 4.0

IltAlarm.State

public IltAlarm.State(int newCriticalAlarmCount,
                      int newMajorAlarmCount,
                      int newMinorAlarmCount,
                      int newWarningAlarmCount,
                      int newUnknownAlarmCount,
                      int newClearedAlarmCount,
                      int acknowledgedCriticalAlarmCount,
                      int acknowledgedMajorAlarmCount,
                      int acknowledgedMinorAlarmCount,
                      int acknowledgedWarningAlarmCount,
                      int acknowledgedUnknownAlarmCount,
                      int acknowledgedClearedAlarmCount,
                      boolean lossOfConnectivity,
                      boolean notReporting)

Creates an IltAlarm.State with the given counts of new alarms and acknowledged alarms for each severity, as well as for the lossOfCconnectivity and notReporting statuses.

Counters of impact alarms are set to zero.

Since:

JTGO 4.0

IltAlarm.State

public IltAlarm.State(int newCriticalAlarmCount,
                      int newMajorAlarmCount,
                      int newMinorAlarmCount,
                      int newWarningAlarmCount,
                      int newUnknownAlarmCount,
                      int newClearedAlarmCount,
                      int acknowledgedCriticalAlarmCount,
                      int acknowledgedMajorAlarmCount,
                      int acknowledgedMinorAlarmCount,
                      int acknowledgedWarningAlarmCount,
                      int acknowledgedUnknownAlarmCount,
                      int acknowledgedClearedAlarmCount,
                      int newCriticalHighImpactAlarmCount,
                      int newCriticalLowImpactAlarmCount,
                      int newMajorHighImpactAlarmCount,
                      int newMajorLowImpactAlarmCount,
                      int newMinorHighImpactAlarmCount,
                      int newMinorLowImpactAlarmCount,
                      int newWarningHighImpactAlarmCount,
                      int newWarningLowImpactAlarmCount,
                      int newUnknownImpactAlarmCount,
                      int newClearedImpactAlarmCount,
                      int acknowledgedCriticalHighImpactAlarmCount,
                      int acknowledgedCriticalLowImpactAlarmCount,
                      int acknowledgedMajorHighImpactAlarmCount,
                      int acknowledgedMajorLowImpactAlarmCount,
                      int acknowledgedMinorHighImpactAlarmCount,
                      int acknowledgedMinorLowImpactAlarmCount,
                      int acknowledgedWarningHighImpactAlarmCount,
                      int acknowledgedWarningLowImpactAlarmCount,
                      int acknowledgedUnknownImpactAlarmCount,
                      int acknowledgedClearedImpactAlarmCount,
                      boolean lossOfConnectivity,
                      boolean notReporting)

Creates an IltAlarm.State with the given counts of new alarms and acknowledged alarms for each severity, as well as for the lossOfConnectivity and notReporting statuses.

This constructor allows you to specify counters for raw and impact alarms.

Since:

JTGO 4.0

IltAlarm.State

public IltAlarm.State()

Creates an IltAlarm.State with severity counters to zero and lossOfConnectivity and notReporting to false.

IltAlarm.State

public IltAlarm.State(ilog.tgo.model.internal.IltAggregateStateValue value)

Creates an alarm state based on a given state value.

Internal method or field: do not use!

Method Detail

getAlarmSystem

public IltAlarmSystem getAlarmSystem()

System for which the values are being handled by this state.

Specified by:

getAlarmSystem in class IltAlarmSystem.State

Internal method or field: do not use!

getLossOfConnectivity

public boolean getLossOfConnectivity()

Returns the lossOfConnectivity status.

setLossOfConnectivity

public void setLossOfConnectivity(boolean value)

Sets the lossOfConnectivity status.

getNotReporting

public boolean getNotReporting()

Returns the notReporting status.

setNotReporting

public void setNotReporting(boolean value)

Sets the notReporting status.

setComputedFromAlarmList

public void setComputedFromAlarmList(boolean value)

Enables or disables the automatic computation of alarm counters from the list of alarms. By default, the counters are not automatically computed from the list of alarms.

Effective changes to the value of this property reset the alarm counters to zero.

Parameters:

value - true to enable the automatic computation of the counters from the list of alarms; false to disable it.

Since:

JTGO 4.0

isComputedFromAlarmList

public boolean isComputedFromAlarmList()

Returns the activation status of the automatic computation of alarm counters from the list of alarms.

Returns:

true if the alarm counters are automatically computed from the list of alarms; false otherwise.

Since:

JTGO 4.0

setCounterModificationAllowed

protected void setCounterModificationAllowed(boolean value)

Internal method or field: do not use!

isCounterModificationAllowed

protected boolean isCounterModificationAllowed()

Internal method or field: do not use!

checkComputationState

protected void checkComputationState()

Checks whether alarm counter modifications are legal or not.

Throws:

IllegalStateException - when a direct counter modification API is used while the alarm counters are automatically being computed from the list of alarms.

Internal method or field: do not use!

alarmAdded

public void alarmAdded(IltAlarm alarm)

An alarm was added to the list of alarms of the managed object.

Parameters:

alarm - The alarm that was added cannot be null.

Since:

JTGO 4.0

See Also:

IltDefaultDataSource.setHandlingAlarmReferences(boolean)

Internal method or field: do not use!

alarmRemoved

public void alarmRemoved(IltAlarm alarm)

An alarm was removed from the list of alarms of the managed object.

Parameters:

alarm - The alarm that was removed cannot be null.

Since:

JTGO 4.0

See Also:

IltDefaultDataSource.setHandlingAlarmReferences(boolean)

Internal method or field: do not use!

alarmChanged

public void alarmChanged(IltAlarm alarm,
                         IlpAttribute attribute,
                         Object oldValue)

An alarm from the list of alarms of the managed object was changed.

Parameters:

alarm - The alarm that has been changed.

attribute - The attribute that has been changed.

oldValue - The old value of the changed attribute.

Since:

JTGO 4.0

See Also:

IltDefaultDataSource.setHandlingAlarmReferences(boolean)

Internal method or field: do not use!

clone

public Object clone()

Creates a copy of this object.

Overrides:

clone in class IltAlarmSystem.State

equals

public boolean equals(Object obj)

Compares this object with another object. Two IltAlarm.State instances are considered equal if their corresponding counters and other statuses are equal.

Overrides:

equals in class IltAlarmSystem.State

reset

public void reset()

Resets the alarms counters to zero and the statuses to false.

Overrides:

reset in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

getAcknowledgedAlarmCount

public int getAcknowledgedAlarmCount()

Returns the number of acknowledged alarms, that are either raw or impact alarms, irrespective of their severity.

Overrides:

getAcknowledgedAlarmCount in class IltAlarmSystem.State

See Also:

getAcknowledgedRawAlarmCount(), getAcknowledgedImpactAlarmCount()

getAcknowledgedRawAlarmCount

public int getAcknowledgedRawAlarmCount()

Returns the number of acknowledged raw alarms, irrespective of their severity.

Since:

JTGO 4.0

getAcknowledgedImpactAlarmCount

public int getAcknowledgedImpactAlarmCount()

Returns the number of acknowledged impact alarms, irrespective of their severity.

Since:

JTGO 4.0

getNewAlarmCount

public int getNewAlarmCount()

Returns the number of new alarms, that are either raw or impact alarms, irrespective of their severity.

Overrides:

getNewAlarmCount in class IltAlarmSystem.State

See Also:

getNewRawAlarmCount(), getNewImpactAlarmCount()

getNewRawAlarmCount

public int getNewRawAlarmCount()

Returns the number of new raw alarms, irrespective of their severity.

Since:

JTGO 4.0

getNewImpactAlarmCount

public int getNewImpactAlarmCount()

Returns the number of new impact alarms, irrespective of their severity.

Since:

JTGO 4.0

getAlarmCount

public int getAlarmCount()

Returns the count of all alarms, acknowledged or not, that are either raw or impact alarms, irrespective of their severity.

Overrides:

getAlarmCount in class IltAlarmSystem.State

See Also:

getRawAlarmCount(), getImpactAlarmCount()

getRawAlarmCount

public int getRawAlarmCount()

Returns the count of raw alarms, acknowledged or not, irrespective of their severity.

Since:

JTGO 4.0

getImpactAlarmCount

public int getImpactAlarmCount()

Returns the count of impact alarms, acknowledged or not, irrespective of their severity.

Since:

JTGO 4.0

addAcknowledgedAlarm

public void addAcknowledgedAlarm(IltAlarmSeverity severity)

Adds an acknowledged alarm of a given severity.

Overrides:

addAcknowledgedAlarm in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

addNewAlarm

public void addNewAlarm(IltAlarmSeverity severity)

Adds a new alarm of a given severity.

Overrides:

addNewAlarm in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

removeNewAlarm

public void removeNewAlarm(IltAlarmSeverity severity)

Removes a new alarm of a given severity.

Overrides:

removeNewAlarm in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

removeAllNewAlarms

public void removeAllNewAlarms(IltAlarmSeverity severity)

Removes all new alarms of a given severity.

Overrides:

removeAllNewAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

removeAcknowledgedAlarm

public void removeAcknowledgedAlarm(IltAlarmSeverity severity)

Removes an acknowledged alarm of a given severity.

Overrides:

removeAcknowledgedAlarm in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

removeAllAcknowledgedAlarms

public void removeAllAcknowledgedAlarms(IltAlarmSeverity severity)

Removes all acknowledged alarms of a given severity.

Overrides:

removeAllAcknowledgedAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

acknowledgeAlarm

public void acknowledgeAlarm(IltAlarmSeverity severity)

Acknowledges an alarm of a given severity.

Overrides:

acknowledgeAlarm in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

acknowledgeAllAlarms

public void acknowledgeAllAlarms(IltAlarmSeverity severity)

Acknowledges all alarms of a given severity.

Overrides:

acknowledgeAllAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

removeAllNewAlarms

public void removeAllNewAlarms()

Removes all new alarms, including raw and impact alarms.

Overrides:

removeAllNewAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

See Also:

removeAllNewRawAlarms(), removeAllNewImpactAlarms()

removeAllNewRawAlarms

public void removeAllNewRawAlarms()

Removes all new raw alarms.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

removeAllNewImpactAlarms

public void removeAllNewImpactAlarms()

Removes all new impact alarms.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

removeAllAcknowledgedAlarms

public void removeAllAcknowledgedAlarms()

Removes all acknowledged alarms, that are either raw or impact alarms, irrespective of their severity.

Overrides:

removeAllAcknowledgedAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

See Also:

removeAllAcknowledgedRawAlarms(), removeAllAcknowledgedImpactAlarms()

removeAllAcknowledgedRawAlarms

public void removeAllAcknowledgedRawAlarms()

Removes all acknowledged raw alarms, irrespective of their severity.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

removeAllAcknowledgedImpactAlarms

public void removeAllAcknowledgedImpactAlarms()

Removes all acknowledged impact alarms, irrespective of their severity.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

removeAllAlarms

public void removeAllAlarms()

Removes all alarms, that are either raw or impact alarms, irrespective of their severity.

Overrides:

removeAllAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

See Also:

removeAllRawAlarms(), removeAllImpactAlarms()

removeAllRawAlarms

public void removeAllRawAlarms()

Removes all raw alarms, irrespective of their severity.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

removeAllImpactAlarms

public void removeAllImpactAlarms()

Removes all impact alarms, irrespective of their severity.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

acknowledgeAllAlarms

public void acknowledgeAllAlarms()

Acknowledges all alarms, including raw and impact alarms.

Overrides:

acknowledgeAllAlarms in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

See Also:

acknowledgeAllRawAlarms(), acknowledgeAllImpactAlarms()

acknowledgeAllRawAlarms

public void acknowledgeAllRawAlarms()

Acknowledges all raw alarms.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

acknowledgeAllImpactAlarms

public void acknowledgeAllImpactAlarms()

Acknowledges all impact alarms.

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

Since:

JTGO 4.0

setAcknowledgedAlarmCount

public void setAcknowledgedAlarmCount(IltAlarmSeverity severity,
                                      int value)

Sets the number of acknowledged alarms of a given severity.

Overrides:

setAcknowledgedAlarmCount in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

setNewAlarmCount

public void setNewAlarmCount(IltAlarmSeverity severity,
                             int value)

Sets the number of new alarms of a given severity.

Overrides:

setNewAlarmCount in class IltAlarmSystem.State

Throws:

IllegalStateException - when the alarm counters are automatically computed from the list of alarms. In this case the associated IltAlarms should be updated.

getHighestNewAlarmSeverity

public IltAlarmSeverity getHighestNewAlarmSeverity()

Returns the highest severity for which the number of new alarms is nonzero, including raw and impact alarms.

See Also:

getHighestNewRawAlarmSeverity(), getHighestNewImpactAlarmSeverity()

getHighestNewRawAlarmSeverity

public IltAlarm.Severity getHighestNewRawAlarmSeverity()

Returns the highest severity for which the number of new raw alarms is nonzero.

Since:

JTGO 4.0

getHighestNewImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestNewImpactAlarmSeverity()

Returns the highest severity for which the number of new impact alarms is nonzero.

Since:

JTGO 4.0

getHighestNewRawAlarmSeverity

public IltAlarm.Severity getHighestNewRawAlarmSeverity(IltAlarm.Severity below)

Returns the highest severity less than below for which the number of new raw alarms is nonzero.

Since:

JTGO 4.0

getHighestNewImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestNewImpactAlarmSeverity(IltAlarm.ImpactSeverity below)

Returns the highest severity less than below for which the number of new impact alarms is nonzero.

Since:

JTGO 4.0

getHighestNewAlarmSeverity

public IltAlarmSeverity getHighestNewAlarmSeverity(IltAlarmSeverity below)

Returns the highest severity less than below for which the number of new alarms is nonzero, including raw and impact alarms.

See Also:

getHighestNewRawAlarmSeverity(), getHighestNewImpactAlarmSeverity()

getHighestAcknowledgedAlarmSeverity

public IltAlarmSeverity getHighestAcknowledgedAlarmSeverity()

Returns the highest severity for which the number of acknowledged alarms is nonzero, including raw and impact alarms.

See Also:

getHighestAcknowledgedRawAlarmSeverity(), getHighestAcknowledgedImpactAlarmSeverity()

getHighestAcknowledgedRawAlarmSeverity

public IltAlarm.Severity getHighestAcknowledgedRawAlarmSeverity()

Returns the highest severity of raw alarms for which the number of acknowledged alarms is nonzero.

Since:

JTGO 4.0

getHighestAcknowledgedImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestAcknowledgedImpactAlarmSeverity()

Returns the highest severity of impact alarm for which the number of acknowledged alarms is nonzero.

Since:

JTGO 4.0

getHighestAcknowledgedAlarmSeverity

public IltAlarmSeverity getHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below)

Returns the highest severity less than below for which the number of acknowledged alarms is nonzero, including raw and impact alarms.

See Also:

getHighestAcknowledgedRawAlarmSeverity(), getHighestAcknowledgedImpactAlarmSeverity()

getHighestAcknowledgedRawAlarmSeverity

public IltAlarm.Severity getHighestAcknowledgedRawAlarmSeverity(IltAlarm.Severity below)

Returns the highest severity of raw alarm, less than below, and for which the number of acknowledged alarms is nonzero.

Since:

JTGO 4.0

getHighestAcknowledgedImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestAcknowledgedImpactAlarmSeverity(IltAlarm.ImpactSeverity below)

Returns the highest severity of impact alarm, less than below, and for which the number of acknowledged alarms is nonzero.

Since:

JTGO 4.0

getHighestAlarmSeverity

public IltAlarmSeverity getHighestAlarmSeverity()

Returns the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero, including raw and impact alarms.

See Also:

getHighestRawAlarmSeverity(), getHighestImpactAlarmSeverity()

getHighestRawAlarmSeverity

public IltAlarm.Severity getHighestRawAlarmSeverity()

Returns the highest severity for which the number of raw alarms, acknowledged or otherwise, is nonzero.

Since:

JTGO 4.0

getHighestImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestImpactAlarmSeverity()

Returns the highest severity for which the number of impact alarms, acknowledged or otherwise, is nonzero.

Since:

JTGO 4.0

getHighestAlarmSeverity

public IltAlarmSeverity getHighestAlarmSeverity(IltAlarmSeverity below)

Returns the highest severity less than below for which the number of alarms, acknowledged or otherwise, is nonzero, including raw and impact alarms.

See Also:

getHighestRawAlarmSeverity(), getHighestImpactAlarmSeverity()

getHighestRawAlarmSeverity

public IltAlarm.Severity getHighestRawAlarmSeverity(IltAlarm.Severity below)

Returns the highest severity less than below for which the number of raw alarms, acknowledged or otherwise, is nonzero.

Since:

JTGO 4.0

getHighestImpactAlarmSeverity

public IltAlarm.ImpactSeverity getHighestImpactAlarmSeverity(IltAlarm.ImpactSeverity below)

Returns the highest severity less than below for which the number of impact alarms, acknowledged or otherwise, is nonzero.

Since:

JTGO 4.0