IltAlarmSystem.State (Rogue Wave JViews 9.2 API)

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

All Implemented Interfaces:

IltDecorationSource, IlWithProperties, Cloneable

Direct Known Subclasses:

IltAlarm.State, IltTrap.State

Enclosing class:

IltAlarmSystem
```
public abstract static class IltAlarmSystem.State
extends IltState
implements Cloneable
```
This class provides a representation model for generic alarms carried by a telecom object. Each alarm severity 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 alarms, whose number is the sum of all alarms, whether acknowledged or not.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ilog.tgo.model.internal.IltAggregateStateValue`	`_alarmValues` This aggregate state value contains all the information set in the object state regarding alarms.
`protected ilog.tgo.model.internal.IltStateValueChangeNotifier`	`_notifier`

Fields inherited from class ilog.tgo.model.IltState
_message, metainfo

Constructor Summary

Constructors
Constructor and Description
`State()` This constructor initializes an instance by setting all numbers to 0 and the boolean values to `false`.
`State(ilog.tgo.model.internal.IltAggregateStateValue value)` Creates an alarm state based in the state value.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acknowledgeAlarm(IltAlarmSeverity severity)` Acknowledge one alarm of a given severity.
`void`	`acknowledgeAllAlarms()` Acknowledges all alarms.
`protected void`	`acknowledgeAllAlarms(IlpFilter filter)`
`void`	`acknowledgeAllAlarms(IltAlarmSeverity severity)` Acknowledges all alarms of a given severity.
`void`	`addAcknowledgedAlarm(IltAlarmSeverity severity)` Add one acknowledged alarm of a given severity.
`void`	`addNewAlarm(IltAlarmSeverity severity)` Add one new alarm of a given severity.
`Object`	`clone()` Creates a copy of this object.
`boolean`	`equals(Object obj)` Compares this object with another object.
`int`	`getAcknowledgedAlarmCount()` Return the number of acknowledged alarms, irrespective of severity.
`int`	`getAcknowledgedAlarmCount(IltAlarmSeverity severity)` Return the number of acknowledged alarms for a given severity.
`int`	`getAlarmCount()` Return the total number of alarms, acknowledged or not, and irrespective of severity.
`int`	`getAlarmCount(IltAlarmSeverity severity)` Return the total number of alarms, acknowledged or not, with a given severity.
`abstract IltAlarmSystem`	`getAlarmSystem()` System whose values are being handled by this state.
`protected int`	`getCount(Object[] paths)` Return the count of alarms for the given state paths.
`int`	`getNewAlarmCount()` Return the number of new alarms, irrespective of severity.
`int`	`getNewAlarmCount(IltAlarmSeverity severity)` Return the number of new alarms of the given severity.
`ilog.tgo.model.internal.IltStateValueChangeNotifier`	`getNotifier()` Return the notifier set in this instance.
`ilog.tgo.model.internal.IltAggregateStateValue`	`getValue()` Return the values set inside the alarm aggregate state
`protected boolean`	`hasNotifier()` Return if there is a notifier set in this instance.
`IltAlarmSeverity`	`internalGetHighestAcknowledgedAlarmSeverity()` Return the highest severity for which the number of acknowledged alarms is nonzero.
`IltAlarmSeverity`	`internalGetHighestAcknowledgedAlarmSeverity(IlpFilter filter)` Return the highest severity for which the number of acknowledged alarms is nonzero, and that satisfies a given filter.
`IltAlarmSeverity`	`internalGetHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below)` Return the highest severity less than `below` for which the number of acknowledged alarms is nonzero.
`IltAlarmSeverity`	`internalGetHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below, IlpFilter filter)` Return the highest severity less than `below` for which the number of acknowledged alarms is nonzero, and that satisfies a given filter.
`IltAlarmSeverity`	`internalGetHighestAlarmSeverity()` Return the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero.
`IltAlarmSeverity`	`internalGetHighestAlarmSeverity(IlpFilter filter)` Return the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero, and that satisfies a given filter.
`IltAlarmSeverity`	`internalGetHighestAlarmSeverity(IltAlarmSeverity below)` Return the highest severity less than `below` for which the number of alarms, acknowledged or otherwise, is nonzero.
`IltAlarmSeverity`	`internalGetHighestAlarmSeverity(IltAlarmSeverity below, IlpFilter filter)` Return the highest severity less than `below` for which the number of alarms, acknowledged or otherwise, is nonzero, and that satisfies a given filter.
`IltAlarmSeverity`	`internalGetHighestNewAlarmSeverity()` Return the highest severity for which the number of new alarms is nonzero.
`IltAlarmSeverity`	`internalGetHighestNewAlarmSeverity(IlpFilter filter)` Return the highest severity for which the number of new alarms is nonzero, and that satisfies a given filter.
`IltAlarmSeverity`	`internalGetHighestNewAlarmSeverity(IltAlarmSeverity below)` Return the highest severity less than `below` for which the number of new alarms is nonzero.
`IltAlarmSeverity`	`internalGetHighestNewAlarmSeverity(IltAlarmSeverity below, IlpFilter filter)` Return the highest severity less than `below` for which the number of new alarms is nonzero, and that satisfies a given filter.
`void`	`removeAcknowledgedAlarm(IltAlarmSeverity severity)` Remove one acknowledged alarm of a given severity.
`void`	`removeAllAcknowledgedAlarms()` Remove all acknowledged alarms.
`protected void`	`removeAllAcknowledgedAlarms(IlpFilter filter)`
`void`	`removeAllAcknowledgedAlarms(IltAlarmSeverity severity)` Remove all acknowledged alarms of a given severity.
`void`	`removeAllAlarms()` Remove all alarms.
`protected void`	`removeAllAlarms(IlpFilter filter)`
`void`	`removeAllNewAlarms()` Remove all new alarms.
`protected void`	`removeAllNewAlarms(IlpFilter filter)`
`void`	`removeAllNewAlarms(IltAlarmSeverity severity)` Remove all new alarms of the given severity.
`void`	`removeNewAlarm(IltAlarmSeverity severity)` Remove one new alarm of a given severity.
`void`	`reset()` Reset all alarms counters to zero.
`void`	`setAcknowledgedAlarmCount(IltAlarmSeverity severity, int value)` Set the number of acknowledged alarms for a given severity.
`void`	`setNewAlarmCount(IltAlarmSeverity severity, int value)` Sets the number of new alarms for a given severity.
`void`	`setNotifier(ilog.tgo.model.internal.IltStateValueChangeNotifier notifier)` Sets the notifier instance.

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
  - _alarmValues
