AFAnalysisRuleInputDefinition.CreateSingleInputWithMappingAndRanges Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Create an input definition with a mapping configuration and input time ranges information explicitly set.
AFAnalysisInputType.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static AFAnalysisRuleInputDefinition CreateSingleInputWithMappingAndRanges( AFVariableMappingData mapping, AFInputRangeData[] inputRanges = null, AFInputCountData[] inputCounts = null, AFAnalysisInputType inputType = AFAnalysisInputType.Data, string displayName = null, string description = null, bool isOptional = false )
Public Shared Function CreateSingleInputWithMappingAndRanges ( mapping As AFVariableMappingData, Optional inputRanges As AFInputRangeData() = Nothing, Optional inputCounts As AFInputCountData() = Nothing, Optional inputType As AFAnalysisInputType = AFAnalysisInputType.Data, Optional displayName As String = Nothing, Optional description As String = Nothing, Optional isOptional As Boolean = false ) As AFAnalysisRuleInputDefinition Dim mapping As AFVariableMappingData Dim inputRanges As AFInputRangeData() Dim inputCounts As AFInputCountData() Dim inputType As AFAnalysisInputType Dim displayName As String Dim description As String Dim isOptional As Boolean Dim returnValue As AFAnalysisRuleInputDefinition returnValue = AFAnalysisRuleInputDefinition.CreateSingleInputWithMappingAndRanges(mapping, inputRanges, inputCounts, inputType, displayName, description, isOptional)
public: static AFAnalysisRuleInputDefinition^ CreateSingleInputWithMappingAndRanges( AFVariableMappingData^ mapping, array<AFInputRangeData>^ inputRanges = nullptr, array<AFInputCountData>^ inputCounts = nullptr, AFAnalysisInputType inputType = AFAnalysisInputType::Data, String^ displayName = nullptr, String^ description = nullptr, bool isOptional = false )
static member CreateSingleInputWithMappingAndRanges : mapping : AFVariableMappingData * ?inputRanges : AFInputRangeData[] * ?inputCounts : AFInputCountData[] * ?inputType : AFAnalysisInputType * ?displayName : string * ?description : string * ?isOptional : bool (* Defaults: let _inputRanges = defaultArg inputRanges null let _inputCounts = defaultArg inputCounts null let _inputType = defaultArg inputType AFAnalysisInputType.Data let _displayName = defaultArg displayName null let _description = defaultArg description null let _isOptional = defaultArg isOptional false *) -> AFAnalysisRuleInputDefinition
Parameters
- mapping
- Type: OSIsoft.AF.AnalysisAFVariableMappingData
The AFVariableMappingData configuration. This will take precedence over any configured mapping. - inputRanges (Optional)
- Type: OSIsoft.AF.AnalysisAFInputRangeData
Ranges for the required input data. For example, if the input is used to calculate 10 minute average up to the trigger time, one of the StartTime and EndTime values should be "*-10m". - inputCounts (Optional)
- Type: OSIsoft.AF.AnalysisAFInputCountData
The count of values that the input requires before the specified time in TimeContext. - 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 a fixed variable mapping.
Remarks
If the ranges are not supplied or the range information cannot be
determined, it is better to use CreateInputWithMapping(AFVariableMappingData, AFAnalysisInputType, String, String, Boolean)