AFAnalysisRuleVariableDefinitions 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.AnalysisAFAnalysisRuleVariableDefinitions
OSIsoft.AF.AnalysisAFAnalysisRuleVariableDefinitions
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFAnalysisRuleVariableDefinitions
Public NotInheritable Class AFAnalysisRuleVariableDefinitions Dim instance As AFAnalysisRuleVariableDefinitions
public ref class AFAnalysisRuleVariableDefinitions sealed
[<SealedAttribute>] type AFAnalysisRuleVariableDefinitions = class end
The AFAnalysisRuleVariableDefinitions type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| AFAnalysisRuleVariableDefinitions(AFAnalysisRule) |
Constructs an instance of AFAnalysisRuleVariableDefinitions using the specified
AFAnalysisRule.
| |
| AFAnalysisRuleVariableDefinitions(AFAnalysisRule, AFObject) |
Constructs an instance of AFAnalysisRuleVariableDefinitions using the specified
AFAnalysisRule and the specified target.
|
Properties
| Name | Description | |
|---|---|---|
| AnalysisRule |
The AFAnalysisRule this configuration was done against.
| |
| ChildAnalysisRuleVariableDefinitions |
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.
| |
| Inputs |
A collection of input variables used by an AFAnalysisRule.
| |
| IsInputResolutionSuppressed |
True if the outputs of the analysis rule should be resolved
| |
| IsOutputResolutionSuppressed |
True if the outputs of the analysis rule should be resolved
| |
| Outputs |
A collection of output variables used by an AFAnalysisRule.
| |
| PrivateData |
A location for a stateful AFAnalysisRule to store its instance-specific data.
| |
| 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.) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |