ilog.tgo.css.function
Class IltAlarmSummaryFunction

java.lang.Object
  ilog.tgo.css.function.IltAbstractAlarmSummaryFunction
      ilog.tgo.css.function.IltAlarmSummaryFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

public class IltAlarmSummaryFunction
extends IltAbstractAlarmSummaryFunction

IltAlarmSummaryFunction returns a summary of new and acknowledged alarms for a given CSS model object. This function should be used as follows:

 label: '@|alarmSummary()';                   // equivalent to "Default"
 label: '@|alarmSummary("Default")';          // raw alarms or traps
 label: '@|alarmSummary("Impact")';           // impact alarms
 label: '@|alarmSummary("Raw.Major")';        // consider only raw major alarms
 label: '@|alarmSummary("Impact.MajorHigh")'; // consider only impact major high alarms
 

Optionally, a second argument can be passed to this function when retrieving the summary information for raw alarms, impact alarms or traps. This argument indicates that the summary representation shall be created using the alarm severity abbreviation or the alarm severity description. By default, the alarm severity description is used.

 label: '@|alarmSummary("Default", "Abbreviation")';
 label: '@|alarmSummary("Impact", "Description")';
 

The returned value is a string listing the number of new and acknowledged alarms for each severity.

Since:

JTGO 4.0

See Also:

Serialized Form

Constructor Summary

IltAlarmSummaryFunction()
The constructor.

Method Summary

String

getName() Retrieves the name of the function.

Methods inherited from class ilog.tgo.css.function.IltAbstractAlarmSummaryFunction

call, getDelimiters, returnDelimitersAsToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IltAlarmSummaryFunction

public IltAlarmSummaryFunction()

The constructor.

Method Detail

getName

public String getName()

Retrieves the name of the function.

Returns:

This method always returns "alarmSummary".