Generic |
Provides the functionalities for a generic deflection unit.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.ScanHeadBaseScanHead
RAYLASE.MarkerPlugin.Devices.ScanHeadGenericScanHead
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.ScanHeadBaseScanHead
RAYLASE.MarkerPlugin.Devices.ScanHeadGenericScanHead
Namespace: RAYLASE.MarkerPlugin.Devices.ScanHead
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
SyntaxC#
public class GenericScanHead : BaseScanHead
The GenericScanHead type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GenericScanHead | ctor |
Properties| Name | Description | |
|---|---|---|
 | ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) |
| Aperture |
Gets the aperture of the scan head. Only used for informational purposes.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| Axes |
Gets the Number of mechanical axes.
(Inherited from BaseScanHead) |
| AxesStateMap |
Gets the AxisState of the axes.
(Inherited from BaseScanHead) |
| Calibration |
Gets the calibration used for the hot laser.
(Inherited from BaseScanHead) |
| CalibrationRequested |
Getting called when calibration gets requested.
(Inherited from BaseScanHead) |
| Calibrations |
Gets the array of calibrations used for the hot laser. One calibration per correction file.
(Inherited from BaseScanHead) |
| CancelJobLoopRequested |
Gets or sets the delegate for canceling the job loop. Used for ending the pointer preview.
(Inherited from BaseScanHead) |
| CheckControllerFeatureDelegate |
Gets or sets the delegate for checking the controller features.
(Inherited from BaseScanHead) |
 | ConfigurationManager | (Inherited from BasePlugin) |
| Connector |
The communication to the controlling device.
(Inherited from BaseScanHead) |
| CorrectionFile |
Get or sets the path of the field correction file.
(Overrides BaseScanHeadCorrectionFile) |
| CorrectionFileHash |
The hash value of the correction file; only set in case of "*.fc3" files, otherwise empty string.
(Inherited from BaseScanHead) |
| CorrectionFiles | (Inherited from BaseScanHead) |
| DataProvider |
The information provider for scan heads. The information contains the model name and the list of available tunings.
(Inherited from BaseScanHead) |
| DeviceState | |
| Dimensions |
Gets the number of dimensions. Fourth dimension is used for spot magnification.
(Inherited from BaseScanHead) |
| DisableAxes |
Defines whether the axes should be disabled during laser execution.
(Inherited from BaseScanHead) |
| DisableAxesOnPreview |
Defines whether the axes should be disabled during pointer preview. This can be useful, in case the z-axis cannot keep up with the fast preview speed.
(Inherited from BaseScanHead) |
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
| EnableFieldCorrection |
Enables the field correction defined in CorrectionFile.
(Inherited from BaseScanHead) |
| FieldSize |
Gets the size of the marking field. This is normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| FocalLength |
Gets the focal length of the scan head. Only used for informational purposes.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| HasAuxiliaryAxis |
Returns true if the scan head has an additional third sensor axis. The additional axis has its own entries in the calibration file.
It can be used for example for a distance sensor Rayvolution Drive.
(Inherited from BaseScanHead) |
| HasBuiltInTuningData | Defines whether the tuning data can be fetched from the scan head. |
| HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Inherited from BaseScanHead) |
| HasMagnification |
Returns true if the scan head supports magnification. This can either be achieved via an additional axis (HasOpticalZoom) or via defocussing.
(Inherited from BaseScanHead) |
| HasOpticalZoom |
Returns true if the scan head has an additional z-axis for magnifying the spot.
(Inherited from BaseScanHead) |
| HasSensorAxis |
Returns true if the scan head has an additional sensor axis. The additional axis has its own entires in the calibration file.
It can be used for example for a camera or a pyrometer.
(Inherited from BaseScanHead) |
| HasZAxis |
Returns true if the scan head has a z-axis for setting the focus level.
(Inherited from BaseScanHead) |
| IgnoredProperties |
The current value of the card are kept ,instead of overwriting them with the defined values.
(Inherited from BaseScanHead) |
| InterpolationTime |
Gets or sets the interpolation time of the deflection unit.
(Inherited from BaseScanHead) |
| InvertXAxis |
Gets or sets the flag for inverting the x-axis.
(Inherited from BaseScanHead) |
| InvertYAxis |
Gets or sets the flag for inverting the y-axis.
(Inherited from BaseScanHead) |
| IsAutoConnect | (Inherited from BaseDeviceController) |
| IsConnected |
Is true if the device is connected.
(Overrides BaseDeviceControllerIsConnected) |
| IsInError |
The flag to indicate that the device is in error state.
(Inherited from BaseScanHead) |
| IsInitialized |
Is true if the device is initialized.
(Inherited from BaseDeviceController) |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| MarkPatternRequested |
Gets or sets the delegate for marking the pointer calibration pattern.
(Inherited from BaseScanHead) |
| MaxGalvoCurrent |
Gets or sets the maximal recommended galvanometer current [A].
(Inherited from BaseScanHead) |
| MaxLensTravel |
Gets maximal distance, the z-lens can travel.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| MaxMagnification |
Gets the maximal supported magnification. The range is always from 1 to MaxMagnification.
Returns 1 if magnification is not supported by the scan head.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| MaxSpeed |
Gets or sets maximum speed. It is used during the job validation, in case the scan head validation is active.
(Inherited from BaseScanHead) |
| Monitoring | (Inherited from BaseScanHead) |
| Orientation |
Gets or sets the orientation of the scan head. It defines the relation of the scan head to the workspace in 90° steps.
(Inherited from BaseScanHead) |
| PluginMetadata |
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) |
| PointerCalibration |
Gets the calibration used for the pointer.
(Inherited from BaseScanHead) |
| PointerCalibrations |
Gets the array of calibrations used for the hot pointer. One calibration per correction file.
(Inherited from BaseScanHead) |
| PrepareSendEnhancedDelegate |
Gets or sets the delegate for preparing the send enhanced delegate.
(Inherited from BaseScanHead) |
| ReceiveEnhancedDelegate |
Gets or sets the receive enhanced command delegate.
(Inherited from BaseScanHead) |
| ScanHeadInformationMap |
Gets the ScanHeadInformation of the axes.
(Inherited from BaseScanHead) |
| SelectCorrectionFileDelegate |
Gets or sets the delegate for activating the (already existing) correction file.
(Inherited from BaseScanHead) |
| SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
| SetProcessTransformationRequested |
Gets or sets the delegate for sending the process transformation to the scan controller.
(Inherited from BaseScanHead) |
| SpotSize |
Size of laser spot. Can be used for converting magnification factor to absolute values.
(Inherited from BaseScanHead) |
| Statuses | (Inherited from BaseDeviceController) |
| SupportedChainableFeatureMap |
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) |
| SupportedTuningAxes |
Gets the list of supported tuning axes.
(Inherited from BaseScanHead) |
| TransceiveEnhancedDelegate |
Gets or sets the transceive enhanced command delegate.
(Inherited from BaseScanHead) |
| TransmitEnhancedDelegate |
Gets or sets the transmit enhanced command delegate.
(Inherited from BaseScanHead) |
| Wavelength |
Gets the wavelength used by the scan head. Only used for informational purposes.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
| WorkingDistance |
Gets the distance between the scan head an the Z=0 plane. Only used for informational purposes.
It's normally defined by the used CorrectionFile.
(Inherited from BaseScanHead) |
Methods| Name | Description | |
|---|---|---|
| CheckControllerFeature |
Checks whether the feature is supported by the scan head.
(Inherited from BaseScanHead) |
| ClearDelegates |
Removes all laser delegates.
(Inherited from BaseScanHead) |
| Connect |
Connects to the device.
(Overrides BaseDeviceControllerConnect) |
| Disconnect |
Disconnects from the device.
(Overrides BaseDeviceControllerDisconnect) |
| Dispose | (Inherited from BasePlugin) |
 | Dispose(Boolean) | Releases the unmanaged resources used by the GenericScanHead and optionally releases the managed resources (Overrides BaseDeviceControllerDispose(Boolean)) |
| 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.
(Overrides BasePluginDoShowUI(String)) |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Overrides BasePluginDoShowUICallback(PluginSettingsView)) |
| FetchAxisParameters | (Overrides BaseScanHeadFetchAxisParameters(Axes)) |
| FetchScanHeadInfo |
Fills ScanHeadInformationMap with data queried from the scan head.
(Inherited from BaseScanHead) |
| GetDeviceStatusRepresentation | (Overrides BaseDeviceControllerGetDeviceStatusRepresentation) |
| GetFieldTransformation |
Returns transformation used for execution with laser.
(Inherited from BaseScanHead) |
| GetInformation |
Queries ScanHeadInformation from the scan head.
(Overrides BaseScanHeadGetInformation(Axes, Int32)) |
| GetPointerTransformation |
Returns transformation used for execution with pointer (preview).
(Inherited from BaseScanHead) |
| GetScaleAndFullRotation |
Returns transformation used for execution with laser.
(Inherited from BaseScanHead) |
| GetStatuses |
Gets the status word (0x0500u) of the scan head.
(Overrides BaseScanHeadGetStatuses(Axes, Int32)) |
| GetTuningPresets | (Overrides BaseScanHeadGetTuningPresets(Axes)) |
| GetTunings |
Gets a dictionary containing the mapping from axis to active/default tuning.
(Overrides BaseScanHeadGetTunings(Axes)) |
| HandleExternalDeviceRequestAsync |
Handles a chained request for a given list of features.
(Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken)) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Overrides BaseScanHeadInitialize) |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
| InvokeFocusTesterRequested | (Inherited from BaseScanHead) |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
| IsOperational | (Overrides BaseScanHeadIsOperational(Axes, Int32)) |
| LoadDataProvider |
Loads the data provider.
(Overrides BaseScanHeadLoadDataProvider) |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| OnMonitorTimerTick | |
| OnUpdateCardConfiguration |
Updates the configuration of the scan controller, the scan head is assigned to.
(Inherited from BaseScanHead) |
| RaiseMonitoringError | (Inherited from BaseScanHead) |
| ResetCalibration |
Resets the nth Calibrations.
(Overrides BaseScanHeadResetCalibration(Int32)) |
| SaveSettings |
Saves the axis settings on the scan head.
(Overrides BaseScanHeadSaveSettings(Axes, IOPortCondition, NullableGuid)) |
| SelectCorrectionFile |
Activates the (already existing) correction file.
(Inherited from BaseScanHead) |
| SendBias |
Sends the bias from Calibration to the connected scan controller.
(Inherited from BaseScanHead) |
| SetPreFilterUsageState | (Overrides BaseScanHeadSetPreFilterUsageState(Boolean)) |
| SetTunings |
Builds a command list for setting the tuning.
(Overrides BaseScanHeadSetTunings(IDictionaryAxes, UInt32, Int32, IOPortCondition, NullableGuid)) |
| 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) |
| StartMonitoring | (Overrides BaseScanHeadStartMonitoring) |
| StopMonitoring | (Overrides BaseScanHeadStopMonitoring) |
| ToString | (Inherited from BasePlugin) |
| VerifyMonitoringSettings | (Overrides BaseScanHeadVerifyMonitoringSettings) |
| VerifyMonitoringStatus |
Verifies the monitoring status of the scan head. Might depend on the scan controller configuration (eg. scanner monitoring).
(Overrides BaseScanHeadVerifyMonitoringStatus) |
Events| Name | Description | |
|---|---|---|
 | Connected |
An event that is triggered when the device is connected.
(Inherited from BaseDeviceController) |
| Disconnected |
An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController) |
| Initialized |
An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController) |
| MonitoringError | (Inherited from BaseScanHead) |
| StatusChanged |
An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController) |
| UpdateCardConfiguration |
Delegate for updating the configuration of the scan controller, the scan head is assigned to.
(Inherited from BaseScanHead) |
Fields| Name | Description | |
|---|---|---|
 | FocusTesterRequested |
Getting called when focus tester UI gets requested.
(Inherited from BaseScanHead) |
See Also