Click or drag to resize

SPICE3Device Class

[Missing <summary> documentation for "T:RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3.SPICE3Device"]

Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      RAYLASE.Marker.Device.ScanControllerBaseScanController
        RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3SPICE3Device

Namespace: RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
Syntax
C#
Copy
public class SPICE3Device : BaseScanController

The SPICE3Device type exposes the following members.

Constructors
 NameDescription
Public methodSPICE3DeviceInitializes a new instance of the SPICE3Device class
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyArchiveOldFileOnStartup 
Public propertyAutomationFeatureSet Returns set of automation features, supported by the scan controller.
(Inherited from BaseScanController)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyConnections Define the number of connections used in parallel.
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyEnableLogging Gets or sets a flag for activate logging.
(Overrides BaseScanControllerEnableLogging)
Public propertyExecutionInProgressEnabled Returns true if the device is generating an execution in progress signal.
(Overrides BaseScanControllerExecutionInProgressEnabled)
Public propertyFieldSize Gets the field size defined by the primary scan head.
(Inherited from BaseScanController)
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
(Inherited from BaseScanController)
Protected propertyInternalScanHeads
(Inherited from BaseScanController)
Public propertyIOController Gets or sets the IO controller used by the scan controller.
(Overrides BaseScanControllerIOController)
Public propertyIPAddress Ip address of the device.
(Overrides BaseScanControllerIPAddress)
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsConnected Is true if the device is connected.
(Overrides BaseDeviceControllerIsConnected)
Public propertyIsInitialized Is true if the device is initialized.
(Inherited from BaseDeviceController)
Public propertyIsStandAlone
(Overrides BaseScanControllerIsStandAlone)
Public propertyIsUsingEmulator If true, an emulator is used instead of the actual scan controller.
(Inherited from BaseScanController)
Public propertyLaserController Gets or sets the laser controller used by the scan controller.
(Overrides BaseScanControllerLaserController)
Public propertyListCount Maximal number of usable lists.
(Overrides BaseScanControllerListCount)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Public propertyLogPath Gets or sets the path of the logfile.
(Overrides BaseScanControllerLogPath)
Public propertyMarkInProgressEnabled Returns true if the device is generating a mark in progress signal.
(Overrides BaseScanControllerMarkInProgressEnabled)
Public propertyMaxCommandsPerList Maximal commands per list.
(Overrides BaseScanControllerMaxCommandsPerList)
Public propertyMaxCorrectionFiles Maximal number of correction files.
(Inherited from BaseScanController)
Public propertyMaxScanHeads Maximal number of heads.
(Inherited from BaseScanController)
Public propertyMotfPositionDecoderCount Returns the number position decoders available for MarkOnTheFly operations.
(Overrides BaseScanControllerMotfPositionDecoderCount)
Public propertyMotfProfile Gets or sets the Mark On-The-Fly profile used by the scan controller.
(Overrides BaseScanControllerMotfProfile)
Public propertyPluginMetadata The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled.
(Inherited from BasePlugin)
Public propertyPositionDecoderCount Returns the total number of available position decoders.
(Overrides BaseScanControllerPositionDecoderCount)
Public propertyProcessTransformationQueue Gets the process transformation queue. Values can be added with EneuqueProcessTransformation(dmat4), and cleared with ClearProcessTransformationQueue.
Public propertyScanHeadCount Number of assigned scan heads
(Inherited from BaseScanController)
Public propertyScanHeadProtocol 
Public propertyScanHeads Gets the scan heads used by the scan controller.
(Inherited from BaseScanController)
Public propertyScannerMonitoring 
Public propertySerialController Gets or sets the serial controller used by the scan controller.
(Overrides BaseScanControllerSerialController)
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertyStatuses
(Inherited from BaseDeviceController)
Public propertyStepPeriod Gets the step period.
(Overrides BaseScanControllerStepPeriod)
Public propertySupportedChainableFeatureMap The map of chainable feature types supported by this device. The value indicates whether the feature is a transmitter or a receiver.
(Inherited from BaseDeviceController)
Public propertyUseLaserDeviceProfile Enables or disables sending the profile of the laser device to the card.
(Overrides BaseScanControllerUseLaserDeviceProfile)
Public propertyUseTransformationList 
Public propertyVirtualFieldSize A scan controller can possibly handle coordinates larger than the scan head's physical field size. This is the size of the virtual field size.
(Inherited from BaseScanController)
Public propertyVirtualFieldSizeScalingFactor A scan controller can possibly handle coordinates larger than the scan head's physical field size. These three values define the factors the scan head's physical field size must be multiplied with to get the virtual field size.
(Inherited from BaseScanController)
Top
Methods
 NameDescription
