AFAnalysisRuleInputDefinition.CreateInput Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Create an input definition to a specific item.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFAnalysisRuleInputDefinition CreateInput( Object input, AFAnalysisInputType inputType = AFAnalysisInputType.SingleValue, string displayName = null, string description = null, bool isOptional = false )
Public Shared Function CreateInput ( input As Object, Optional inputType As AFAnalysisInputType = AFAnalysisInputType.SingleValue, Optional displayName As String = Nothing, Optional description As String = Nothing, Optional isOptional As Boolean = false ) As AFAnalysisRuleInputDefinition Dim input As Object Dim inputType As AFAnalysisInputType Dim displayName As String Dim description As String Dim isOptional As Boolean Dim returnValue As AFAnalysisRuleInputDefinition returnValue = AFAnalysisRuleInputDefinition.CreateInput(input, inputType, displayName, description, isOptional)
public: static AFAnalysisRuleInputDefinition^ CreateInput( Object^ input, AFAnalysisInputType inputType = AFAnalysisInputType::SingleValue, String^ displayName = nullptr, String^ description = nullptr, bool isOptional = false )
static member CreateInput : input : Object * ?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
- input
- Type: SystemObject
The object that will be used to supply inputs. For example, an AFAttribute or IListT that the analysis rule will use as inputs. - inputType (Optional)
- Type: OSIsoft.AF.AnalysisAFAnalysisInputType
The type of the input. - displayName (Optional)
- Type: SystemString
A display name for showing in the UI. This can be localized. - description (Optional)
- Type: SystemString
A description of how the input will be used. - isOptional (Optional)
- Type: SystemBoolean
True if a failure to resolve the mapping should not result in a configuration error.
Return Value
Type: AFAnalysisRuleInputDefinitionA AFAnalysisRuleInputDefinition with the resolved input fixed.