AF SDK Reference

AFAnalysisTemplate.AnalysisRulePlugIn Property

Save PDF

AFAnalysisTemplate.AnalysisRulePlugIn Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The analysis rule plugin property is used to specify which analysis rule will be used by the AFAnalysis to run the analysis.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFPlugIn AnalysisRulePlugIn { get; set; }

Public Property AnalysisRulePlugIn As AFPlugIn
	Get
	Set

Dim instance As AFAnalysisTemplate
Dim value As AFPlugIn

value = instance.AnalysisRulePlugIn

instance.AnalysisRulePlugIn = value

public:
property AFPlugIn^ AnalysisRulePlugIn {
	AFPlugIn^ get ();
	void set (AFPlugIn^ value);
}

member AnalysisRulePlugIn : AFPlugIn with get, set

Property Value

Type: AFPlugIn
The analysis rule plugin used to create the analysis rule which runs the analysis.

Remarks

The analysis uses the configured analysis rule to provide the logic to run the analysis. The list of available analysis rules available on the system is provided by the PISystem.AnalysisRulePlugIns collection. An instance of a analysis rule is created by an object which is derived the AFAnalysisRule base class that has been registered on the PI AF Server using the RegPlugIn utility.

AF SDK Reference