AFAnalysis.AnalysisRulePlugIn Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
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 AFAnalysis 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: AFPlugInThe 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.
If this analysis was created from an AFAnalysisTemplate then the value of this property is defined by the template and cannot be modified. In this case, changing the AFAnalysisTemplate.AnalysisRulePlugIn property also changes the value of this property.