Class HistoryActorFactory.AtomicHistorizer
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.actor.HistoryActorFactory.AtomicHistorizer
-
- All Implemented Interfaces:
HistoryActorFactory.HistoryActor
,Diagnosable
,TagActor
- Direct Known Subclasses:
HistoryActorFactory.DelayedAtomicHistorizer
- Enclosing class:
- HistoryActorFactory
protected class HistoryActorFactory.AtomicHistorizer extends java.lang.Object implements HistoryActorFactory.HistoryActor, Diagnosable
-
-
Constructor Summary
Constructors Constructor Description AtomicHistorizer(HistoryActorFactory.EvaluationContainer container, TagPath path)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActorClassification
actorClassification()
The classification of this 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.protected void
configure(PropertySet config)
void
configureGroupSettings(TagGroup group)
void
destroy(NodeContext context, ShutdownReason reason)
Override to perform cleanup for actors that have set up extra configuration to process values.protected java.util.List<HistoricalTagValue>
generateHtv(java.util.List<QualifiedValue> values)
protected boolean
hasChanged(PropertySet config, Property<?> prop)
protected boolean
hasChanged(PropertySet config, java.util.Collection<Property<?>> props)
void
initialize(NodeContext context, PropertySet config)
Override to set up any extra configuration that is needed before the actor can process a value.QualifiedValue
processValue(QualifiedValue value)
The value is generated by the source actor and then passed along to the next actor.protected void
queue(java.util.List<HistoricalTagValue> values)
void
sampleDiagnostics(DiagnosticsSample sample)
Provides the sample upon which the object can set diagnostics information.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inductiveautomation.ignition.gateway.tags.evaluation.TagActor
onLeasedChanged, onPathChanged
-
-
-
-
Constructor Detail
-
AtomicHistorizer
public AtomicHistorizer(HistoryActorFactory.EvaluationContainer container, TagPath path)
-
-
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
-
hasChanged
protected boolean hasChanged(PropertySet config, Property<?> prop)
-
hasChanged
protected boolean hasChanged(PropertySet config, java.util.Collection<Property<?>> props)
-
initialize
public void initialize(NodeContext context, PropertySet config)
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
-
configureGroupSettings
public void configureGroupSettings(TagGroup group)
- Specified by:
configureGroupSettings
in interfaceHistoryActorFactory.HistoryActor
-
configure
protected void configure(PropertySet config)
-
generateHtv
protected java.util.List<HistoricalTagValue> generateHtv(java.util.List<QualifiedValue> values)
-
queue
protected void queue(java.util.List<HistoricalTagValue> values) throws java.lang.Exception
- Throws:
java.lang.Exception
-
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
-
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
-
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
-
-