PIconnect.EventFrame module#
Module for handling Event Frames.
- class PIconnect.EventFrame.AFEventFrame(element: ElementType)#
Bases:
AFBaseElement[AFEventFrame]Container for PI AF Event Frames in the database.
- property children: dict[str, Self]#
Return a dictionary of the direct child event frames of the current event frame.
- property event_frame: AFEventFrame#
Return the underlying AF Event Frame object.
- property parent: Self | None#
Return the parent element of the current event frame, or None if it has none.
- version = '0.1.0'#
- class PIconnect.EventFrame.AFEventFrameList(elements: MutableSequence[NamedItemType])#
Bases:
NamedItemList[AFEventFrame]Container for a list of PIAFEventFrame objects.
- class PIconnect.EventFrame.EventFrameSearchMode(*values)#
Bases:
IntEnumEventFrameSearchMode.
EventFrameSearchMode defines the interpretation and direction from the start time when searching for event frames.
Detailed information is available at AF.EventFrame.AFEventFrameSearchMode. including a graphical display of event frames that are returned for a given search mode.
- BACKWARD_FROM_END_TIME = 3#
Backward from end time, also known as ending before
- BACKWARD_FROM_START_TIME = 1#
Backward from start time, also known as starting before
- BACKWARD_IN_PROGRESS = 5#
Backward in progress, also known as starting before and in progress
- ENDING_AFTER = 4#
- ENDING_BEFORE = 3#
- FORWARD_FROM_END_TIME = 4#
Forward from end time, also known as ending after
- FORWARD_FROM_START_TIME = 2#
Forward from start time, also known as starting after
- FORWARD_IN_PROGRESS = 6#
Forward in progress, also known as starting after and in progress
- NONE = 0#
Uninitialized
- STARTING_AFTER = 2#
- STARTING_AFTER_IN_PROGRESS = 6#
- STARTING_BEFORE = 1#
- STARTING_BEFORE_IN_PROGRESS = 5#