AFAnalysisRuleOutputDefinition Constructor (AFVariableMappingData, String, AFAnalysisOutputType, String, String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines an output from an AFAnalysisRule using the specified AFVariableMappingData.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFAnalysisRuleOutputDefinition( AFVariableMappingData mapping, string name, AFAnalysisOutputType outputType = AFAnalysisOutputType.SingleValue, string displayName = null, string description = null )
Public Sub New ( mapping As AFVariableMappingData, name As String, Optional outputType As AFAnalysisOutputType = AFAnalysisOutputType.SingleValue, Optional displayName As String = Nothing, Optional description As String = Nothing ) Dim mapping As AFVariableMappingData Dim name As String Dim outputType As AFAnalysisOutputType Dim displayName As String Dim description As String Dim instance As New AFAnalysisRuleOutputDefinition(mapping, name, outputType, displayName, description)
public: AFAnalysisRuleOutputDefinition( AFVariableMappingData^ mapping, String^ name, AFAnalysisOutputType outputType = AFAnalysisOutputType::SingleValue, String^ displayName = nullptr, String^ description = nullptr )
new : mapping : AFVariableMappingData * name : string * ?outputType : AFAnalysisOutputType * ?displayName : string * ?description : string (* Defaults: let _outputType = defaultArg outputType AFAnalysisOutputType.SingleValue let _displayName = defaultArg displayName null let _description = defaultArg description null *) -> AFAnalysisRuleOutputDefinition
Parameters
- mapping
- Type: OSIsoft.AF.AnalysisAFVariableMappingData
The variable mapping to be used. - name
- Type: SystemString
The name of the variable. This will be used to look up mapping configuration so it should be invariant. - outputType (Optional)
- Type: OSIsoft.AF.AnalysisAFAnalysisOutputType
The type of output 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 of the output for the user.