Interface IFrame

Frame data from a scan system.

Namespace: JoeScan.Pinchot
Assembly: JoeScan.Pinchot.dll
Syntax
public interface IFrame
Remarks

A frame contains a slot for each phase element of every ScanHead in a ScanSystem. A slot can either be a valid IProfile or null if something went wrong or was misconfigured.

Properties

| Improve this Doc View Source

Count

Gets the total number of slots in this frame.

Declaration
int Count { get; }
Property Value
Type Description
Int32

The total number of slots in this frame.
| Improve this Doc View Source

IsComplete

Gets if the frame is complete or not. A frame will be considered complete only if all slots are valid (non-null).

Declaration
bool IsComplete { get; }
Property Value
Type Description
Boolean

true if the frame is complete.
| Improve this Doc View Source

Item[Int32]

Gets the slot at index. Slots can contain either a valid IProfile or null. Use Count to get the total number of slots in this frame.

Declaration
ref IProfile this[int index] { get; }
Parameters
Type Name Description
Int32 index

The index of the slot.
Property Value
Type Description
IProfile

A valid IProfile or null.
| Improve this Doc View Source

SequenceNumber

Gets the monotonically increasing frame sequence number.

Declaration
uint SequenceNumber { get; }
Property Value
Type Description
UInt32

The frame sequence number.