AF SDK Reference

AFAnalysisTemplate.TimeRulePlugIn Property

Save PDF

AFAnalysisTemplate.TimeRulePlugIn Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The time rule plugin property is used to specify which time rule will be used by the AFAnalysis to determine when the analysis runs.

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

Syntax

public AFPlugIn TimeRulePlugIn { get; set; }

Public Property TimeRulePlugIn As AFPlugIn
	Get
	Set

Dim instance As AFAnalysisTemplate
Dim value As AFPlugIn

value = instance.TimeRulePlugIn

instance.TimeRulePlugIn = value

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

member TimeRulePlugIn : AFPlugIn with get, set

Property Value

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

Remarks

The analysis uses the configured time rule to determine when the next analysis should be run. The list of available time rules available on the system is provided by the PISystem.TimeRulePlugIns collection. An instance of a time rule is created by an object which is derived the AFTimeRule base class that has been registered on the PI AF Server using the RegPlugIn utility.

AF SDK Reference