AFTimeRuleEvent Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
An event generated by a time rule
Inheritance Hierarchy
SystemObject
OSIsoft.AF.TimeAFTimeRuleEvent
OSIsoft.AF.TimeAFTimeRuleEvent
Namespace: OSIsoft.AF.Time
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFTimeRuleEvent : IAFTimePeriod, IComparable, IComparable<AFTimeRuleEvent>, IEquatable<AFTimeRuleEvent>
Public NotInheritable Class AFTimeRuleEvent Implements IAFTimePeriod, IComparable, IComparable(Of AFTimeRuleEvent), IEquatable(Of AFTimeRuleEvent) Dim instance As AFTimeRuleEvent
public ref class AFTimeRuleEvent sealed : IAFTimePeriod, IComparable, IComparable<AFTimeRuleEvent^>, IEquatable<AFTimeRuleEvent^>
[<SealedAttribute>] type AFTimeRuleEvent = class interface IAFTimePeriod interface IComparable interface IComparable<AFTimeRuleEvent> interface IEquatable<AFTimeRuleEvent> end
The AFTimeRuleEvent type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFTimeRuleEvent |
Initializes a new instance of the class with default values.
|
| AFTimeRuleEvent(AFTime) |
Initializes a new instance of the class with the specified values.
|
| AFTimeRuleEvent(IAFTimePeriod) |
Initializes a new instance of the class with the specified values.
|
| AFTimeRuleEvent(AFTime, AFTime) |
Initializes a new instance of the class with the specified values.
|
| AFTimeRuleEvent(AFTime, AFTime, Object) |
Initializes a new instance of the class with the specified values.
|
Properties
| Name | Description | |
|---|---|---|
 | AdditionalInfo |
Sets and returns the additional info property.
|
| Duration | |
| EndTime |
This read-only property represents the end time of the period.
|
| StartTime |
This read-only property represents the start time of the period.
|
| TimeRange |
Methods
| Name | Description | |
|---|---|---|
| CompareTo(Object) |
Compares this instance with a specified Object.
|
| CompareTo(AFTimeRuleEvent) |
Compares this instance with a specified AFTimeRuleEvent.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| Equals(AFTimeRuleEvent) |
Indicates whether the current object is equal to another object of the same type.
|
| 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.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| SetEndTime |
Set the time that represents the time that the period ended.
|
| SetStartTime |
Set the time that represents the time that the period started.
|
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Operators
| Name | Description | |
|---|---|---|
  | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| GreaterThan |
The greater than relation operator (>) compares its operands to determine
which one is greater than the other.
|
| GreaterThanOrEqual |
The greater than or equal relation operator (>=) compares its operands to determine
which one is greater than or equal to the other.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
| LessThan |
The less than relation operator (<) compares its operands to determine
which one is less than the other.
|
| LessThanOrEqual |
The less than or equal relation operator (<=) compares its operands to determine
which one is less than or equal to the other.
|