Click or drag to resize

SPICE3Device Methods

The SPICE3Device type exposes the following members.

Methods
 NameDescription
Public methodAbortExecution Aborts all ongoing executions.
(Overrides BaseScanController.AbortExecution(Boolean))
Public methodAssignScanHead Assigns the scan head to the specified index
(Overrides BaseScanController.AssignScanHead(BaseScanHead, Int32))
Public methodAssignScanHeads Assigns the scan heads.
(Overrides BaseScanController.AssignScanHeads(IEnumerable<BaseScanHead>))
Public methodClearLists Clears all lists.
(Overrides BaseScanController.ClearLists())
Public methodClearProcessTransformationQueue Clears ProcessTransformationQueue.
Public methodConnect Connects to the device.
(Overrides BaseDeviceController.Connect())
Public methodConvertListToEndlessMotf Converts non motf list to endless motf.
(Overrides BaseScanController.ConvertListToEndlessMotf(Int32))
Public methodCreateVariableSignal 
Public methodDeleteStandAloneJob Deletes a stored job ( StoreStandAloneJob(Int32)) from the card.
(Overrides BaseScanController.DeleteStandAloneJob(Int32))
Public methodDisconnect Disconnects from the device.
(Overrides BaseDeviceController.Disconnect())
Public methodDiscoverCards Searches for internal or network cards.
(Overrides BaseScanController.DiscoverCards())
Public methodDispose()
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Overrides BaseDeviceController.Dispose(Boolean))
Public methodDisposeUI Disposes the given setting view.
(Inherited from BaseDeviceController)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoShowUI Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Overrides BasePlugin.DoShowUI(String))
Protected methodDoShowUICallback
(Overrides BasePlugin.DoShowUICallback(PluginSettingsView))
Public methodEnableJobLoop
(Overrides BaseScanController.EnableJobLoop(Boolean))
Public methodEnableStandAloneMode Enables the Stand-Alone mode. If enabled, the card will start executing the Stand-Alone list after booting up.
(Overrides BaseScanController.EnableStandAloneMode(Boolean))
Public methodEneuqueProcessTransformation Adds a transformation to ProcessTransformationQueue.
Public methodExecuteList Puts the given list in the SP-ICE-3 execution's queue.
(Overrides BaseScanController.ExecuteList(Int32, Boolean, CancellationToken))
Public methodGetActiveBias Returns the active bias from the card.
(Overrides BaseScanController.GetActiveBias(Int32))
Public methodGetActiveFieldTransformation Returns the active field transformation from the card.
(Overrides BaseScanController.GetActiveFieldTransformation(Int32))
Public methodGetCustomListGuid Gets the Guid of a custom list.
(Inherited from BaseScanController)
Public methodGetDeviceStatusRepresentation Gets the device status in form of color and description.
(Inherited from BaseScanController)
Public methodGetExpectedMaxBeltSpeed
(Overrides BaseScanController.GetExpectedMaxBeltSpeed(Double))
Public methodGetFieldCorrectionFile Gets the field correction file from the card.
(Overrides BaseScanController.GetFieldCorrectionFile(Int32, String))
Public methodGetListHash
(Overrides BaseScanController.GetListHash(Guid))
Public methodGetMarkCounter
(Overrides BaseScanController.GetMarkCounter(String))
Public methodGetProcessTransformation Gets the process transformation.
(Overrides BaseScanController.GetProcessTransformation())
Public methodGetProcessVariables Gets a marker pen created from the last used values of the card.
(Overrides BaseScanController.GetProcessVariables())
Public methodGetSpeedScale Returns the speed scale currently used by the card.
(Overrides BaseScanController.GetSpeedScale())
Public methodGetSpiConfig 
Public methodGetSupportedTimeZones Returns the list of supported time zones.
Public methodGetTimeInfo Returns the time and time zone set on the card.
Public methodGetUsedLogPath 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.
(Overrides BaseScanController.GetUsedLogPath())
Public methodGoToAndTrigger Jumps to a position and sends a hardware trigger after jump delay. List continuation is halted until another hardware trigger is received or the timeout time is over. This execution is also handled as custom command when executing, GetCustomListGuid().
(Inherited from BaseScanController)
Public methodGoToXY(dvec2, Double, Boolean, Nullable<CancellationToken>) Jumps to the 2D Position with the defined speed. If in 3D mode, the last used z value will be kept.
(Overrides BaseScanController.GoToXY(dvec2, Double, Boolean, Nullable<CancellationToken>))
Public methodGoToXY(dvec2, Double, Double, Boolean, Nullable<CancellationToken>) Jumps to the 2D Position with the defined speed and delay. If in 3D mode, the last used z value will be kept.
(Overrides BaseScanController.GoToXY(dvec2, Double, Double, Boolean, Nullable<CancellationToken>))
Public methodGoToXYZ(dvec3, Double, Boolean, Nullable<CancellationToken>) Jumps to the 3D Position with the defined speed.
(Overrides BaseScanController.GoToXYZ(dvec3, Double, Boolean, Nullable<CancellationToken>))
Public methodGoToXYZ(dvec3, Double, Double, Boolean, Nullable<CancellationToken>) Jumps to the 3D Position with the defined speed and jump delay.
(Overrides BaseScanController.GoToXYZ(dvec3, Double, Double, Boolean, Nullable<CancellationToken>))
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Overrides BaseDeviceController.HandleExternalDeviceRequestAsync(IList<Tuple<ChainableFeatureType, ExpandoObject>>, CancellationToken))
Public methodHasAutomationFeature 
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Overrides BasePlugin.Initialize())
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDeviceUIRequested Invokes DeviceUIRequested.
(Inherited from BaseScanController)
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Protected methodInvokeLaserControllerChanged Invokes LaserControllerChanged.
(Inherited from BaseScanController)
Protected methodInvokeReadyToMarkChanged Invokes ReadyToMarkChanged.
(Inherited from BaseScanController)
Protected methodInvokeScanHeadChanged Invokes ScanHeadChanged.
(Inherited from BaseScanController)
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Public methodIsExecutionInProgress Returns true if execution is in progress.
(Overrides BaseScanController.IsExecutionInProgress())
Public methodIsSetVariableSignal 
Protected methodOnDevicesChanged
(Inherited from BaseScanController)
Protected methodOnExecutionFinished Invokes ExecutionFinished.
(Inherited from BaseScanController)
Protected methodOnExecutionStarted Invokes ExecutionStarted.
(Inherited from BaseScanController)
Protected methodOnScanControllerError Invokes ScanControllerError.
(Inherited from BaseScanController)
Protected methodOnSliceStarted
(Inherited from BaseScanController)
Public methodPrepareBitmapGraphicList Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)].
(Overrides BaseScanController.PrepareBitmapGraphicList(BitmapHolder, dmat4, BitmapMarkerProfile, IOPortCondition, Nullable<Guid>, Int32, IDictionary<Int32, ValueTuple<Nullable<Double>, Nullable<dvec3>>>, Int32, Int32, Int32, Boolean, Boolean, Nullable<Guid>))
Public methodPrepareDelay Creates a list with the specified delay.
(Overrides BaseScanController.PrepareDelay(Double, IOPortCondition, Nullable<Guid>))
Public methodPrepareEnhancedCommand
(Overrides BaseScanController.PrepareEnhancedCommand(Int32, IList<ValueTuple<Axes, UInt32>>, Int32, IOPortCondition, Nullable<Guid>))
Public methodPrepareExecutionInProgress
(Overrides BaseScanController.PrepareExecutionInProgress(Boolean, Nullable<Guid>))
Public methodPrepareMarkInProgress Creates a list asserting or deasserting the mark in progress signal.
(Overrides BaseScanController.PrepareMarkInProgress(Boolean, Nullable<Guid>))
Public methodPrepareMarkOnTheFlyHead Creates a list to setup the MarkOnTheFly.
(Overrides BaseScanController.PrepareMarkOnTheFlyHead(MarkOnTheFlyTriggerProfile, Nullable<Guid>))
Public methodPrepareMarkOnTheFlyTail Creates a list to cleanup the MarkOnTheFly.
(Overrides BaseScanController.PrepareMarkOnTheFlyTail(MarkOnTheFlyTriggerProfile, Nullable<Guid>))
Public methodPrepareMasterSingleList Creates a list containing the job settings for single list mode.
(Overrides BaseScanController.PrepareMasterSingleList(Int32, Boolean, Boolean, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, Nullable<Guid>, Boolean, Int32, String, Boolean, Boolean))
Public methodPrepareSetCorrectionFileIndex Creates a list for switching the used correction file index.
(Overrides BaseScanController.PrepareSetCorrectionFileIndex(Int32, Nullable<Guid>))
Public methodPrepareSetDataCommand
(Overrides BaseScanController.PrepareSetDataCommand(SetDataMetafileCommand, Int32, IOPortCondition, Nullable<Guid>))
Public methodPrepareSubMasterSingleList Creates a list to contain other lists.
(Overrides BaseScanController.PrepareSubMasterSingleList(IOPortCondition, Nullable<Guid>))
Public methodPrepareVectorGraphicList(IReadOnlyCollection<VectorGraphicLayer>, Int32, dmat4, GenericMarkerProfile, IOPortCondition, Nullable<Guid>, Int32, Int32, Int32, Boolean, Boolean, Nullable<Guid>) Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)].
(Inherited from BaseScanController)
Public methodPrepareVectorGraphicList(IList<VectorGraphicLayersWrapper>, Int32, dmat4, GenericMarkerProfile, IDictionary<VectorGraphicPath, ValueTuple<Nullable<Double>, Nullable<dvec3>>>, dvec3, IOPortCondition, Nullable<Guid>, Int32, Int32, Int32, Boolean, Boolean, Nullable<Guid>) Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)].
(Overrides BaseScanController.PrepareVectorGraphicList(IList<VectorGraphicLayersWrapper>, Int32, dmat4, GenericMarkerProfile, IDictionary<VectorGraphicPath, ValueTuple<Nullable<Double>, Nullable<dvec3>>>, dvec3, IOPortCondition, Nullable<Guid>, Int32, Int32, Int32, Boolean, Boolean, Nullable<Guid>))
Public methodPrepareVectorGraphicList(IReadOnlyCollection<VectorGraphicLayer>, Int32, dmat4, GenericMarkerProfile, IDictionary<VectorGraphicPath, ValueTuple<Nullable<Double>, Nullable<dvec3>>>, dvec3, IOPortCondition, Nullable<Guid>, Int32, Int32, Int32, Boolean, Boolean, Nullable<Guid>) Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)].
(Inherited from BaseScanController)
Public methodPrepareWaitForSignal 
Public methodReadEncoderCounts Reads the current position of the selected encoder in ticks.
(Overrides BaseScanController.ReadEncoderCounts(Int32))
Public methodReadEncoderPosition Reads the current position of the selected encoder.
(Overrides BaseScanController.ReadEncoderPosition(Int32))
Public methodReceiveEnhanced Waits for a response from the ScanHead head using the Enhanced Protocol up to timeoutMilliseconds for a response.
(Overrides BaseScanController.ReceiveEnhanced(Int32, Axes, Int32))
Public methodRefreshReadyToMark
(Overrides BaseScanController.RefreshReadyToMark())
Public methodReleaseList Discards the mapping of the used lists. Also recycles used list IDs. After this call, the object can't be updated anymore.
(Overrides BaseScanController.ReleaseList(List<Int32>))
Public methodResetDecoderCounts Resets the selected decoder counts to zero.
(Overrides BaseScanController.ResetDecoderCounts(Int32))
Public methodResetMarkCounter
(Overrides BaseScanController.ResetMarkCounter(String))
Public methodResetMarkOnTheFlyState Resets the Mark-On-The-Fly state.
(Overrides BaseScanController.ResetMarkOnTheFlyState())
Public methodResetProcessTransformation Resets the process transformation.
(Overrides BaseScanController.ResetProcessTransformation())
Public methodResetVariableSignal 
Public methodRunStandAloneList Starts execution of the Stand-Alone list.
(Overrides BaseScanController.RunStandAloneList())
Public methodSetExecutionInProgress
(Overrides BaseScanController.SetExecutionInProgress(Boolean))
Public methodSetFieldSize(dvec3) Sets the field size.
Public methodSetFieldSize(Double, Double, Double) Sets the field size.
Public methodSetHeadBias(Int32, dvec3)
(Overrides BaseScanController.SetHeadBias(Int32, dvec3))
Public methodSetHeadBias(Int32, Double[])
(Overrides BaseScanController.SetHeadBias(Int32, Double[]))
Public methodSetList Generates master list and send it with the referenced lists to the card.
(Overrides BaseScanController.SetList(Guid, Int32, Boolean, Boolean))
Public methodSetMarkInProgress Asserts or deasserts the mark in progress signal.
(Overrides BaseScanController.SetMarkInProgress(Boolean))
Protected methodSetMarkOnTheFlyProfile Send the provided MarkOnTheFly configuration to the card
(Overrides BaseScanController.SetMarkOnTheFlyProfile(MarkOnTheFlyProfile))
Public methodSetPowerCorrectionFile Sets the power correction file (*.pc3).
(Overrides BaseScanController.SetPowerCorrectionFile(String))
Public methodSetProcessTransformation Sets the process transformation.
(Overrides BaseScanController.SetProcessTransformation(dmat4))
Public methodSetScannerMonitorConfiguration Sends the scanner monitoring configuration to the card.
Public methodSetSpeedScale Sets the speed scale on the card.
(Overrides BaseScanController.SetSpeedScale(Double))
Public methodSetSpiConfig 
Public methodSetStandAloneList Sets the stand alone configuration on the card. The lists contained in JobLists must already be stored on the card.
(Overrides BaseScanController.SetStandAloneList(StandAloneConfiguration))
Public methodSetTimeZone Sets the specified time zone on the card.
Public methodSetVariableSignal 
Public methodShowUI Shows the specific UI embedded in the plugin instance.
(Inherited from BaseDeviceController)
Public methodShowUICallback Invokes the callback that can be used when the ShowUI method is done.
(Inherited from BaseDeviceController)
Public methodShowUICancelCallback Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button
(Inherited from BasePlugin)
Public methodSpiTransceive
(Overrides BaseScanController.SpiTransceive(Int32, UInt32[], Int32))
Public methodStoreStandAloneJob By storing the specified list on the card, it will persist after rebooting. The list must already exist on the card.
(Overrides BaseScanController.StoreStandAloneJob(Int32))
Public methodSynchronizeDeviceTime Synchronizes the time of the scan controller to the time of the host.
(Overrides BaseScanController.SynchronizeDeviceTime())
Public methodToString
(Inherited from BasePlugin)
Public methodTransceiveEnhanced Sends commands to the ScanHead head using the Enhanced Protocol, and waits up to timeoutMilliseconds for a response.
(Overrides BaseScanController.TransceiveEnhanced(Int32, Axes, UInt32[], Int32))
Public methodTransmitEnhanced Sends commands to the ScanHead head using the Enhanced Protocol.
(Overrides BaseScanController.TransmitEnhanced(Int32, Axes, UInt32[]))
Public methodUpdateConfiguration Updates the configuration of the provided type.
(Overrides BaseScanController.UpdateConfiguration(BaseScanController.ConfigurationType))
Public methodUpdateScanHeadConfiguration Sends the configuration of the scan heads to the card.
(Overrides BaseScanController.UpdateScanHeadConfiguration())
Public methodVerifyConnection Tests if the connection is still active.
(Overrides BaseScanController.VerifyConnection())
Public methodWaitExecution Blocks until the list is done executing ( list idle) .
(Overrides BaseScanController.WaitExecution(Guid, CancellationToken))
Top
See Also