Click or drag to resize
OSIsoft, LLC

AFAnalysisTimeRulePlugIn Property

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:
public AFPlugIn TimeRulePlugIn { get; set; }

Property Value

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

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.

If this analysis was created from an AFAnalysisTemplate and this property has not been modified, then the value of this property is defined by the template. In this case, changing the AFAnalysisTemplate.TimeRulePlugIn property also changes the value of this property. If this property has been modified, then this property will not reflect changes made to the template.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence