AFAnalysisRuleConfiguration Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysisRuleConfiguration object is populated by an analysis rule to describe the inputs and outputs
the analysis rule needs to run.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFAnalysisRuleConfiguration
OSIsoft.AF.AnalysisAFAnalysisRuleConfiguration
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFAnalysisRuleConfiguration
Public NotInheritable Class AFAnalysisRuleConfiguration Dim instance As AFAnalysisRuleConfiguration
public ref class AFAnalysisRuleConfiguration sealed
[<SealedAttribute>] type AFAnalysisRuleConfiguration = class end
The AFAnalysisRuleConfiguration type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AnalysisRule |
The AFAnalysisRule this configuration was done against.
|
| ChildAnalysisRuleConfiguration |
A list of the configuration of child analysis rules to use in configuring the specified analysis rule.
|
| ConfigurationExceptions |
A collection of configuration exceptions reported by the AFAnalysisRule during initialization.
|
| HasExceptions |
True if the analysis rule reported any configuration exceptions.
|
| IsValid |
Returns true if the analysis rule can be run
|
| PrivateData |
A location for a stateful AFAnalysisRule to store its initialized instance-specific data.
|
| ReferencedObjects |
Gets the AFObjects that are relevant for the evaluation of the AFAnalysisRule.
Changes to these objects might invalidate this AFAnalysisRuleConfiguration.
|
| ResolvedInputs |
A read-only list of inputs defined.
|
| ResolvedOutputs |
A read-only list of outputs defined.
|
| Target |
The target that the AFAnalysisRule should configure itself against.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetAllReferencedObjects |
Gets referenced objects for this AFAnalysisRule and all descendant rules.
|
| GetAllResolvedInputs |
Gets all defined inputs for this AFAnalysisRule and all descendant rules.
|
| GetAllResolvedOutputs |
Gets all defined outputs for this AFAnalysisRule and all descendant rules.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInputs |
Gets inputs for this AFAnalysisRule and all descendant rules.
|
| GetOutputs |
Gets outputs for this AFAnalysisRule and all descendant rules.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | ResolveConfiguration |
Initializes the analysis rule configuration AFAnalysisRuleConfiguration objects from the specified variable definitions.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |