Class AbstractAlarmUtilities
- java.lang.Object
-
- com.inductiveautomation.ignition.common.script.builtin.AbstractAlarmUtilities
-
- Direct Known Subclasses:
ClientAlarmUtilities
public abstract class AbstractAlarmUtilities extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description AbstractAlarmUtilities()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
addPropSubCondition(AlarmFilter filter, PropertyCondition cond, java.lang.Object[] tuple, boolean required)
void
cancel(java.lang.String[] alarmIds)
protected abstract void
cancelImpl(java.util.Set<java.util.UUID> almIds)
protected AlarmFilter
createFilter(PyArgumentMap args, boolean history)
protected java.util.List<Path>
getPaths(java.lang.String[] paths)
abstract java.util.List<ShelvedPath>
getShelvedPaths()
static void
processPathCondition(java.lang.String[] raw, AlarmFilter target, Field field)
Processes QualifiedPath or display path conditions.static void
processStringEnumCondition(java.lang.String[] values, AlarmFilter target, Field field)
java.util.List<AlarmEvent>
queryJournal(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
protected abstract java.util.List<AlarmEvent>
queryJournalImpl(java.lang.String journalName, AlarmFilter filter)
java.util.List<AlarmEvent>
queryStatus(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
protected abstract java.util.List<AlarmEvent>
queryStatusImpl(AlarmFilter filter)
void
shelve(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
protected abstract void
shelveImpl(java.util.Collection<Path> paths, int timeoutSeconds)
void
unshelve(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
-
-
Method Detail
-
getShelvedPaths
public abstract java.util.List<ShelvedPath> getShelvedPaths() throws java.lang.Exception
- Throws:
java.lang.Exception
-
queryStatus
public java.util.List<AlarmEvent> queryStatus(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
queryJournal
public java.util.List<AlarmEvent> queryJournal(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
shelve
public void shelve(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
unshelve
public void unshelve(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
cancel
public void cancel(java.lang.String[] alarmIds) throws java.lang.Exception
- Throws:
java.lang.Exception
-
getPaths
protected java.util.List<Path> getPaths(java.lang.String[] paths)
-
addPropSubCondition
protected void addPropSubCondition(AlarmFilter filter, PropertyCondition cond, java.lang.Object[] tuple, boolean required)
-
createFilter
protected AlarmFilter createFilter(PyArgumentMap args, boolean history)
-
processStringEnumCondition
public static void processStringEnumCondition(java.lang.String[] values, AlarmFilter target, Field field)
-
processPathCondition
public static void processPathCondition(java.lang.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 java.util.List<AlarmEvent> queryStatusImpl(AlarmFilter filter) throws java.lang.Exception
- Throws:
java.lang.Exception
-
queryJournalImpl
protected abstract java.util.List<AlarmEvent> queryJournalImpl(java.lang.String journalName, AlarmFilter filter) throws java.lang.Exception
- Throws:
java.lang.Exception
-
shelveImpl
protected abstract void shelveImpl(java.util.Collection<Path> paths, int timeoutSeconds) throws java.lang.Exception
- Throws:
java.lang.Exception
-
cancelImpl
protected abstract void cancelImpl(java.util.Set<java.util.UUID> almIds) throws java.lang.Exception
- Throws:
java.lang.Exception
-
-