Class JoeScan::Pinchot::StartScanningOptions¶
ClassList > JoeScan > Pinchot > StartScanningOptions
A set of options for configuring how a ScanSystem should scan.
See also: ScanSystem.StartScanning(StartScanningOptions)
Public Properties¶
| Type | Name |
|---|---|
| property DataFormat | Format The format of the data contained in an IProfile . |
| property uint? | IdlePeriodUs Gets or sets the rate at which IProfile s are generated when theScanSystem 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 stopIProfile s from being generated when in an idle state. |
| property ScanningMode | Mode The mode that determines how IProfile s are gathered and consumed. |
| property uint | PeriodUs The time it takes to gather all IProfile s from the scheduled phase elements in the phase table. |
Public Properties Documentation¶
property Format¶
The format of the data contained in an IProfile .
DataFormat Format;
The data format.
property IdlePeriodUs¶
Gets or sets the rate at which IProfile s are generated when theScanSystem 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 stopIProfile 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.
property Mode¶
The mode that determines how IProfile s are gathered and consumed.
ScanningMode Mode;
The scanning mode.
property 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.