AFAnalysisRuleInputDefinition Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines an input to an AFAnalysisRule.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.AnalysisAFAnalysisRuleInputDefinition
OSIsoft.AF.AnalysisAFAnalysisRuleInputDefinition
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public class AFAnalysisRuleInputDefinition
Public Class AFAnalysisRuleInputDefinition Dim instance As AFAnalysisRuleInputDefinition
public ref class AFAnalysisRuleInputDefinition
type AFAnalysisRuleInputDefinition = class end
The AFAnalysisRuleInputDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAnalysisRuleInputDefinition |
Define an input to an AFAnalysisRule.
|
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.
|
| InputRange |
Returns input data range AFAnalysisInputRange information for this input.
|
| InputType |
The type of input defined by the AFAnalysisRule.
|
| IsMappingConfigurable |
True if the mapping configuration can be modified for this variable
|
| IsOptional |
If true, it is not a configuration error if this input cannot be resolved
|
| Name |
The name of the variable.
|
Methods
| Name | Description | |
|---|---|---|
 | CreateInput |
Create an input definition to a specific item.
|
| CreateInputWithMapping |
Create an input definition with a mapping configuration supplied.
|
| CreateSingleInputWithMappingAndRanges |
Create an input definition with a mapping configuration and input time ranges information explicitly set.
AFAnalysisInputType.
|
| 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 input 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
AFAnalysisRuleInputDefinition instances are created by the AFAnalysisRule
implementer in AFAnalysisRule.DefineVariables(AFAnalysisRuleVariableDefinitions) and added to
the Inputs collection. The caller can use the
AFAnalysisInputDefinition to determine what needs to be configured.