IAFAnalysisRuleState Interface
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the interface for running an analysis against the state object.
The analysis rule Run method utilizes this object to maintain state between evaluations.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public interface IAFAnalysisRuleState
Public Interface IAFAnalysisRuleState Dim instance As IAFAnalysisRuleState
public interface class IAFAnalysisRuleState
type IAFAnalysisRuleState = interface end
The IAFAnalysisRuleState type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ChildAnalysisRuleState |
A list of the runtime state objects for the child analysis rules to use in configuring the specified analysis rule.
|
| EvaluationError |
An exception holding information about an error that occurred during evaluation.
|
| ExecutionTime |
The AFTime to execute the AFAnalysisRule at.
|
| Inputs |
A collection of input data for use in evaluating an AFAnalysisRule.
|
| Outputs |
A collection of output data where the result of an AFAnalysisRule evaluation should be written.
|
| PrivateData |
A location for a stateful AFAnalysisRule to store its instance-specific data.
|
| Status |
The status of the AFAnalysisRule.
|