Click or drag to resize
OSIsoft, LLC

AFEventFrameSearchMode Enumeration

The event frame search mode is an enumeration of the possible values for specifying the search criteria for event frames from a time.

Namespace:  OSIsoft.AF.EventFrame
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
public enum AFEventFrameSearchMode
Members
  Member nameValueDescription
None0 This is the value of an uninitialized search mode.
BackwardFromStartTime1 Event frames with a start time less than the time specified in the search (moving backward in time) are returned from the search. Also known as "Starting Before".
ForwardFromStartTime2 Event frames with a start time greater than or equal to the time specified in the search (moving forward in time) are returned from the search. Also known as "Starting After".
BackwardFromEndTime3 Event frames with an end time less than or equal to the time specified in the search (moving backward in time) are returned from the search. Also known as "Ending Before".
ForwardFromEndTime4 Event frames with an end time greater than the time specified in the search (moving forward in time) are returned from the search. Also know as "Ending After".
BackwardInProgress5 Event frames with a start time less than the time specified in the search (moving backward in time) that are still in progress (an end time set to MaxValue) are returned from the search. Also known as "Starting Before and In Progress".
ForwardInProgress6 Event frames with a start time greater than or equal to the time specified in the search (moving forward in time) that are still in progress (an end time set to MaxValue) are returned from the search. Also known as "Starting After and In Progress".
Remarks

The event frame search mode specifies direction in time for the search from either the start or end time of the event frame. The EndTimeSearch feature can be checked to determine if BackwardFromEndTime and ForwardFromEndTime are supported. The InProgressSearch feature can be checked to determine if BackwardInProgress and ForwardInProgress are supported.

The diagram below shows several possible time spans for the value of an AFEventFrame and illustrates which would be returned for each of the search modes.

Version Information

AFSDK

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