Class JoeScan::Pinchot::StartScanningOptions¶

ClassList > JoeScan > Pinchot > StartScanningOptions

A set of options for configuring how a ScanSystem should scan.

Public Properties¶

Type	Name
DataFormat	Format The format of the data contained in an IProfile .
uint?	IdlePeriodUs Gets or sets the rate at which IProfile s are generated when the ScanSystem is in an idle state. An idle state occurs when the_Encoder.Main _value has not changed for 1 second. This value can be set to 0 to completely stop IProfile s from being generated when in an idle state.
ScanningMode	Mode The mode that determines how IProfile s are gathered and consumed.
uint	PeriodUs The time it takes to gather all IProfile s from the scheduled phase elements in the phase table.

Public Properties Documentation¶

Format¶

The format of the data contained in an IProfile .

DataFormat Format;

The data format.

IdlePeriodUs¶

Gets or sets the rate at which IProfile s are generated when the ScanSystem is in an idle state. An idle state occurs when the_Encoder.Main _value has not changed for 1 second. This value can be set to 0 to completely stop IProfile s from being generated when in an idle state.

uint? IdlePeriodUs;

The idle scan period should be a multiple of PeriodUs.

The idle scan period in microseconds. If set to null, idle scanning is disabled.

Mode¶

The mode that determines how IProfile s are gathered and consumed.

ScanningMode Mode;

The scanning mode.

PeriodUs¶

The time it takes to gather all IProfile s from the scheduled phase elements in the phase table.

uint PeriodUs;

The scan period in microseconds.