com.inductiveautomation.ignition.common.alarming.config

Interface AlarmConfiguration

All Superinterfaces:

Countable, Mergable<AlarmConfiguration>, java.io.Serializable

All Known Implementing Classes:

AlarmConfigurationConfig, AlarmConfigurationDiff, BasicAlarmConfiguration, ExtendedAlarmConfiguration, IntersectedAlarmConfiguration

public interface AlarmConfiguration
extends java.io.Serializable, Countable, Mergable<AlarmConfiguration>

An alarm configuration is simply a set of AlarmDefinitions (that is, the definitions for various alarms) for a specific object. However, the definition is an interface, because the AlarmConfiguration supports the Config pattern of editing, and individual alarm config overridding for UDTs.

Method Summary

Modifier and Type	Method and Description
void	add(AlarmDefinition definition)
boolean	contains(java.lang.String name)
AlarmDefinition	get(java.lang.String name)
java.util.List<AlarmDefinition>	getDefinitions()
boolean	isInherited(AlarmDefinition definition)
boolean	isOverridden(AlarmDefinition definition)
void	remove(java.lang.String name)

Methods inherited from interface com.inductiveautomation.ignition.common.config.Countable

getCount

Methods inherited from interface com.inductiveautomation.ignition.common.config.Mergable

merge

Method Detail

getDefinitions

java.util.List<AlarmDefinition> getDefinitions()

get

AlarmDefinition get(java.lang.String name)

add

void add(AlarmDefinition definition)

remove

void remove(java.lang.String name)

contains

boolean contains(java.lang.String name)

isOverridden

boolean isOverridden(AlarmDefinition definition)

isInherited

boolean isInherited(AlarmDefinition definition)