Package com.inductiveautomation.ignition.client.script

Class ClientAlarmUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

com.inductiveautomation.ignition.client.script.ClientAlarmUtilities

public class ClientAlarmUtilities
extends AbstractAlarmUtilities

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

AbstractAlarmUtilities.PyAlarmEventAdapter

Constructor Summary

Constructors

Constructor	Description
ClientAlarmUtilities()

Method Summary

Modifier and Type	Method	Description
Set<UUID>	acknowledge(String[] alarmIds, String notes)
protected void	cancelImpl(Set<UUID> almIds)
List<ShelvedPath>	getShelvedPaths()
protected List<AlarmEvent>	queryJournalImpl(String journalName, AlarmFilter filter)
protected List<AlarmEvent>	queryStatusImpl(AlarmFilter filter)
protected void	shelveImpl(Collection<Path> paths, int timeoutSeconds)

Methods inherited from class com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities

addPropSubCondition, cancel, createFilter, getPaths, processPathCondition, processStringEnumCondition, queryJournal, queryStatus, shelve, unshelve

Methods inherited from class java.lang.Object

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

Constructor Details

ClientAlarmUtilities

public ClientAlarmUtilities()

Method Details

getShelvedPaths

public List<ShelvedPath> getShelvedPaths()
                                  throws Exception

Specified by:

getShelvedPaths in class AbstractAlarmUtilities

Throws:

Exception

queryStatusImpl

protected List<AlarmEvent> queryStatusImpl(AlarmFilter filter)
                                    throws Exception

Specified by:

queryStatusImpl in class AbstractAlarmUtilities

Throws:

Exception

queryJournalImpl

protected List<AlarmEvent> queryJournalImpl(String journalName,
 AlarmFilter filter)
                                     throws Exception

Specified by:

queryJournalImpl in class AbstractAlarmUtilities

Throws:

Exception

shelveImpl

protected void shelveImpl(Collection<Path> paths,
 int timeoutSeconds)
                   throws Exception

Specified by:

shelveImpl in class AbstractAlarmUtilities

Throws:

Exception

cancelImpl

protected void cancelImpl(Set<UUID> almIds)
                   throws Exception

Specified by:

cancelImpl in class AbstractAlarmUtilities

Throws:

Exception

acknowledge

public Set<UUID> acknowledge(String[] alarmIds,
 String notes)
                      throws Exception

Throws:

Exception