Base |
The BaseScanController type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AbortExecution | Aborts all ongoing executions. |
| AssignScanHead | Assigns the scan head to the specified index |
| AssignScanHeads | Assigns the scan heads. |
| ClearLists | Clears all lists. |
| Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
| ConvertListToEndlessMotf | Converts non motf list to endless motf. |
| DeleteStandAloneJob | Deletes a stored job ( StoreStandAloneJob(Int32)) from the card. |
| Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) |
| DiscoverCards | Searches for internal or network cards. |
| Dispose | (Inherited from BasePlugin) |
 | Dispose(Boolean) | (Inherited from BaseDeviceController) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoShowUI |
Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin) |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin) |
| EnableJobLoop | Exits the loop set by PrepareMasterSingleList(Int32, Boolean, Boolean, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, NullableGuid, Boolean, Int32, String, Boolean, Boolean) after the current iteration. |
| EnableStandAloneMode | Enables the Stand-Alone mode. If enabled, the card will start executing the Stand-Alone list after booting up. |
| ExecuteList | Puts the given list in the SP-ICE-3 execution's queue. |
| GetActiveBias | Returns the active bias from the card. |
| GetActiveFieldTransformation | Returns the active field transformation from the card. |
| GetDeviceStatusRepresentation |
Gets the device status in form of color and description.
(Overrides BaseDeviceControllerGetDeviceStatusRepresentation) |
| GetExpectedMaxBeltSpeed | |
| GetFieldCorrectionFile | Gets the field correction file from the card. |
| GetListHash | Gets the list hash for the provided list guid. |
| GetMarkCounter | Gets the current value of the mark counter with a given name. Mark counter is used to track how many iterations an infinite pass has been executed. |
| GetProcessTransformation | Gets the process transformation. |
| GetProcessVariables | Gets a marker pen created from the last used values of the card. |
| GetSpeedScale | Returns the speed scale currently used by the card. |
| GetUsedLogPath | Gets the LogPath. In case of the SPICE3Card it returns the default log path if LogPath is not set, i. e. the path built out of log directory and device label. |
| GoToXY(dvec2, Double, Boolean, NullableCancellationToken) | Jumps to the 2D Position with the defined speed. If in 3D mode, the last used z value will be kept. |
| GoToXY(dvec2, Double, Double, Boolean, NullableCancellationToken) | Jumps to the 2D Position with the defined speed and delay. If in 3D mode, the last used z value will be kept. |
| GoToXYZ(dvec3, Double, Boolean, NullableCancellationToken) | Jumps to the 3D Position with the defined speed. |
| GoToXYZ(dvec3, Double, Double, Boolean, NullableCancellationToken) | Jumps to the 3D Position with the defined speed and jump delay. |
| HandleExternalDeviceRequestAsync |
Handles a chained request for a given list of features.
(Inherited from BaseDeviceController) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin) |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
| InvokeDeviceUIRequested | Invokes DeviceUIRequested. |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
| InvokeLaserControllerChanged | Invokes LaserControllerChanged. |
| InvokeReadyToMarkChanged | Invokes ReadyToMarkChanged. |
| InvokeScanHeadChanged | Invokes ScanHeadChanged. |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
| IsExecutionInProgress | Returns true if execution is in progress. |
| OnDevicesChanged | (Overrides BaseDeviceControllerOnDevicesChanged(ISetBaseDeviceController)) |
| OnExecutionFinished | Invokes ExecutionFinished. |
| OnExecutionStarted | Invokes ExecutionStarted. |
| OnScanControllerError | Invokes ScanControllerError. |
| OnSliceStarted | |
| PrepareBitmapGraphicList | Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)]. |
| PrepareDelay | Creates a list with the specified delay. |
| PrepareEnhancedCommand | Creates a list with the specified enhanced command. |
| PrepareExecutionInProgress | Creates a list asserting or deasserting the execution in progress signal. |
| PrepareMarkInProgress | Creates a list asserting or deasserting the mark in progress signal. |
| PrepareMarkOnTheFlyHead | Creates a list to setup the MarkOnTheFly. |
| PrepareMarkOnTheFlyTail | Creates a list to cleanup the MarkOnTheFly. |
| PrepareMasterSingleList | Creates a list containing the job settings for single list mode. |
| PrepareSetCorrectionFileIndex | Creates a list for switching the used correction file index. |
| PrepareSetDataCommand | Creates a list with the specified enhanced command. |
| PrepareSubMasterSingleList | Creates a list to contain other lists. |
| PrepareVectorGraphicList(IReadOnlyCollectionVectorGraphicLayer, Int32, dmat4, GenericMarkerProfile, IOPortCondition, NullableGuid, Int32, Int32, Int32, Boolean, Boolean, NullableGuid) | Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)]. |
| PrepareVectorGraphicList(IListVectorGraphicLayersWrapper, Int32, dmat4, GenericMarkerProfile, IDictionaryVectorGraphicPath, ValueTupleNullableDouble, Nullabledvec3, dvec3, IOPortCondition, NullableGuid, Int32, Int32, Int32, Boolean, Boolean, NullableGuid) | Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)]. |
| PrepareVectorGraphicList(IReadOnlyCollectionVectorGraphicLayer, Int32, dmat4, GenericMarkerProfile, IDictionaryVectorGraphicPath, ValueTupleNullableDouble, Nullabledvec3, dvec3, IOPortCondition, NullableGuid, Int32, Int32, Int32, Boolean, Boolean, NullableGuid) | Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)]. |
| ReadEncoderCounts | Reads the current position of the selected encoder in ticks. |
| ReadEncoderPosition | Reads the current position of the selected encoder. |
| ReceiveEnhanced | Waits for a response from the ScanHead head using the Enhanced Protocol up to timeoutMilliseconds for a response. |
| RefreshReadyToMark | Refreshes the ReadyToMark state of the scan controller. |
| ReleaseList | Discards the mapping of the used lists. Also recycles used list IDs. After this call, the object can't be updated anymore. |
| ResetDecoderCounts | Resets the selected decoder counts to zero. |
| ResetMarkCounter | Resets to zero the value of the mark counter with a given name. |
| ResetMarkOnTheFlyState | Resets the Mark-On-The-Fly state. |
| ResetProcessTransformation | Resets the process transformation. |
| RunStandAloneList | Starts execution of the Stand-Alone list. |
| SetExecutionInProgress | Asserts or deasserts the execution in progress signal. |
| SetHeadBias(Int32, dvec3) | Sets the head bias. |
| SetHeadBias(Int32, Double) | Sets the head bias. |
| SetList | Generates master list and send it with the referenced lists to the card. |
| SetMarkInProgress | Asserts or deasserts the mark in progress signal. |
| SetMarkOnTheFlyProfile | Send the provided MarkOnTheFly configuration to the card |
| SetPowerCorrectionFile | Sets the power correction file (*.pc3). |
| SetProcessTransformation | Sets the process transformation. |
| SetSpeedScale | Sets the speed scale on the card. |
| SetStandAloneList | Sets the stand alone configuration on the card. The lists contained in JobLists must already be stored on the card. |
| ShowUI |
Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController) |
| ShowUICallback |
Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController) |
| ShowUICancelCallback |
Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin) |
| SpiTransceive | Transceives commands via the spi bus. |
| StoreStandAloneJob | By storing the specified list on the card, it will persist after rebooting. The list must already exist on the card. |
| SynchronizeDeviceTime | Synchronizes the time of the scan controller to the time of the host. |
| ToString | (Inherited from BasePlugin) |
| TransceiveEnhanced | Sends commands to the ScanHead head using the Enhanced Protocol, and waits up to timeoutMilliseconds for a response. |
| TransmitEnhanced | Sends commands to the ScanHead head using the Enhanced Protocol. |
| UpdateConfiguration | Updates the configuration of the provided type. |
| UpdateScanHeadConfiguration | Sends the configuration of the scan heads to the card. |
| VerifyConnection | Tests if the connection is still active. |
| WaitExecution | Blocks until the list is done executing ( list idle) . |
See Also