AFAnalysisRuleState Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
A reference implementation of IAFAnalysisRuleState for passing target-specific state to an AFAnalysisRule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFAnalysisRuleState
OSIsoft.AF.AnalysisAFAnalysisRuleState
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFAnalysisRuleState : IAFAnalysisRuleState
Public NotInheritable Class AFAnalysisRuleState Implements IAFAnalysisRuleState Dim instance As AFAnalysisRuleState
public ref class AFAnalysisRuleState sealed : IAFAnalysisRuleState
[<SealedAttribute>] type AFAnalysisRuleState = class interface IAFAnalysisRuleState end
The AFAnalysisRuleState type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAnalysisRuleState(AFAnalysisRule) |
Construct the state object from the AFAnalysisRule.
|
| AFAnalysisRuleState(AFAnalysisRuleConfiguration) |
Construct the state object from an AFAnalysisRuleConfiguration that has been initialized.
|
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.
|
| Status |
The status of the AFAnalysisRule.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Reset |
Clear output values and error states. Call to put the state object in a clean state before evaluating.
|
| SetExecutionTimeAndPopulateInputs |
Populates input data with values obtained at the specified execution time.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |