AFAnalysisRuleInputDefinition Constructor
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Define an input to an AFAnalysisRule.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFAnalysisRuleInputDefinition( string name, AFAnalysisInputType inputType = AFAnalysisInputType.SingleValue, string displayName = null, string description = null, bool isOptional = false )
Public Sub New ( name As String, Optional inputType As AFAnalysisInputType = AFAnalysisInputType.SingleValue, Optional displayName As String = Nothing, Optional description As String = Nothing, Optional isOptional As Boolean = false ) Dim name As String Dim inputType As AFAnalysisInputType Dim displayName As String Dim description As String Dim isOptional As Boolean Dim instance As New AFAnalysisRuleInputDefinition(name, inputType, displayName, description, isOptional)
public: AFAnalysisRuleInputDefinition( String^ name, AFAnalysisInputType inputType = AFAnalysisInputType::SingleValue, String^ displayName = nullptr, String^ description = nullptr, bool isOptional = false )
new : name : string * ?inputType : AFAnalysisInputType * ?displayName : string * ?description : string * ?isOptional : bool (* Defaults: let _inputType = defaultArg inputType AFAnalysisInputType.SingleValue let _displayName = defaultArg displayName null let _description = defaultArg description null let _isOptional = defaultArg isOptional false *) -> AFAnalysisRuleInputDefinition
Parameters
- name
- Type: SystemString
The name of the variable. This will be used to look up mapping configuration so it should be invariant. - inputType (Optional)
- Type: OSIsoft.AF.AnalysisAFAnalysisInputType
The type of input being defined. - displayName (Optional)
- Type: SystemString
A name to show the user. This can be localized. If nothing is specified, the Name will be used. - description (Optional)
- Type: SystemString
A description for the user of what the input is for and the type of configuration it accepts. - isOptional (Optional)
- Type: SystemBoolean
If true, then a failure to resolve the input will not cause an error.