API Docs for: TWaver HTML5 5.7.5
Show:

twaver.AlarmState Class

告警状态对象

该类是用于描述网元告警状态的数据模型，包含该网元上的最高告警级别，最高传递告警级别，有多少个新发告警，多个确认告警等信息。

在TWaver，如果想添加告警，可以通过在AlarmBox中添加一个Alarm或者可以在AlarmState上添加告警。两者都会达到添加告警的效果，但是需要注意的是使用Alarm对象会更改并存储关于告警的信息，而AlarmState上只是存储了告警的级别和数量。

一般AlarmState用于存储已发生的历史告警

Constructor

twaver.AlarmState

(
  • element
)
twaver.AlarmState

Parameters:

Returns:

twaver.AlarmState:

告警级别对象本身

Methods

twaver.AlarmState.acknowledgeAlarm

(
  • severity
)

确认某个告警级别的一个告警，调用这个方法后，网元上的新发告警数量会减一，确认告警的数量会加一

Parameters:

twaver.AlarmState.acknowledgeAllAlarms

(
  • severity
)

确认网元上某个告警级别的所有告警，调用这个方法后，网元上这种告警级别的所有新发告警数量都增加到确认告警的数量上，新发告警的数量则变为零

Parameters:

twaver.AlarmState.clear

()

清除所有的告警状态

twaver.AlarmState.decreaseAcknowledgedAlarm

(
  • severity
  • [decrement]
)

减少指定告警级别的确认告警的数量

Parameters:

  • severity twaver.AlarmSeverity

    告警级别

  • [decrement] Number optional

    减少了的确认告警的数量，为空时数量为1

twaver.AlarmState.decreaseNewAlarm

(
  • severity
  • [decrement]
)

减少指定告警级别的新发告警的数量

Parameters:

  • severity twaver.AlarmSeverity

    告警级别

  • [decrement] Number optional

    减少的新发告警的数量，为空时数量为1

twaver.AlarmState.getAcknowledgedAlarmCount

(
  • severity
)
Number

获取指定级别的确认告警的数量

Parameters:

Returns:

Number:

指定级别的确认告警的数量

twaver.AlarmState.getAlarmCount

(
  • severity
)
Number

获取指定告警级别的数量，包括新发告警和确认告警

Parameters:

Returns:

Number:

告警级别的数量

twaver.AlarmState.getClassName

() String

获取告警状态类的名称

Returns:

String:

类名

twaver.AlarmState.getHighestAcknowledgedAlarmSeverity

() twaver.AlarmSeverity

获取最高级别的确认告警

Returns:

twaver.AlarmSeverity:

告警级别

twaver.AlarmState.getHighestNativeAlarmSeverity

() twaver.AlarmSeverity

获取本地告警中最高级别的告警，包括新发告警和确认告警

Returns:

twaver.AlarmSeverity:

最高级别的告警

twaver.AlarmState.getHighestNewAlarmSeverity

() twaver.AlarmSeverity

获取最高级别的新发告警

Returns:

twaver.AlarmSeverity:

告警级别

twaver.AlarmState.getHighestOverallAlarmSeverity

() twaver.AlarmSeverity

获取最高级别的告警。包括新发告警，确认告警和传递告警之间的比较

Returns:

twaver.AlarmSeverity:

告警级别

twaver.AlarmState.getNewAlarmCount

(
  • [severity]
)
Number

获取指定告警级别新发告警的数量

Parameters:

  • [severity] twaver.AlarmSeverity optional

    告警级别，为空时获取的是所有的告警级别

Returns:

Number:

告警级别的数量

twaver.AlarmState.getPropagateSeverity

() twaver.AlarmSeverity

获取传播告警的级别。网元上的传播告警级别默认是取的孩子上的最高告警级别

Returns:

twaver.AlarmSeverity:

传播告警的级别

twaver.AlarmState.hasLessSevereNewAlarms

() Boolean

是否显示告警级别较低的新发告警:TWaver是对最高级别的新发告警的网元进行渲染。如果返回值为true，告警冒泡中将会在文本最后显示"+"，来表示还有更多的告警级别较低的新发告警

Returns:

Boolean:

如果返回值为true，告警冒泡中将会在文本最后显示"+"，表示还有更多的告警级别较低的新发告警。返回flase，告警冒泡中只显示最高级别的告警信息

twaver.AlarmState.increaseAcknowledgedAlarm

(
  • severity
  • increment
)

增加指定告警级别的确认告警的数量

Parameters:

twaver.AlarmState.increaseNewAlarm

(
  • severity
  • [increment]
)

增加指定告警级别的新发告警的数量

Parameters:

  • severity twaver.AlarmSeverity

    告警级别

  • [increment] Number optional

    增加的新发告警的数量，为空时数量为1

twaver.AlarmState.isEmpty

() Boolean

判断告警状态是否为空，为空代表没有任何告警

Returns:

Boolean:

true为没有任何告警，否则为false

twaver.AlarmState.isEnablePropagation

() Boolean

是否允许传播告警

Returns:

Boolean:

如果孩子的告警可以传播到父亲上，返回true；否则为false

twaver.AlarmState.removeAllAcknowledgedAlarms

(
  • severity
)

删除指定告警级别的所有确认告警

Parameters:

twaver.AlarmState.removeAllNewAlarms

(
  • severity
)

删除指定告警级别的所有新发告警

Parameters:

twaver.AlarmState.setAcknowledgedAlarmCount

(
  • severity
  • count
)

设置指定级别的确认告警的数量

Parameters:

twaver.AlarmState.setEnablePropagation

(
  • enablePropagation
)

设置是否允许传播告警

Parameters:

  • enablePropagation Boolean

    如果孩子的告警可以传播到父亲上，则为true，否则为false

twaver.AlarmState.setNewAlarmCount

(
  • severity
  • count
)

设置指定级别的新发告警的数量

Parameters:

twaver.AlarmState.setPropagateSeverity

(
  • propagateSeverity
)

设置传播告警的级别。网元上的传播告警级别默认是取的孩子上的最高告警级别

Parameters: