Base |
public abstract class BaseScanHead : BaseDeviceController
The BaseScanHead type exposes the following members.
Name | Description | |
---|---|---|
![]() | BaseScanHead | BaseScanHead constructor. |
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. |
![]() | Axes | Gets the Number of mechanical axes. |
![]() | AxesStateMap | Gets the AxisState of the axes. |
![]() | Calibration | Gets the calibration used for the hot laser. |
![]() | CalibrationRequested | Getting called when calibration gets requested. |
![]() | Calibrations | Gets the array of calibrations used for the hot laser. One calibration per correction file. |
![]() | CancelJobLoopRequested | Gets or sets the delegate for canceling the job loop. Used for ending the pointer preview. |
![]() | CheckControllerFeatureDelegate | Gets or sets the delegate for checking the controller features. |
![]() | ConfigurationManager | (Inherited from BasePlugin) |
![]() | Connector | The communication to the controlling device. |
![]() | CorrectionFile | Get or sets the path of the field correction file. |
![]() | CorrectionFileHash | The hash value of the correction file; only set in case of "*.fc3" files, otherwise empty string. |
![]() | CorrectionFiles | |
![]() | DataProvider | The information provider for scan heads. The information contains the model name and the list of available tunings. |
![]() | Dimensions | Gets the number of dimensions. Fourth dimension is used for spot magnification. |
![]() | DisableAxes | Defines whether the axes should be disabled during laser execution. |
![]() | 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. |
![]() | EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
![]() | EnableFieldCorrection | Enables the field correction defined in CorrectionFile. |
![]() | FieldSize | Gets the size of the marking field. This is normally defined by the used CorrectionFile. |
![]() | FocalLength | Gets the focal length of the scan head. Only used for informational purposes. It's normally defined by the used CorrectionFile. |
![]() | 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. |
![]() | HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Overrides BaseDeviceControllerHasConnectedStatus) |
![]() | HasMagnification | Returns true if the scan head supports magnification. This can either be achieved via an additional axis (HasOpticalZoom) or via defocussing. |
![]() | HasOpticalZoom | Returns true if the scan head has an additional z-axis for magnifying the spot. |
![]() | 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. |
![]() | HasZAxis | Returns true if the scan head has a z-axis for setting the focus level. |
![]() | IgnoredProperties | The current value of the card are kept ,instead of overwriting them with the defined values. |
![]() | InterpolationTime | Gets or sets the interpolation time of the deflection unit. |
![]() | InvertXAxis | Gets or sets the flag for inverting the x-axis. |
![]() | InvertYAxis | Gets or sets the flag for inverting the y-axis. |
![]() | IsAutoConnect | (Inherited from BaseDeviceController) |
![]() | IsConnected |
Is true if the device is connected.
(Inherited from BaseDeviceController) |
![]() | IsInError | The flag to indicate that the device is in error state. |
![]() | 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. |
![]() | MaxGalvoCurrent | Gets or sets the maximal recommended galvanometer current [A]. |
![]() | MaxLensTravel | Gets maximal distance, the z-lens can travel. It's normally defined by the used CorrectionFile. |
![]() | 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. |
![]() | MaxSpeed | Gets or sets maximum speed. It is used during the job validation, in case the scan head validation is active. |
![]() | Monitoring | |
![]() | Orientation | Gets or sets the orientation of the scan head. It defines the relation of the scan head to the workspace in 90° steps. |
![]() | 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. |
![]() | PointerCalibrations | Gets the array of calibrations used for the hot pointer. One calibration per correction file. |
![]() | PrepareSendEnhancedDelegate | Gets or sets the delegate for preparing the send enhanced delegate. |
![]() | ReceiveEnhancedDelegate | Gets or sets the receive enhanced command delegate. |
![]() | ScanHeadInformationMap | Gets the ScanHeadInformation of the axes. |
![]() | SelectCorrectionFileDelegate | Gets or sets the delegate for activating the (already existing) correction file. |
![]() | SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
![]() | SetProcessTransformationRequested | Gets or sets the delegate for sending the process transformation to the scan controller. |
![]() | SpotSize | Size of laser spot. Can be used for converting magnification factor to absolute values. |
![]() | 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. |
![]() | TransceiveEnhancedDelegate | Gets or sets the transceive enhanced command delegate. |
![]() | TransmitEnhancedDelegate | Gets or sets the transmit enhanced command delegate. |
![]() | Wavelength | Gets the wavelength used by the scan head. Only used for informational purposes. It's normally defined by the used CorrectionFile. |
![]() | 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. |
Name | Description | |
---|---|---|
![]() | CheckControllerFeature | Checks whether the feature is supported by the scan head. |
![]() | ClearDelegates | Removes all laser delegates. |
![]() | Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
![]() | Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) |
![]() | 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) |
![]() | FetchAxisParameters | Gets a dictionary containing the mapping from axis to tracking error. |
![]() | FetchScanHeadInfo | Fills ScanHeadInformationMap with data queried from the scan head. |
![]() | GetDeviceStatusRepresentation |
Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController) |
![]() | GetFieldTransformation | Returns transformation used for execution with laser. |
![]() | GetInformation | Queries ScanHeadInformation from the scan head. |
![]() | GetPointerTransformation | Returns transformation used for execution with pointer (preview). |
![]() | GetScaleAndFullRotation | Returns transformation used for execution with laser. |
![]() | GetStatuses | Gets the status word (0x0500u) of the scan head. |
![]() | GetTuningPresets | Returns the tuning presets for the given axes. |
![]() | GetTunings | Gets a dictionary containing the mapping from axis to active/default tuning. |
![]() | 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.
(Overrides BasePluginInitialize) |
![]() | InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
![]() | InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
![]() | InvokeFocusTesterRequested | |
![]() | InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
![]() | InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
![]() | IsOperational | Returns true if the scan head is operational. |
![]() | LoadDataProvider | Loads the data provider. |
![]() | OnDevicesChanged | (Inherited from BaseDeviceController) |
![]() | OnUpdateCardConfiguration | Updates the configuration of the scan controller, the scan head is assigned to. |
![]() | RaiseMonitoringError | |
![]() | ResetCalibration | Resets the nth Calibrations. |
![]() | SaveSettings | Saves the axis settings on the scan head. |
![]() | SelectCorrectionFile | Activates the (already existing) correction file. |
![]() | SendBias | Sends the bias from Calibration to the connected scan controller. |
![]() | SetPreFilterUsageState | |
![]() | SetTunings | Builds a command list for setting the tuning. |
![]() | 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 | |
![]() | StopMonitoring | |
![]() | ToString | (Inherited from BasePlugin) |
![]() | VerifyMonitoringSettings | Verifies the montoring settings. Monitring should be enabled enabled exclusively, by scan controller or scan head. |
![]() | VerifyMonitoringStatus | Verifies the monitoring status of the scan head. Might depend on the scan controller configuration (eg. scanner monitoring). |
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 | |
![]() | 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. |
Name | Description | |
---|---|---|
![]() | FocusTesterRequested | Getting called when focus tester UI gets requested. |