```
protected ilog.tgo.model.internal.IltAggregateStateValue _alarmValues
```
    This aggregate state value contains all the information set in the object state regarding alarms. This is exactly the value set in the IltObjectState instance, so changes in this attribute are reflected directly there.
    
    Internal: do not use!
  - _notifier
```
protected ilog.tgo.model.internal.IltStateValueChangeNotifier _notifier
```
    Internal: do not use!
- Constructor Detail
  - State
```
public State()
```
    This constructor initializes an instance by setting all numbers to 0 and the boolean values to false.
    
    Internal: do not use!
  - State
```
public State(ilog.tgo.model.internal.IltAggregateStateValue value)
```
    Creates an alarm state based in the state value.
    
    Internal: do not use!
- Method Detail
  - getAlarmSystem
```
public abstract IltAlarmSystem getAlarmSystem()
```
    System whose values are being handled by this state.
    
    Internal: do not use!
  - getValue
```
public ilog.tgo.model.internal.IltAggregateStateValue getValue()
```
    Return the values set inside the alarm aggregate state
    
    Internal: do not use!
  - setNotifier
```
public void setNotifier(ilog.tgo.model.internal.IltStateValueChangeNotifier notifier)
```
    Sets the notifier instance.
    
    Internal: do not use!
  - getNotifier
```
public ilog.tgo.model.internal.IltStateValueChangeNotifier getNotifier()
```
    Return the notifier set in this instance.
    
    Internal: do not use!
  - hasNotifier
```
protected boolean hasNotifier()
```
    Return if there is a notifier set in this instance.
    
    Internal: do not use!
  - clone
```
public Object clone()
```
    Creates a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Internal: do not use!
  - equals
```
public boolean equals(Object obj)
```
    Compares this object with another object. Two IltAlarmSystem.State instances are considered equal if their corresponding values are equal.
    
    Overrides:
    
    equals in class IltState
    
    Internal: do not use!
  - getNewAlarmCount
```
public int getNewAlarmCount()
```
    Return the number of new alarms, irrespective of severity.
  - getNewAlarmCount
```
public int getNewAlarmCount(IltAlarmSeverity severity)
```
    Return the number of new alarms of the given severity.
  - setNewAlarmCount
```
public void setNewAlarmCount(IltAlarmSeverity severity,
                             int value)
```
    Sets the number of new alarms for a given severity.
  - addNewAlarm
```
public void addNewAlarm(IltAlarmSeverity severity)
```
    Add one new alarm of a given severity.
  - removeNewAlarm
```
public void removeNewAlarm(IltAlarmSeverity severity)
```
    Remove one new alarm of a given severity.
  - removeAllNewAlarms
```
public void removeAllNewAlarms(IltAlarmSeverity severity)
```
    Remove all new alarms of the given severity.
  - removeAllNewAlarms
```
public void removeAllNewAlarms()
```
    Remove all new alarms.
  - getAcknowledgedAlarmCount
```
public int getAcknowledgedAlarmCount()
```
    Return the number of acknowledged alarms, irrespective of severity.
  - getAcknowledgedAlarmCount
```
public int getAcknowledgedAlarmCount(IltAlarmSeverity severity)
```
    Return the number of acknowledged alarms for a given severity.
  - setAcknowledgedAlarmCount
```
public void setAcknowledgedAlarmCount(IltAlarmSeverity severity,
                                      int value)
```
    Set the number of acknowledged alarms for a given severity.
  - addAcknowledgedAlarm
```
public void addAcknowledgedAlarm(IltAlarmSeverity severity)
```
    Add one acknowledged alarm of a given severity.
  - removeAcknowledgedAlarm
```
public void removeAcknowledgedAlarm(IltAlarmSeverity severity)
```
    Remove one acknowledged alarm of a given severity.
  - removeAllAcknowledgedAlarms
```
public void removeAllAcknowledgedAlarms(IltAlarmSeverity severity)
```
    Remove all acknowledged alarms of a given severity.
  - removeAllAcknowledgedAlarms
```
public void removeAllAcknowledgedAlarms()
```
    Remove all acknowledged alarms.
  - getAlarmCount
```
public int getAlarmCount()
```
    Return the total number of alarms, acknowledged or not, and irrespective of severity.
  - getAlarmCount
```
public int getAlarmCount(IltAlarmSeverity severity)
```
    Return the total number of alarms, acknowledged or not, with a given severity.
  - acknowledgeAlarm
```
public void acknowledgeAlarm(IltAlarmSeverity severity)
```
    Acknowledge one alarm of a given severity. The alarm is moved from the "new" category to the "acknowledged" category.
  - acknowledgeAllAlarms
```
public void acknowledgeAllAlarms(IltAlarmSeverity severity)
```
    Acknowledges all alarms of a given severity.
  - acknowledgeAllAlarms
```
public void acknowledgeAllAlarms()
```
    Acknowledges all alarms.
  - removeAllAlarms
```
public void removeAllAlarms()
```
    Remove all alarms.
  - removeAllNewAlarms
```
protected void removeAllNewAlarms(IlpFilter filter)
```
    Internal: do not use!
  - removeAllAcknowledgedAlarms
```
protected void removeAllAcknowledgedAlarms(IlpFilter filter)
```
    Internal: do not use!
  - removeAllAlarms
```
protected void removeAllAlarms(IlpFilter filter)
```
    Internal: do not use!
  - acknowledgeAllAlarms
```
protected void acknowledgeAllAlarms(IlpFilter filter)
```
    Internal: do not use!
  - reset
```
public void reset()
```
    Reset all alarms counters to zero.
  - internalGetHighestNewAlarmSeverity
```
public IltAlarmSeverity internalGetHighestNewAlarmSeverity()
```
    Return the highest severity for which the number of new alarms is nonzero.
    
    Internal: do not use!
  - internalGetHighestNewAlarmSeverity
