AFTimeRule Methods
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFTimeRule type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) | |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) | |
| DefaultSaveConfigChanges |
Called by the protected SaveConfigChanges method to perform the default actions to save
the configuration changes.
| |
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) | |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) | |
| ErrorToLocalizedString |
Translates error code to a localized string.
| |
| FindTimeRule(AFAnalysis, Guid) |
Retrieves the AFTimeRule object from the AFAnalysis
with the specified unique identifier.
| |
| FindTimeRule(AFAnalysisTemplate, Guid) |
Retrieves the AFTimeRule object from the AFAnalysisTemplate
with the specified unique identifier.
| |
| GetEditorT |
Returns an instance of an editor of the specified type.
| |
| GetEvents |
Returns all pending AFTimeRuleEvent objects.
| |
| GetEvents(AFTimeRange) |
Returns all AFTimeRuleEvent objects for a given time range.
| |
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Inherited from AFObject.) | |
| GetNextEvent |
Returns the next AFTimeRuleEvent that occurs relative to Now
or the previous event.
| |
| GetNextEvent(AFTime) |
Returns the next AFTimeRuleEvent that occurs at the specified time start time.
| |
| GetNextEvent(AFTimeRuleEvent) |
Returns the next AFTimeRuleEvent that occurs after the previously specified event.
| |
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) | |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) | |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IsTraced |
Indicates if a specified level is being traced.
| |
| Pause |
Pause the time rule until it is started again.
| |
| Pause(TimeSpan) |
Pause the time rule for a specified amount of time.
| |
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) | |
| RefreshConfiguration |
Refresh the configuration of the AFTimeRule.
| |
| Reset |
Clear the previous time rule event.
| |
| SetSaveConfigChangesHandler |
Set the handler used for saving ConfigString changes.
| |
| Start |
Start the time rule
| |
| Stop |
Stop the time rule; the previous rule event is cleared.
| |
| SupportsChildTimeRule | Obsolete.
Determines if the specified AFPlugIn supports adding child time rules.
| |
| ToString |
Returns a String that represents the current object.
(Overrides AFObjectToString.) | |
| TraceData |
Output a data trace event.
| |
| TraceDetail |
Output a detail trace event.
| |
| TraceError |
Output an error trace event.
| |
| TraceEvent(AFTraceSwitchLevel, String) |
Output a trace event with a message.
| |
| TraceEvent(AFTraceSwitchLevel, String, Int32) |
Output a trace event with a message and a duration.
| |
| TraceEvent(AFTraceSwitchLevel, String, Object) |
Output a trace event as a formatted message with a variable number of arguments.
| |
| TraceInformation |
Output an information trace event.
| |
| TraceSummary |
Output a summary trace event.
| |
| TraceWarning |
Output a warning trace event.
|
See Also
In This Topic
Related Links
- DefaultSaveConfigChanges Method
- ErrorToLocalizedString Method
- FindTimeRule Method
- GetEditor(T) Method
- GetEvents Method
- GetNextEvent Method
- IsTraced Method
- Pause Method
- RefreshConfiguration Method
- Reset Method
- SetSaveConfigChangesHandler Method
- Start Method
- Stop Method
- SupportsChildTimeRule Method
- ToString Method
- TraceData Method
- TraceDetail Method
- TraceError Method
- TraceEvent Method
- TraceInformation Method
- TraceSummary Method
- TraceWarning Method