Class ActorClassification
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.tags.evaluation.ActorClassification
-
- All Implemented Interfaces:
java.lang.Comparable<ActorClassification>
public class ActorClassification extends java.lang.Object implements java.lang.Comparable<ActorClassification>
Tag actors are registered and organized according to their Classification. The classification simply dictates the name of a group of factories, and then their relative position. This is important because values are generated at level 0, and then are passed upwards- writes are handled in reverse.Module authors can register new actor factories for pre-defined classifications, or can create new classifications.
Classifications over 1000 should not mutate values, they should only observe values. For example, Alarming and History fall into this category. The only exception is Scripting, which is already handled separately anyhow. We do it like this because actors are always sorted by their position. By having observers be higher numbers, we can set the mutated tag value before processing through the observers.
- Since:
- 8.0
-
-
Field Summary
Fields Modifier and Type Field Description static ActorClassification
ALARMING
static ActorClassification
DEADBAND
static ActorClassification
ENGINEERING_LIMIT
static ActorClassification
HISTORY
static int
OBSERVER_POSITION_THRESHOLD
Above this position, actors should only observe.static ActorClassification
SCALE
static ActorClassification
SCRIPTING
static ActorClassification
SECURITY
static ActorClassification
VALUE
-
Constructor Summary
Constructors Constructor Description ActorClassification(java.lang.String id, int pos)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(ActorClassification o)
java.lang.String
getId()
int
getPosition()
boolean
isObserver()
Returns whether this classification only observes values, and doesn't mutate them.java.lang.String
toString()
-
-
-
Field Detail
-
OBSERVER_POSITION_THRESHOLD
public static final int OBSERVER_POSITION_THRESHOLD
Above this position, actors should only observe.- See Also:
- Constant Field Values
-
VALUE
public static final ActorClassification VALUE
-
SCALE
public static final ActorClassification SCALE
-
ENGINEERING_LIMIT
public static final ActorClassification ENGINEERING_LIMIT
-
DEADBAND
public static final ActorClassification DEADBAND
-
SECURITY
public static final ActorClassification SECURITY
-
ALARMING
public static final ActorClassification ALARMING
-
HISTORY
public static final ActorClassification HISTORY
-
SCRIPTING
public static final ActorClassification SCRIPTING
-
-
Method Detail
-
getId
public java.lang.String getId()
-
getPosition
public int getPosition()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compareTo
public int compareTo(ActorClassification o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<ActorClassification>
-
isObserver
public boolean isObserver()
Returns whether this classification only observes values, and doesn't mutate them. This is determined by its position.
-
-