Class HistoryActorFactory.ArrayHistorizer
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
-
- com.inductiveautomation.gateway.tags.history.actor.HistoryActorFactory.ArrayHistorizer
-
- All Implemented Interfaces:
HistoryActorFactory.EvaluationContainer
,HistoryActorFactory.HistoryActor
,Diagnosable
,TagActor
- Enclosing class:
- HistoryActorFactory
protected class HistoryActorFactory.ArrayHistorizer extends com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor> implements HistoryActorFactory.HistoryActor, Diagnosable, HistoryActorFactory.EvaluationContainer
-
-
Constructor Summary
Constructors Constructor Description ArrayHistorizer(HistoryActorFactory.EvaluationContainer container, TagPath rootPath)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActorClassification
actorClassification()
The classification of this actor.void
add(HistoryActorFactory.HistoryActor actor)
void
addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc)
Gives the actor a chance to report NodeAttribute traits for the tag it belongs to.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)
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
queueRetirement(TagPath path)
void
remove(HistoryActorFactory.HistoryActor actor)
void
sampleDiagnostics(DiagnosticsSample sample)
Provides the sample upon which the object can set diagnostics information.-
Methods inherited from class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator
evaluate, getCurrentCount, getEvaluators, getMaxCount, validateEvaluators, validateFor
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.gateway.tags.history.actor.HistoryActorFactory.EvaluationContainer
getTimestampSource
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.tags.evaluation.TagActor
onLeasedChanged, onPathChanged
-
-
-
-
Constructor Detail
-
ArrayHistorizer
public ArrayHistorizer(HistoryActorFactory.EvaluationContainer container, TagPath rootPath)
-
-
Method Detail
-
actorClassification
public ActorClassification actorClassification()
Description copied from interface:TagActor
The classification of this actor. A tag can only have one actor per classification.- Specified by:
actorClassification
in interfaceTagActor
-
getLogger
protected LoggerEx getLogger()
- Specified by:
getLogger
in classcom.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
-
initialize
public void initialize(NodeContext context, PropertySet configuration)
Description copied from interface:TagActor
Override to set up any extra configuration that is needed before the actor can process a value. It should be expected that the configuration has NOT been altered since the actor was instantiated.- Specified by:
initialize
in interfaceTagActor
-
attemptConfiguration
public boolean attemptConfiguration(NodeContext context, VersionedPropertySet config)
Description copied from interface:TagActor
Provides an opportunity to update the running actor on the fly. If FALSE is returned from this class, the actor will be uninitialized, and if appropriate, a new one created.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).
- Specified by:
attemptConfiguration
in interfaceTagActor
-
getPath
protected TagPath getPath(int index)
-
createEvaluator
protected HistoryActorFactory.HistoryActor createEvaluator(int index)
- Specified by:
createEvaluator
in classcom.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
-
destroyEvaluator
protected void destroyEvaluator(HistoryActorFactory.HistoryActor evaluator, int index)
- Specified by:
destroyEvaluator
in classcom.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
-
processValue
public QualifiedValue processValue(QualifiedValue value)
Description copied from interface:TagActor
The value is generated by the source actor and then passed along to the next actor. If the return is null, the value change will be cancelled.- Specified by:
processValue
in interfaceTagActor
-
evaluate
protected void evaluate(HistoryActorFactory.HistoryActor evaluator, int index, QualifiedValue arrayValue)
- Specified by:
evaluate
in classcom.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActorFactory.HistoryActor>
-
destroy
public void destroy(NodeContext context, ShutdownReason reason)
Description copied from interface:TagActor
Override to perform cleanup for actors that have set up extra configuration to process values.
-
sampleDiagnostics
public void sampleDiagnostics(DiagnosticsSample sample)
Description copied from interface:Diagnosable
Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first callgetSubSample()
in order to specify a useful identifier for this object's data.- Specified by:
sampleDiagnostics
in interfaceDiagnosable
-
add
public void add(HistoryActorFactory.HistoryActor actor)
- Specified by:
add
in interfaceHistoryActorFactory.EvaluationContainer
-
remove
public void remove(HistoryActorFactory.HistoryActor actor)
- Specified by:
remove
in interfaceHistoryActorFactory.EvaluationContainer
-
getContainerSettings
public PropertySet getContainerSettings()
- Specified by:
getContainerSettings
in interfaceHistoryActorFactory.EvaluationContainer
-
queueForStorage
public void queueForStorage(java.util.List<HistoricalTagValue> value) throws java.lang.Exception
- Specified by:
queueForStorage
in interfaceHistoryActorFactory.EvaluationContainer
- Throws:
java.lang.Exception
-
queueRetirement
public void queueRetirement(TagPath path)
- Specified by:
queueRetirement
in interfaceHistoryActorFactory.EvaluationContainer
-
instantiateAtomicActor
public HistoryActorFactory.HistoryActor instantiateAtomicActor(HistoryActorFactory.EvaluationContainer container, TagPath path)
- Specified by:
instantiateAtomicActor
in interfaceHistoryActorFactory.EvaluationContainer
-
isValid
public boolean isValid(PropertySet config)
- Specified by:
isValid
in interfaceHistoryActorFactory.EvaluationContainer
-
configureGroupSettings
public void configureGroupSettings(TagGroup group)
- Specified by:
configureGroupSettings
in interfaceHistoryActorFactory.HistoryActor
-
addBrowseTraits
public void addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc)
Description copied from interface:TagActor
Gives the actor a chance to report NodeAttribute traits for the tag it belongs to. NodeAttributes are registered in the designer in order to modify the display of browse nodes.- Specified by:
addBrowseTraits
in interfaceTagActor
-
-