Interface JoeScan::Pinchot::IFrame

ClassList > JoeScan > Pinchot > IFrame

Frame data from a scan system.

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.

See also: ScanSystem.WaitForFrame(System.TimeSpan, System.Threading.CancellationToken), ScanSystem.TakeFrame(System.Threading.CancellationToken), ScanSystem.TryTakeFrame(out IFrame, System.TimeSpan, System.Threading.CancellationToken)

Public Properties

Type	Name
int	Count Gets the total number of slots in this frame.
bool	IsComplete Gets if the frame is complete or not. A frame will be considered complete only if all slots are valid (non-null).
uint	SequenceNumber Gets the monotonically increasing frame sequence number.
ref IProfile	this[int index] Gets the slot at index . Slots can contain either a valid IProfile ornull . Use Count to get the total number of slots in this frame.

Public Properties Documentation

Count

Gets the total number of slots in this frame.

int Count;

The total number of slots in this frame.

---

IsComplete

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

bool IsComplete;

true if the frame is complete.

---

SequenceNumber

Gets the monotonically increasing frame sequence number.

uint SequenceNumber;

The frame sequence number.

---

this[int index]

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

ref IProfile this[int index];

Parameters:

• index The index of the slot.

Returns:

A valid IProfile or null.

---

---