Package com.inductiveautomation.historian.gateway.tags.actor

Class ArrayHistoryActor

java.lang.Object
com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActor>
com.inductiveautomation.historian.gateway.tags.actor.ArrayHistoryActor
All Implemented Interfaces:
EvaluationContainer, HistoryActor, Diagnosable, LicenseStateUpdateListener, TagActor, EventListener
public class ArrayHistoryActor extends com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActor> implements HistoryActor, Diagnosable, EvaluationContainer

  • Constructor Details

  • Method Details

    • getCollectionMode

      public CollectionMode getCollectionMode()
      Specified by:
      getCollectionMode in interface EvaluationContainer

    • getCollectionSession

      public DataCollector getCollectionSession()
      Specified by:
      getCollectionSession in interface EvaluationContainer

    • start

      public void start(NodeContext nc, DataCollector session) throws Exception
      Specified by:
      start in interface EvaluationContainer
      Throws:
      Exception

    • shutdown

      public void shutdown() throws Exception
      Specified by:
      shutdown in interface EvaluationContainer
      Throws:
      Exception

    • getActorCount

      public int getActorCount()
      Specified by:
      getActorCount in interface EvaluationContainer

    • 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 interface TagActor

    • getLogger

      protected LoggerEx getLogger()
      Specified by:
      getLogger in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActor>

    • initialize

      public void initialize(NodeContext context, BoundPropertySet 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 interface TagActor

    • 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 interface TagActor

    • getPath

      protected QualifiedPath getPath(int index)
      Returns a source for the indexed item, as if it were a top level tag.

    • createEvaluator

      protected HistoryActor createEvaluator(int index)
      This is an "array evaluator", so we create an evaluator for each element- in our case, a HistoryActor for the atomic unit.
      Specified by:
      createEvaluator in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<HistoryActor>

    • destroyEvaluator

      protected void destroyEvaluator(HistoryActor evaluator, int index)
      Specified by:
      destroyEvaluator in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<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 interface TagActor

    • evaluate

      protected void evaluate(HistoryActor evaluator, int index, QualifiedValue arrayValue)
      Specified by:
      evaluate in class com.inductiveautomation.ignition.gateway.tags.actors.ArrayEvaluator<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.
      Specified by:
      destroy in interface TagActor

    • 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 call getSubSample() in order to specify a useful identifier for this object's data.
      Specified by:
      sampleDiagnostics in interface Diagnosable

    • addActor

      public void addActor(HistoryActor actor)
      Specified by:
      addActor in interface EvaluationContainer

    • removeActor

      public void removeActor(HistoryActor actor)
      Specified by:
      removeActor in interface EvaluationContainer

    • getContainerSettings

      public PropertySet getContainerSettings()
      Specified by:
      getContainerSettings in interface EvaluationContainer

    • getProviderContext

      public ProviderContext getProviderContext()
      Specified by:
      getProviderContext in interface EvaluationContainer

    • isInvalid

      public boolean isInvalid(PropertySet config)
      Specified by:
      isInvalid in interface EvaluationContainer

    • configureGroupSettings

      public void configureGroupSettings(TagGroup group)
      Specified by:
      configureGroupSettings in interface 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 interface TagActor

    • licenseStateUpdated

      public void licenseStateUpdated(LicenseStateUpdateEvent e)
      Description copied from interface: LicenseStateUpdateListener
      The LicenseState for the module specified in the LicenseStateChangeEvent has been updated. Module id of empty-string represents the license state for the Ignition platform itself.
      Specified by:
      licenseStateUpdated in interface LicenseStateUpdateListener
      Parameters:
      e - The LicenseStateUpdateEvent