Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAnalysisRuleOutputDefinition Constructor (AFVariableMappingData, String, AFAnalysisOutputType, String, String)

AFAnalysisRuleOutputDefinition Constructor (AFVariableMappingData, String, AFAnalysisOutputType, String, String)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAnalysisRuleOutputDefinition Constructor (AFVariableMappingData, String, AFAnalysisOutputType, String, String)
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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5

See Also

TitleResults for “How to create a CRG?”Also Available in