Package com.inductiveautomation.ignition.common.alarming.config

Interface AlarmConfiguration

All Superinterfaces:

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

All Known Implementing Classes:

AlarmConfigurationConfig, AlarmConfigurationDiff, BasicAlarmConfiguration, ExtendedAlarmConfiguration, IntersectedAlarmConfiguration

public interface AlarmConfiguration
extends java.io.Serializable, Countable, Mergable<AlarmConfiguration>, Extendable<AlarmConfiguration>, Intersectable<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	Description
void	add(AlarmDefinition definition)
boolean	contains(java.lang.String name)
default AlarmConfiguration	extend(AlarmConfiguration parent)	If called on a child, gets the extension with the given parent.
AlarmDefinition	get(java.lang.String name)
java.util.List<AlarmDefinition>	getDefinitions()
default AlarmConfiguration	getExtension()	This returns an object that represents the value only for the most "local" level.
default AlarmConfiguration	intersect(java.util.List<AlarmConfiguration> values)
boolean	isInherited(AlarmDefinition definition)
boolean	isOverridden(AlarmDefinition definition)
default void	merge(AlarmConfiguration other, boolean localOnly)	Merges the values from other collection into this one.
default AlarmConfiguration	newExtension()	Called on a base object, gets a new extension with a default config object for the child.
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)

newExtension

default AlarmConfiguration newExtension()

Description copied from interface: Extendable

Called on a base object, gets a new extension with a default config object for the child.

Specified by:

newExtension in interface Extendable<AlarmConfiguration>

extend

default AlarmConfiguration extend(AlarmConfiguration parent)

Description copied from interface: Extendable

If called on a child, gets the extension with the given parent.

Specified by:

extend in interface Extendable<AlarmConfiguration>

getExtension

default AlarmConfiguration getExtension()

Description copied from interface: Extendable

This returns an object that represents the value only for the most "local" level. That is, this is the difference between the inherited base and the current extension. Complex objects should ensure that trait is true for all aspects of the returned value.

Specified by:

getExtension in interface Extendable<AlarmConfiguration>

intersect

default AlarmConfiguration intersect(java.util.List<AlarmConfiguration> values)

Specified by:

intersect in interface Intersectable<AlarmConfiguration>

merge

default void merge(AlarmConfiguration other,
                   boolean localOnly)

Description copied from interface: Mergable

Merges the values from other collection into this one. Replaces any currently existing value with those from the other set.

Specified by:

merge in interface Mergable<AlarmConfiguration>