Package com.inductiveautomation.ignition.common.script.builtin

Class AbstractAlarmUtilities

java.lang.Object

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

Direct Known Subclasses:

ClientAlarmUtilities

public abstract class AbstractAlarmUtilities
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractAlarmUtilities.PyAlarmEventAdapter

Constructor Summary

Constructors

Constructor	Description
AbstractAlarmUtilities()

Method Summary

Modifier and Type	Method	Description
protected void	addPropSubCondition(AlarmFilter filter, PropertyCondition cond, Object[] tuple, boolean required)
void	cancel(String[] alarmIds)
protected abstract void	cancelImpl(Set<UUID> almIds)
protected AlarmFilter	createFilter(PyArgumentMap args, boolean history)
protected List<Path>	getPaths(String[] paths)
abstract List<ShelvedPath>	getShelvedPaths()
static void	processPathCondition(String[] raw, AlarmFilter target, Field field)	Processes QualifiedPath or display path conditions.
static void	processStringEnumCondition(String[] values, AlarmFilter target, Field field)
List<AlarmEvent>	queryJournal(org.python.core.PyObject[] pyArgs, String[] keywords)
protected abstract List<AlarmEvent>	queryJournalImpl(String journalName, AlarmFilter filter)
List<AlarmEvent>	queryStatus(org.python.core.PyObject[] pyArgs, String[] keywords)
protected abstract List<AlarmEvent>	queryStatusImpl(AlarmFilter filter)
void	shelve(org.python.core.PyObject[] pyArgs, String[] keywords)
protected abstract void	shelveImpl(Collection<Path> paths, int timeoutSeconds)
void	unshelve(org.python.core.PyObject[] pyArgs, String[] keywords)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractAlarmUtilities

public AbstractAlarmUtilities()

Method Details

getShelvedPaths

public abstract List<ShelvedPath> getShelvedPaths()
                                           throws Exception

Throws:

Exception

queryStatus

public List<AlarmEvent> queryStatus(org.python.core.PyObject[] pyArgs,
 String[] keywords)

queryJournal

public List<AlarmEvent> queryJournal(org.python.core.PyObject[] pyArgs,
 String[] keywords)

shelve

public void shelve(org.python.core.PyObject[] pyArgs,
 String[] keywords)

unshelve

public void unshelve(org.python.core.PyObject[] pyArgs,
 String[] keywords)

cancel

public void cancel(String[] alarmIds)
            throws Exception

Throws:

Exception

getPaths

protected List<Path> getPaths(String[] paths)

addPropSubCondition

protected void addPropSubCondition(AlarmFilter filter,
 PropertyCondition cond,
 Object[] tuple,
 boolean required)

createFilter

protected AlarmFilter createFilter(PyArgumentMap args,
 boolean history)

processStringEnumCondition

public static void processStringEnumCondition(String[] values,
 AlarmFilter target,
 Field field)

processPathCondition

public static void processPathCondition(String[] raw,
 AlarmFilter target,
 Field field)

Processes QualifiedPath or display path conditions. The boolean parameter indicates which it is for the current call.

queryStatusImpl

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

Throws:

Exception

queryJournalImpl

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

Throws:

Exception

shelveImpl

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

Throws:

Exception

cancelImpl

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

Throws:

Exception