protected class HistoryActorFactory.ArrayHistorizer extends com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor> implements HistoryActorFactory.HistoryActor, Diagnosable, HistoryActorFactory.EvaluationContainer
Constructor and Description |
---|
ArrayHistorizer(HistoryActorFactory.EvaluationContainer container,
TagPath rootPath) |
Modifier and Type | Method and Description |
---|---|
ActorClassification |
actorClassification()
The classification of this actor.
|
void |
add(HistoryActorFactory.HistoryActor actor) |
boolean |
attemptConfiguration(NodeContext context,
VersionedPropertySet config)
Provides an opportunity to update the running actor on the fly.
|
void |
configureGroupSettings(TagGroup group) |
protected HistoryActorFactory.HistoryActor |
createEvaluator(int index) |
void |
destroy(NodeContext context,
ShutdownReason reason)
Override to perform cleanup for actors that have set up extra configuration to process values.
|
protected void |
destroyEvaluator(HistoryActorFactory.HistoryActor evaluator,
int index) |
protected void |
evaluate(HistoryActorFactory.HistoryActor evaluator,
int index,
QualifiedValue arrayValue) |
void |
getBrowseTraits(java.util.List<NodeAttribute> attributes)
Gives the actor a chance to report NodeAttribute traits for the tag it belongs to.
|
PropertySet |
getContainerSettings() |
protected LoggerEx |
getLogger() |
protected TagPath |
getPath(int index) |
void |
initialize(NodeContext context,
PropertySet configuration)
Override to set up any extra configuration that is needed before the actor can process a value.
|
HistoryActorFactory.HistoryActor |
instantiateAtomicActor(HistoryActorFactory.EvaluationContainer container,
TagPath path) |
boolean |
isValid(PropertySet config) |
QualifiedValue |
processValue(QualifiedValue value)
The value is generated by the source actor and then passed along to the next actor.
|
void |
queueForStorage(java.util.List<HistoricalTagValue> value) |
void |
remove(HistoryActorFactory.HistoryActor actor) |
void |
sampleDiagnostics(DiagnosticsSample sample)
Provides the sample upon which the object can set diagnostics information.
|
evaluate, getCurrentCount, getEvaluators, getMaxCount, validateEvaluators, validateFor
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getBrowsableProperties, onLeasedChanged, onPathChanged
public ArrayHistorizer(HistoryActorFactory.EvaluationContainer container, TagPath rootPath)
public ActorClassification actorClassification()
TagActor
actorClassification
in interface TagActor
protected LoggerEx getLogger()
getLogger
in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
public void initialize(NodeContext context, PropertySet configuration)
TagActor
initialize
in interface TagActor
public boolean attemptConfiguration(NodeContext context, VersionedPropertySet config)
TagActor
Therefore, the implementation should also verify that the configuration is still valid for this actor.
The config object provide is the entire configuration for the tag. However, it is provided as a Diff, which is relative to the last time configuration was attempted. This allows actors to quickly see if relevant properties have changed. Many actors will choose to simply rebuild themselves if the properties have changed, but given how often this function is called, it's important not to rebuild unnecessarily (hence, check the changed properties).
attemptConfiguration
in interface TagActor
protected TagPath getPath(int index)
protected HistoryActorFactory.HistoryActor createEvaluator(int index)
createEvaluator
in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
protected void destroyEvaluator(HistoryActorFactory.HistoryActor evaluator, int index)
destroyEvaluator
in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
public QualifiedValue processValue(QualifiedValue value)
TagActor
processValue
in interface TagActor
protected void evaluate(HistoryActorFactory.HistoryActor evaluator, int index, QualifiedValue arrayValue)
evaluate
in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
public void destroy(NodeContext context, ShutdownReason reason)
TagActor
public void sampleDiagnostics(DiagnosticsSample sample)
Diagnosable
sampleDiagnostics
in interface Diagnosable
public void add(HistoryActorFactory.HistoryActor actor)
add
in interface HistoryActorFactory.EvaluationContainer
public void remove(HistoryActorFactory.HistoryActor actor)
remove
in interface HistoryActorFactory.EvaluationContainer
public PropertySet getContainerSettings()
getContainerSettings
in interface HistoryActorFactory.EvaluationContainer
public void queueForStorage(java.util.List<HistoricalTagValue> value)
queueForStorage
in interface HistoryActorFactory.EvaluationContainer
public HistoryActorFactory.HistoryActor instantiateAtomicActor(HistoryActorFactory.EvaluationContainer container, TagPath path)
instantiateAtomicActor
in interface HistoryActorFactory.EvaluationContainer
public boolean isValid(PropertySet config)
isValid
in interface HistoryActorFactory.EvaluationContainer
public void configureGroupSettings(TagGroup group)
configureGroupSettings
in interface HistoryActorFactory.HistoryActor
public void getBrowseTraits(java.util.List<NodeAttribute> attributes)
TagActor
getBrowseTraits
in interface TagActor