AFEventHorizonMode Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
EventHorizonMode specifies what events are returned by the datapipe at the GetUpdateEvent/GetObserverEvents calls
based on the timestamp of the events.
Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum AFEventHorizonMode
Public Enumeration AFEventHorizonMode Dim instance As AFEventHorizonMode
public enum class AFEventHorizonMode
type AFEventHorizonMode
Members
| Member name | Value | Description | |
|---|---|---|---|
| TimeOffset | 0 | The datapipe gets new events starting at signup time + EventHorizonOffset. At each GetUpdateEvent/GetObserverEvents call, datapipe returns events up to current time + EventHorizonOffset. | |
| TimeOffsetWithOutsideEvent | 1 | The datapipe gets new events starting at signup time + EventHorizonOffset. In addition, datapipe could return the next event after the current time + EventHorizonOffset at the GetUpdateEvent/GetObserverEvents call if there is an outside event available. Note that once the outside event is returned via GetUpdateEvent call, the same event will not be returned in the next GetUpdateEvent/GetObserverEvents call even though the event time is greater than current time + EventHorizonOffset. | |
| EndOfStream | 2 | The datapipe gets new events starting at the end of stream when signup. EventHorizonOffset is not used. At each GetUpdateEvents/GetObserverEvents call, datapipe returns new end of stream events since the last call. |