Click or drag to resize

BaseScanController Class

Represents the base class for plugins of type scan controller devices.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      RAYLASE.Marker.Device.ScanControllerBaseScanController
        RAYLASE.MarkerPlugin.Devices.ScanController.SPICE3SPICE3Device

Namespace: RAYLASE.Marker.Device.ScanController
Assembly: RAYLASE.Marker.Device (in RAYLASE.Marker.Device.dll) Version: 2.19.0
Syntax
C#
public abstract class BaseScanController : BaseDeviceController

The BaseScanController type exposes the following members.

Constructors
 NameDescription
Protected methodBaseScanController ctor
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyAutomationFeatureSet Returns set of automation features, supported by the scan controller.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyEnableLogging Enables or disables the device logging.
Public propertyExecutionInProgressEnabled Returns true if the device is generating an execution in progress signal.
Public propertyFieldSize Gets the field size defined by the primary scan head.
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
(Overrides BaseDeviceControllerHasConnectedStatus)
Protected propertyInternalScanHeads 
Public propertyIOController Gets or sets the IO controller used by the scan controller.
Public propertyIPAddress Ip address of the device.
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsConnected Is true if the device is connected.
(Inherited from BaseDeviceController)
Public propertyIsInitialized Is true if the device is initialized.
(Inherited from BaseDeviceController)
Public propertyIsStandAlone True if card is in Stand-Alone mode.
Public propertyIsUsingEmulator If true, an emulator is used instead of the actual scan controller.
Public propertyLaserController Gets or sets the laser controller used by the scan controller.
Public propertyListCount Maximal number of usable lists.
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.
Public propertyMarkInProgressEnabled Returns true if the device is generating a mark in progress signal.
Public propertyMaxCommandsPerList Maximal commands per list.
Public propertyMaxCorrectionFiles Maximal number of correction files.
Public propertyMaxScanHeads Maximal number of heads.
Public propertyMotfPositionDecoderCount Returns the number position decoders available for MarkOnTheFly operations.
Public propertyMotfProfile Gets or sets the Mark On-The-Fly profile used by the scan controller.
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.
Public propertyScanHeadCount Number of assigned scan heads
Public propertyScanHeads Gets the scan heads used by the scan controller.
Public propertySerialController Gets or sets the serial controller used by the scan controller.
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertyStatuses
(Inherited from BaseDeviceController)
Public propertyStepPeriod Gets the step period.
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.
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.
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.
Top
Methods
 NameDescription
