AFAnalysisRuleOutputDefinition Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines an output from an AFAnalysisRule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFAnalysisRuleOutputDefinition
OSIsoft.AF.AnalysisAFAnalysisRuleOutputDefinition
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFAnalysisRuleOutputDefinition
Public NotInheritable Class AFAnalysisRuleOutputDefinition Dim instance As AFAnalysisRuleOutputDefinition
public ref class AFAnalysisRuleOutputDefinition sealed
[<SealedAttribute>] type AFAnalysisRuleOutputDefinition = class end
The AFAnalysisRuleOutputDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAnalysisRuleOutputDefinition(String, AFAnalysisOutputType, String, String) |
Defines an output from an AFAnalysisRule with no variable mapping data specified.
|
| AFAnalysisRuleOutputDefinition(AFVariableMappingData, String, AFAnalysisOutputType, String, String) |
Defines an output from an AFAnalysisRule using the specified AFVariableMappingData.
|
Properties
| Name | Description | |
|---|---|---|
 | Description |
A description for the user of how the variable will be used.
|
| DisplayName |
The name of the variable that will be shown to users.
|
| IsMappingConfigurable |
True if the mapping configuration can be modified for this variable
|
| Name |
The name of the variable.
|
| OutputType |
The type of output defined by 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.) |
| Resolve |
Attempts to tie the output to a particular item in the hierarchy based on a target and AFVariableMap configuration.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
AFAnalysisRuleOutputDefinition instances are created by the AFAnalysisRule
implementer in AFAnalysisRule.DefineVariables(AFAnalysisRuleVariableDefinitions) and added to
the Outputs collection. The caller can use the
AFAnalysisOutputDefinition to determine what needs to be configured.