Class HistoryActorFactory
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.actor.HistoryActorFactory
-
- All Implemented Interfaces:
TagActorFactory
public class HistoryActorFactory extends java.lang.Object implements TagActorFactory
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
HistoryActorFactory.AbstractEvaluationContainer
protected class
HistoryActorFactory.ArrayHistorizer
protected class
HistoryActorFactory.AtomicHistorizer
protected class
HistoryActorFactory.DelayedAtomicHistorizer
This is used by delayed evaluators (periodic and tag group).protected class
HistoryActorFactory.DelayedEvaluationContainer
protected class
HistoryActorFactory.ErroredContainer
This can be used as a container when the configuration is incorrect.protected static interface
HistoryActorFactory.EvaluationContainer
Evaluation containers are created per tagprovider, historical provider, and sample mode.protected static interface
HistoryActorFactory.HistoryActor
protected class
HistoryActorFactory.OnChangeEvaluationContainer
protected class
HistoryActorFactory.PeriodicEvaluationContainer
protected class
HistoryActorFactory.TagGroupEvaluationContainer
static class
HistoryActorFactory.TagRetirementBatchOperation
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<Multikey,HistoryActorFactory.AbstractEvaluationContainer>
containers
-
Constructor Summary
Constructors Constructor Description HistoryActorFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc, PropertySet config)
Gives the actor factory a chance to report NodeAttribute traits for the tag it belongs to.void
configureTagGroupModel(MutableConfigurationPropertyModel model)
If specified, these properties will be merged into the main tag group configuration model.void
configureTagModel(MutableConfigurationPropertyModel model)
If specified, these properties will be merged into the main tag configuration model.TagActor
create(NodeContext context, PropertySet config)
Creates the actor for the given settings.protected void
execute(java.lang.Runnable task)
ActorClassification
getActorClassification()
Every tag can only have one of each actorTypeId.java.util.Set<Property<?>>
getMonitoredProperties()
These are the properties that this actor monitors for changes.protected HistoryActorFactory.AbstractEvaluationContainer
getOrCreateContainer(NodeContext context, PropertySet config)
This function validates group parameters, retrieves the right eval group, or creates one.boolean
isApplicable(PropertySet config)
Indicates that the PropertySet has settings that would result in this actor type being created.void
shutdown()
Indicates the provider or system is shutting down.void
startup(GatewayContext gwContext)
Called when the factory is registered, before any actors are created.-
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.TagActorFactory
getBrowseValue, getId, getKeyPropertyValues
-
-
-
-
Field Detail
-
containers
protected java.util.Map<Multikey,HistoryActorFactory.AbstractEvaluationContainer> containers
-
-
Method Detail
-
execute
protected void execute(java.lang.Runnable task)
-
getActorClassification
public ActorClassification getActorClassification()
Description copied from interface:TagActorFactory
Every tag can only have one of each actorTypeId. Note that actorId does not necessarily indicate a certain implementation, but instead a type of actor.- Specified by:
getActorClassification
in interfaceTagActorFactory
-
configureTagModel
public void configureTagModel(MutableConfigurationPropertyModel model)
Description copied from interface:TagActorFactory
If specified, these properties will be merged into the main tag configuration model. This occurs during registration. Once registered, there is no way to mutate the model apart from re-registering.- Specified by:
configureTagModel
in interfaceTagActorFactory
-
configureTagGroupModel
public void configureTagGroupModel(MutableConfigurationPropertyModel model)
Description copied from interface:TagActorFactory
If specified, these properties will be merged into the main tag group configuration model. This occurs during registration. Once registered, there is no way to mutate the model apart from re-registering.- Specified by:
configureTagGroupModel
in interfaceTagActorFactory
-
getMonitoredProperties
public java.util.Set<Property<?>> getMonitoredProperties()
Description copied from interface:TagActorFactory
These are the properties that this actor monitors for changes. This is used to optimize how factories/actors are managed after edits. Any property that the actor cares about (even system properties) should be represented in the returned Set, otherwise the actor will not be notified of edits.- Specified by:
getMonitoredProperties
in interfaceTagActorFactory
-
startup
public void startup(GatewayContext gwContext)
Description copied from interface:TagActorFactory
Called when the factory is registered, before any actors are created.- Specified by:
startup
in interfaceTagActorFactory
-
shutdown
public void shutdown()
Description copied from interface:TagActorFactory
Indicates the provider or system is shutting down. All of the tags may have been shut down, but at this point, the factory can stop doing anything.- Specified by:
shutdown
in interfaceTagActorFactory
-
isApplicable
public boolean isApplicable(PropertySet config)
Description copied from interface:TagActorFactory
Indicates that the PropertySet has settings that would result in this actor type being created.- Specified by:
isApplicable
in interfaceTagActorFactory
-
addBrowseTraits
public void addBrowseTraits(NodeDescription.NodeDescriptionBuilder desc, PropertySet config)
Description copied from interface:TagActorFactory
Gives the actor factory 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 interfaceTagActorFactory
-
create
public TagActor create(NodeContext context, PropertySet config)
Description copied from interface:TagActorFactory
Creates the actor for the given settings. isApplicable() has already been checked to confirm that this operation is valid. The actor should not be activated before it is returned.- Specified by:
create
in interfaceTagActorFactory
-
getOrCreateContainer
protected HistoryActorFactory.AbstractEvaluationContainer getOrCreateContainer(NodeContext context, PropertySet config)
This function validates group parameters, retrieves the right eval group, or creates one.
-
-