Public methodAbortExecution Aborts all ongoing executions.
(Overrides BaseScanControllerAbortExecution(Boolean))
Public methodAssignScanHead Assigns the scan head to the specified index
(Overrides BaseScanControllerAssignScanHead(BaseScanHead, Int32))
Public methodAssignScanHeads Assigns the scan heads.
(Overrides BaseScanControllerAssignScanHeads(IEnumerableBaseScanHead))
Public methodClearLists Clears all lists.
(Overrides BaseScanControllerClearLists)
Public methodClearProcessTransformationQueue Clears ProcessTransformationQueue.
Public methodConnect Connects to the device.
(Overrides BaseDeviceControllerConnect)
Public methodConvertListToEndlessMotf Converts non motf list to endless motf.
(Overrides BaseScanControllerConvertListToEndlessMotf(Int32))
Public methodDeleteStandAloneJob Deletes a stored job ( StoreStandAloneJob(Int32)) from the card.
(Overrides BaseScanControllerDeleteStandAloneJob(Int32))
Public methodDisconnect Disconnects from the device.
(Overrides BaseDeviceControllerDisconnect)
Public methodDiscoverCards Searches for internal or network cards.
(Overrides BaseScanControllerDiscoverCards)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the SPICE3Device and optionally releases the managed resources
(Overrides BaseDeviceControllerDispose(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 BasePluginDoShowUI(String))
Protected methodDoShowUICallback
(Overrides BasePluginDoShowUICallback(PluginSettingsView))
Public methodEnableJobLoop
(Overrides BaseScanControllerEnableJobLoop(Boolean))
Public methodEnableStandAloneMode Enables the Stand-Alone mode. If enabled, the card will start executing the Stand-Alone list after booting up.
(Overrides BaseScanControllerEnableStandAloneMode(Boolean))
Public methodEneuqueProcessTransformation Adds a transformation to ProcessTransformationQueue.
Public methodExecuteList Puts the given list in the SP-ICE-3 execution's queue.
(Overrides BaseScanControllerExecuteList(Int32, Boolean, CancellationToken))
Public methodGetActiveBias Returns the active bias from the card.
(Overrides BaseScanControllerGetActiveBias(Int32))
Public methodGetActiveFieldTransformation Returns the active field transformation from the card.
(Overrides BaseScanControllerGetActiveFieldTransformation(Int32))
Public methodGetDeviceStatusRepresentation Gets the device status in form of color and description.
(Inherited from BaseScanController)
Public methodGetExpectedMaxBeltSpeed
(Overrides BaseScanControllerGetExpectedMaxBeltSpeed(Double))
Public methodGetFieldCorrectionFile Gets the field correction file from the card.
(Overrides BaseScanControllerGetFieldCorrectionFile(Int32, String))
Public methodGetListHash
(Overrides BaseScanControllerGetListHash(Guid))
Public methodGetMarkCounter
(Overrides BaseScanControllerGetMarkCounter(String))
Public methodGetProcessTransformation Gets the process transformation.
(Overrides BaseScanControllerGetProcessTransformation)
Public methodGetProcessVariables Gets a marker pen created from the last used values of the card.
(Overrides BaseScanControllerGetProcessVariables)
Public methodGetSpeedScale Returns the speed scale currently used by the card.
(Overrides BaseScanControllerGetSpeedScale)
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 BaseScanControllerGetUsedLogPath)
Public methodGoToXY(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.
(Overrides BaseScanControllerGoToXY(dvec2, Double, Boolean, NullableCancellationToken))
Public methodGoToXY(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.
(Overrides BaseScanControllerGoToXY(dvec2, Double, Double, Boolean, NullableCancellationToken))
Public methodGoToXYZ(dvec3, Double, Boolean, NullableCancellationToken) Jumps to the 3D Position with the defined speed.
(Overrides BaseScanControllerGoToXYZ(dvec3, Double, Boolean, NullableCancellationToken))
Public methodGoToXYZ(dvec3, Double, Double, Boolean, NullableCancellationToken) Jumps to the 3D Position with the defined speed and jump delay.
(Overrides BaseScanControllerGoToXYZ(dvec3, Double, Double, Boolean, NullableCancellationToken))
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken))
Public methodHasAutomationFeature 
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize)
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 BaseScanControllerIsExecutionInProgress)
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 BaseScanControllerPrepareBitmapGraphicList(BitmapHolder, dmat4, BitmapMarkerProfile, IOPortCondition, NullableGuid, Int32, IDictionaryInt32, ValueTupleNullableDouble, Nullabledvec3, Int32, Int32, Int32, Boolean, Boolean, NullableGuid))
Public methodPrepareDelay Creates a list with the specified delay.
(Overrides BaseScanControllerPrepareDelay(Double, IOPortCondition, NullableGuid))
Public methodPrepareEnhancedCommand
(Overrides BaseScanControllerPrepareEnhancedCommand(Int32, IListValueTupleAxes, UInt32, Int32, IOPortCondition, NullableGuid))
Public methodPrepareExecutionInProgress
(Overrides BaseScanControllerPrepareExecutionInProgress(Boolean, NullableGuid))
Public methodPrepareMarkInProgress Creates a list asserting or deasserting the mark in progress signal.
(Overrides BaseScanControllerPrepareMarkInProgress(Boolean, NullableGuid))
Public methodPrepareMarkOnTheFlyHead Creates a list to setup the MarkOnTheFly.
(Overrides BaseScanControllerPrepareMarkOnTheFlyHead(MarkOnTheFlyTriggerProfile, NullableGuid))
Public methodPrepareMarkOnTheFlyTail Creates a list to cleanup the MarkOnTheFly.
(Overrides BaseScanControllerPrepareMarkOnTheFlyTail(MarkOnTheFlyTriggerProfile, NullableGuid))
Public methodPrepareMasterSingleList Creates a list containing the job settings for single list mode.
(Overrides BaseScanControllerPrepareMasterSingleList(Int32, Boolean, Boolean, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, NullableGuid, Boolean, Int32, String, Boolean, Boolean))
Public methodPrepareSetCorrectionFileIndex Creates a list for switching the used correction file index.
(Overrides BaseScanControllerPrepareSetCorrectionFileIndex(Int32, NullableGuid))
Public methodPrepareSetDataCommand
(Overrides BaseScanControllerPrepareSetDataCommand(SetDataMetafileCommand, Int32, IOPortCondition, NullableGuid))
Public methodPrepareSubMasterSingleList Creates a list to contain other lists.
(Overrides BaseScanControllerPrepareSubMasterSingleList(IOPortCondition, NullableGuid))
Public methodPrepareVectorGraphicList(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)].
(Inherited from BaseScanController)
Public methodPrepareVectorGraphicList(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)].
(Overrides BaseScanControllerPrepareVectorGraphicList(IListVectorGraphicLayersWrapper, Int32, dmat4, GenericMarkerProfile, IDictionaryVectorGraphicPath, ValueTupleNullableDouble, Nullabledvec3, dvec3, IOPortCondition, NullableGuid, Int32, Int32, Int32, Boolean, Boolean, NullableGuid))
Public methodPrepareVectorGraphicList(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)].
(Inherited from BaseScanController)
Public methodReadEncoderCounts Reads the current position of the selected encoder in ticks.
(Overrides BaseScanControllerReadEncoderCounts(Int32))
Public methodReadEncoderPosition Reads the current position of the selected encoder.
(Overrides BaseScanControllerReadEncoderPosition(Int32))
Public methodReceiveEnhanced Waits for a response from the ScanHead head using the Enhanced Protocol up to timeoutMilliseconds for a response.
(Overrides BaseScanControllerReceiveEnhanced(Int32, Axes, Int32))
Public methodRefreshReadyToMark
(Overrides BaseScanControllerRefreshReadyToMark)
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 BaseScanControllerReleaseList(ListInt32))
Public methodResetDecoderCounts Resets the selected decoder counts to zero.
(Overrides BaseScanControllerResetDecoderCounts(Int32))
Public methodResetMarkCounter
(Overrides BaseScanControllerResetMarkCounter(String))
Public methodResetMarkOnTheFlyState Resets the Mark-On-The-Fly state.
(Overrides BaseScanControllerResetMarkOnTheFlyState)
Public methodResetProcessTransformation Resets the process transformation.
(Overrides BaseScanControllerResetProcessTransformation)
Public methodRunStandAloneList Starts execution of the Stand-Alone list.
(Overrides BaseScanControllerRunStandAloneList)
Public methodSetExecutionInProgress
(Overrides BaseScanControllerSetExecutionInProgress(Boolean))
Public methodSetFieldSize(dvec3) Sets the field size.
Public methodSetFieldSize(Double, Double, Double) Sets the field size.
Public methodSetHeadBias(Int32, dvec3)
(Overrides BaseScanControllerSetHeadBias(Int32, dvec3))
Public methodSetHeadBias(Int32, Double)
(Overrides BaseScanControllerSetHeadBias(Int32, Double))
Public methodSetList Generates master list and send it with the referenced lists to the card.
(Overrides BaseScanControllerSetList(Guid, Int32, Boolean, Boolean))
Public methodSetMarkInProgress Asserts or deasserts the mark in progress signal.
(Overrides BaseScanControllerSetMarkInProgress(Boolean))
Protected methodSetMarkOnTheFlyProfile Send the provided MarkOnTheFly configuration to the card
(Overrides BaseScanControllerSetMarkOnTheFlyProfile(MarkOnTheFlyProfile))
Public methodSetPowerCorrectionFile Sets the power correction file (*.pc3).
(Overrides BaseScanControllerSetPowerCorrectionFile(String))
Public methodSetProcessTransformation Sets the process transformation.
(Overrides BaseScanControllerSetProcessTransformation(dmat4))
Public methodSetScannerMonitorConfiguration Sends the scanner monitoring configuration to the card.
Public methodSetSpeedScale Sets the speed scale on the card.
(Overrides BaseScanControllerSetSpeedScale(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 BaseScanControllerSetStandAloneList(StandAloneConfiguration))
Public methodSetTimeZone Sets the specified time zone on the card.
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 BaseScanControllerSpiTransceive(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 BaseScanControllerStoreStandAloneJob(Int32))
Public methodSynchronizeDeviceTime Synchronizes the time of the scan controller to the time of the host.
(Overrides BaseScanControllerSynchronizeDeviceTime)
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 BaseScanControllerTransceiveEnhanced(Int32, Axes, UInt32, Int32))
Public methodTransmitEnhanced Sends commands to the ScanHead head using the Enhanced Protocol.
(Overrides BaseScanControllerTransmitEnhanced(Int32, Axes, UInt32))
Public methodUpdateConfiguration Updates the configuration of the provided type.
(Overrides BaseScanControllerUpdateConfiguration(BaseScanControllerConfigurationType))
Public methodUpdateScanHeadConfiguration Sends the configuration of the scan heads to the card.
(Overrides BaseScanControllerUpdateScanHeadConfiguration)
Public methodVerifyConnection Tests if the connection is still active.
(Overrides BaseScanControllerVerifyConnection)
Public methodWaitExecution Blocks until the list is done executing ( list idle) .
(Overrides BaseScanControllerWaitExecution(Guid, CancellationToken))
Top
Events
 NameDescription
Public eventConnected An event that is triggered when the device is connected.
(Inherited from BaseDeviceController)
Public eventDeviceUIRequested Getting called when a device ui gets requested.
(Inherited from BaseScanController)
Public eventDisconnected An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController)
Public eventExecutionFinished Event that will be raised when the execution has finished.
(Inherited from BaseScanController)
Public eventExecutionStarted Event that will be raised when the execution is starting.
(Inherited from BaseScanController)
Public eventFieldSizeChanged Event that will be raised when the field size has changed.
(Inherited from BaseScanController)
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventLaserControllerChanged Getting called when the laser controller changes.
(Inherited from BaseScanController)
Public eventReadyToMarkChanged Getting called when the ready to mark status changes.
(Inherited from BaseScanController)
Public eventScanControllerError Event that will be raised in case of an scan controller error.
(Inherited from BaseScanController)
Public eventScanHeadChanged Getting called when the scan head changes.
(Inherited from BaseScanController)
Public eventSliceStarted
(Inherited from BaseScanController)
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Top
See Also