```
public IltAlarmSeverity internalGetHighestNewAlarmSeverity(IlpFilter filter)
```
    Return the highest severity for which the number of new alarms is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - internalGetHighestNewAlarmSeverity
```
public IltAlarmSeverity internalGetHighestNewAlarmSeverity(IltAlarmSeverity below)
```
    Return the highest severity less than below for which the number of new alarms is nonzero.
    
    Internal: do not use!
  - internalGetHighestNewAlarmSeverity
```
public IltAlarmSeverity internalGetHighestNewAlarmSeverity(IltAlarmSeverity below,
                                                           IlpFilter filter)
```
    Return the highest severity less than below for which the number of new alarms is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - internalGetHighestAcknowledgedAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAcknowledgedAlarmSeverity()
```
    Return the highest severity for which the number of acknowledged alarms is nonzero.
    
    Internal: do not use!
  - internalGetHighestAcknowledgedAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAcknowledgedAlarmSeverity(IlpFilter filter)
```
    Return the highest severity for which the number of acknowledged alarms is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - internalGetHighestAcknowledgedAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below)
```
    Return the highest severity less than below for which the number of acknowledged alarms is nonzero.
    
    Internal: do not use!
  - internalGetHighestAcknowledgedAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAcknowledgedAlarmSeverity(IltAlarmSeverity below,
                                                                    IlpFilter filter)
```
    Return the highest severity less than below for which the number of acknowledged alarms is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - internalGetHighestAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAlarmSeverity()
```
    Return the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero.
    
    Internal: do not use!
  - internalGetHighestAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAlarmSeverity(IlpFilter filter)
```
    Return the highest severity for which the number of alarms, acknowledged or otherwise, is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - internalGetHighestAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAlarmSeverity(IltAlarmSeverity below)
```
    Return the highest severity less than below for which the number of alarms, acknowledged or otherwise, is nonzero.
    
    Internal: do not use!
  - internalGetHighestAlarmSeverity
```
public IltAlarmSeverity internalGetHighestAlarmSeverity(IltAlarmSeverity below,
                                                        IlpFilter filter)
```
    Return the highest severity less than below for which the number of alarms, acknowledged or otherwise, is nonzero, and that satisfies a given filter.
    
    Internal: do not use!
  - getCount
```
protected int getCount(Object[] paths)
```
    Return the count of alarms for the given state paths.
    
    Parameters:
    
    paths - IltState[][], that is an array of paths.
    
    Returns:
    
    the count of alarms

Class IltAlarmSystem.State

Field Summary

Fields inherited from class ilog.tgo.model.IltState

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.model.IltState

Methods inherited from class java.lang.Object

Field Detail

_alarmValues

_notifier

Constructor Detail

State

State

Method Detail

getAlarmSystem

getValue

setNotifier

getNotifier

hasNotifier

clone

equals

getNewAlarmCount

getNewAlarmCount

setNewAlarmCount

addNewAlarm

removeNewAlarm

removeAllNewAlarms

removeAllNewAlarms

getAcknowledgedAlarmCount

getAcknowledgedAlarmCount

setAcknowledgedAlarmCount

addAcknowledgedAlarm

removeAcknowledgedAlarm

removeAllAcknowledgedAlarms

removeAllAcknowledgedAlarms

getAlarmCount

getAlarmCount

acknowledgeAlarm

acknowledgeAllAlarms

acknowledgeAllAlarms

removeAllAlarms

removeAllNewAlarms

removeAllAcknowledgedAlarms

removeAllAlarms

acknowledgeAllAlarms

reset

internalGetHighestNewAlarmSeverity

internalGetHighestNewAlarmSeverity

internalGetHighestNewAlarmSeverity

internalGetHighestNewAlarmSeverity

internalGetHighestAcknowledgedAlarmSeverity

internalGetHighestAcknowledgedAlarmSeverity

internalGetHighestAcknowledgedAlarmSeverity

internalGetHighestAcknowledgedAlarmSeverity

internalGetHighestAlarmSeverity

internalGetHighestAlarmSeverity

internalGetHighestAlarmSeverity

internalGetHighestAlarmSeverity

getCount