ilog.tgo.model
Class IltTrap.State

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

All Implemented Interfaces:

IltDecorationSource, IlWithProperties, Cloneable

Enclosing class:

IltTrap

public static class IltTrap.State
extends IltAlarmSystem.State
implements Cloneable

This class provides a representation model for the traps carried by a telecom object. Each trap type present in the alarm system, can have a number of new alarms and a number of acknowledged alarms stored. It also introduces the concept of outstanding traps, whose number is the sum of all alarms, whether acknowledged or not.

Field Summary

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

_alarmValues, _notifier

Fields inherited from class ilog.tgo.model.IltState

_message, metainfo

Constructor Summary

IltTrap.State()
This constructor initializes an instance by setting all numbers to zero.

IltTrap.State(ilog.tgo.model.internal.IltAggregateStateValue value)
Creates an alarm state based in the state value.

IltTrap.State(int newLinkFailCount, int newAuthFailCount, int newEGPNLossCount, int newWarmStartCount, int newColdStartCount, int acknowledgedLinkFailCount, int acknowledgedAuthFailCount, int acknowledgedEGPNLossCount, int acknowledgedWarmStartCount, int acknowledgedColdStartCount)
This constructor initializes an instance by setting the number of new traps and acknowledged traps for each type.

Method Summary

Object	clone() Creates a copy of this object.
boolean	equals(Object obj) Compares this object with another object.
IltAlarmSystem	getAlarmSystem() System whose values are being handled by this state.
IltAlarmSeverity	getHighestAcknowledgedAlarmSeverity() Returns the highest severity for which the number of acknowledged alarms is nonzero.
IltAlarmSeverity	getHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below 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.
IltAlarmSeverity	getHighestAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below for which the number of alarms, acknowledged or otherwise, is nonzero.
IltAlarmSeverity	getHighestNewAlarmSeverity() Returns the highest severity for which the number of new alarms is nonzero.
IltAlarmSeverity	getHighestNewAlarmSeverity(IltAlarmSeverity below) Returns the highest severity less than below for which the number of new alarms is nonzero.
protected void	initializeType(IltTrap.Type t, int newCount, int ackCount) Initializes the aggregate state value instance with the given counter for the given trap type.

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

acknowledgeAlarm, acknowledgeAllAlarms, acknowledgeAllAlarms, acknowledgeAllAlarms, addAcknowledgedAlarm, addNewAlarm, getAcknowledgedAlarmCount, getAcknowledgedAlarmCount, getAlarmCount, getAlarmCount, getCount, getNewAlarmCount, getNewAlarmCount, getNotifier, getValue, hasNotifier, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAcknowledgedAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, internalGetHighestNewAlarmSeverity, removeAcknowledgedAlarm, removeAllAcknowledgedAlarms, removeAllAcknowledgedAlarms, removeAllAcknowledgedAlarms, removeAllAlarms, removeAllAlarms, removeAllNewAlarms, removeAllNewAlarms, removeAllNewAlarms, removeNewAlarm, reset, setAcknowledgedAlarmCount, setNewAlarmCount, 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

Constructor Detail

IltTrap.State

public IltTrap.State()

This constructor initializes an instance by setting all numbers to zero.

IltTrap.State

public IltTrap.State(int newLinkFailCount,
                     int newAuthFailCount,
                     int newEGPNLossCount,
                     int newWarmStartCount,
                     int newColdStartCount,
                     int acknowledgedLinkFailCount,
                     int acknowledgedAuthFailCount,
                     int acknowledgedEGPNLossCount,
                     int acknowledgedWarmStartCount,
                     int acknowledgedColdStartCount)

This constructor initializes an instance by setting the number of new traps and acknowledged traps for each type.

IltTrap.State

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

Creates an alarm state based in the state value.

Internal method or field: do not use!

Method Detail

getAlarmSystem

public IltAlarmSystem getAlarmSystem()

System whose values are being handled by this state.

Specified by:

getAlarmSystem in class IltAlarmSystem.State

Internal method or field: do not use!

initializeType

protected void initializeType(IltTrap.Type t,
                              int newCount,
                              int ackCount)

Initializes the aggregate state value instance with the given counter for the given trap type.

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 IltTrap.State instances are considered equal if their corresponding values are equal.

Overrides:

equals in class IltAlarmSystem.State

getHighestNewAlarmSeverity

public IltAlarmSeverity getHighestNewAlarmSeverity()

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

getHighestNewAlarmSeverity

public IltAlarmSeverity getHighestNewAlarmSeverity(IltAlarmSeverity below)

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

getHighestAcknowledgedAlarmSeverity

public IltAlarmSeverity getHighestAcknowledgedAlarmSeverity()

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

getHighestAcknowledgedAlarmSeverity

public IltAlarmSeverity getHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below)

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

getHighestAlarmSeverity

public IltAlarmSeverity getHighestAlarmSeverity()

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

getHighestAlarmSeverity

public IltAlarmSeverity getHighestAlarmSeverity(IltAlarmSeverity below)

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