Public methodAbortExecution Aborts all ongoing executions.
Public methodAssignScanHead Assigns the scan head to the specified index
Public methodAssignScanHeads Assigns the scan heads.
Public methodClearLists Clears all lists.
Public methodConnect Connects to the device.
(Inherited from BaseDeviceController)
Public methodConvertListToEndlessMotf Converts non motf list to endless motf.
Public methodDeleteStandAloneJob Deletes a stored job ( StoreStandAloneJob(Int32)) from the card.
Public methodDisconnect Disconnects from the device.
(Inherited from BaseDeviceController)
Public methodDiscoverCards Searches for internal or network cards.
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BaseDeviceController)
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.
(Inherited from BasePlugin)
Protected methodDoShowUICallback Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin)
Public methodEnableJobLoop Exits the loop set by PrepareMasterSingleList(Int32, Boolean, Boolean, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, MarkOnTheFlyTriggerProfile, NullableGuid, Boolean, Int32, String, Boolean, Boolean) after the current iteration.
Public methodEnableStandAloneMode Enables the Stand-Alone mode. If enabled, the card will start executing the Stand-Alone list after booting up.
Public methodExecuteList Puts the given list in the SP-ICE-3 execution's queue.
Public methodGetActiveBias Returns the active bias from the card.
Public methodGetActiveFieldTransformation Returns the active field transformation from the card.
Public methodGetDeviceStatusRepresentation Gets the device status in form of color and description.
(Overrides BaseDeviceControllerGetDeviceStatusRepresentation)
Public methodGetExpectedMaxBeltSpeed 
Public methodGetFieldCorrectionFile Gets the field correction file from the card.
Public methodGetListHash Gets the list hash for the provided list guid.
Public methodGetMarkCounter 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.
Public methodGetProcessTransformation Gets the process transformation.
Public methodGetProcessVariables Gets a marker pen created from the last used values of the card.
Public methodGetSpeedScale Returns the speed scale currently used by 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.
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.
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.
Public methodGoToXYZ(dvec3, Double, Boolean, NullableCancellationToken) Jumps to the 3D Position with the defined speed.
Public methodGoToXYZ(dvec3, Double, Double, Boolean, NullableCancellationToken) Jumps to the 3D Position with the defined speed and jump delay.
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Inherited from BaseDeviceController)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDeviceUIRequested Invokes DeviceUIRequested.
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Protected methodInvokeLaserControllerChanged Invokes LaserControllerChanged.
Protected methodInvokeReadyToMarkChanged Invokes ReadyToMarkChanged.
Protected methodInvokeScanHeadChanged Invokes ScanHeadChanged.
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Public methodIsExecutionInProgress Returns true if execution is in progress.
Protected methodOnDevicesChanged
(Overrides BaseDeviceControllerOnDevicesChanged(ISetBaseDeviceController))
Protected methodOnExecutionFinished Invokes ExecutionFinished.
Protected methodOnExecutionStarted Invokes ExecutionStarted.
Protected methodOnScanControllerError Invokes ScanControllerError.
Protected methodOnSliceStarted 
Public methodPrepareBitmapGraphicList Creates the commands lists internally. Prepared lists can be downloaded with [M:BaseScanController.SetList(???,System.Int32,System.Boolean,System.Boolean)].
Public methodPrepareDelay Creates a list with the specified delay.
Public methodPrepareEnhancedCommand Creates a list with the specified enhanced command.
Public methodPrepareExecutionInProgress Creates a list asserting or deasserting the execution in progress signal.
Public methodPrepareMarkInProgress Creates a list asserting or deasserting the mark in progress signal.
Public methodPrepareMarkOnTheFlyHead Creates a list to setup the MarkOnTheFly.
Public methodPrepareMarkOnTheFlyTail Creates a list to cleanup the MarkOnTheFly.
Public methodPrepareMasterSingleList Creates a list containing the job settings for single list mode.
Public methodPrepareSetCorrectionFileIndex Creates a list for switching the used correction file index.
Public methodPrepareSetDataCommand Creates a list with the specified enhanced command.
Public methodPrepareSubMasterSingleList Creates a list to contain other lists.
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)].
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)].
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)].
Public methodReadEncoderCounts Reads the current position of the selected encoder in ticks.
Public methodReadEncoderPosition Reads the current position of the selected encoder.
Public methodReceiveEnhanced Waits for a response from the ScanHead head using the Enhanced Protocol up to timeoutMilliseconds for a response.
Public methodRefreshReadyToMark Refreshes the ReadyToMark state of the scan controller.
Public methodReleaseList Discards the mapping of the used lists. Also recycles used list IDs. After this call, the object can't be updated anymore.
Public methodResetDecoderCounts Resets the selected decoder counts to zero.
Public methodResetMarkCounter Resets to zero the value of the mark counter with a given name.
Public methodResetMarkOnTheFlyState Resets the Mark-On-The-Fly state.
Public methodResetProcessTransformation Resets the process transformation.
Public methodRunStandAloneList Starts execution of the Stand-Alone list.
Public methodSetExecutionInProgress Asserts or deasserts the execution in progress signal.
Public methodSetHeadBias(Int32, dvec3) Sets the head bias.
Public methodSetHeadBias(Int32, Double) Sets the head bias.
Public methodSetList Generates master list and send it with the referenced lists to the card.
Public methodSetMarkInProgress Asserts or deasserts the mark in progress signal.
Protected methodSetMarkOnTheFlyProfile Send the provided MarkOnTheFly configuration to the card
Public methodSetPowerCorrectionFile Sets the power correction file (*.pc3).
Public methodSetProcessTransformation Sets the process transformation.
Public methodSetSpeedScale Sets the speed scale on the card.
Public methodSetStandAloneList Sets the stand alone configuration on the card. The lists contained in JobLists must already be stored 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 Transceives commands via the spi bus.
Public methodStoreStandAloneJob By storing the specified list on the card, it will persist after rebooting. The list must already exist on the card.
Public methodSynchronizeDeviceTime Synchronizes the time of the scan controller to the time of the host.
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.
Public methodTransmitEnhanced Sends commands to the ScanHead head using the Enhanced Protocol.
Public methodUpdateConfiguration Updates the configuration of the provided type.
Public methodUpdateScanHeadConfiguration Sends the configuration of the scan heads to the card.
Public methodVerifyConnection Tests if the connection is still active.
Public methodWaitExecution Blocks until the list is done executing ( list idle) .
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.
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.
Public eventExecutionStarted Event that will be raised when the execution is starting.
Public eventFieldSizeChanged Event that will be raised when the field size has changed.
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventLaserControllerChanged Getting called when the laser controller changes.
Public eventReadyToMarkChanged Getting called when the ready to mark status changes.
Public eventScanControllerError Event that will be raised in case of an scan controller error.
Public eventScanHeadChanged Getting called when the scan head changes.
Public eventSliceStarted 
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Top
See Also