Click or drag to resize

BaseScanHead Class

Represents the base class for plugins of type scan head device.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      RAYLASE.Marker.Device.ScanHeadBaseScanHead
        RAYLASE.MarkerPlugin.Devices.ScanHeadGenericScanHead

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

The BaseScanHead type exposes the following members.

Constructors
 NameDescription
Protected methodBaseScanHead BaseScanHead constructor.
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyAperture Gets the aperture of the scan head. Only used for informational purposes. It's normally defined by the used CorrectionFile.
Public propertyAxes Gets the Number of mechanical axes.
Public propertyAxesStateMap Gets the AxisState of the axes.
Public propertyCalibration Gets the calibration used for the hot laser.
Public propertyCalibrationRequested Getting called when calibration gets requested.
Public propertyCalibrations Gets the array of calibrations used for the hot laser. One calibration per correction file.
Public propertyCancelJobLoopRequested Gets or sets the delegate for canceling the job loop. Used for ending the pointer preview.
Public propertyCheckControllerFeatureDelegate Gets or sets the delegate for checking the controller features.
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyConnector The communication to the controlling device.
Public propertyCorrectionFile Get or sets the path of the field correction file.
Public propertyCorrectionFileHash The hash value of the correction file; only set in case of "*.fc3" files, otherwise empty string.
Public propertyCorrectionFiles 
Protected propertyDataProvider The information provider for scan heads. The information contains the model name and the list of available tunings.
Public propertyDimensions Gets the number of dimensions. Fourth dimension is used for spot magnification.
Public propertyDisableAxes Defines whether the axes should be disabled during laser execution.
Public propertyDisableAxesOnPreview 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.
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyEnableFieldCorrection Enables the field correction defined in CorrectionFile.
Public propertyFieldSize Gets the size of the marking field. This is normally defined by the used CorrectionFile.
Public propertyFocalLength Gets the focal length of the scan head. Only used for informational purposes. It's normally defined by the used CorrectionFile.
Public propertyHasAuxiliaryAxis 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.
Public propertyHasConnectedStatus Is true if the device supports the IsConnected status.
(Overrides BaseDeviceControllerHasConnectedStatus)
Public propertyHasMagnification Returns true if the scan head supports magnification. This can either be achieved via an additional axis (HasOpticalZoom) or via defocussing.
Public propertyHasOpticalZoom Returns true if the scan head has an additional z-axis for magnifying the spot.
Public propertyHasSensorAxis 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.
Public propertyHasZAxis Returns true if the scan head has a z-axis for setting the focus level.
Public propertyIgnoredProperties The current value of the card are kept ,instead of overwriting them with the defined values.
Public propertyInterpolationTime Gets or sets the interpolation time of the deflection unit.
Public propertyInvertXAxis Gets or sets the flag for inverting the x-axis.
Public propertyInvertYAxis Gets or sets the flag for inverting the y-axis.
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsConnected Is true if the device is connected.
(Inherited from BaseDeviceController)
Public propertyIsInError The flag to indicate that the device is in error state.
Public propertyIsInitialized Is true if the device is initialized.
(Inherited from BaseDeviceController)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
Public propertyMarkPatternRequested Gets or sets the delegate for marking the pointer calibration pattern.
Public propertyMaxGalvoCurrent Gets or sets the maximal recommended galvanometer current [A].
Public propertyMaxLensTravel Gets maximal distance, the z-lens can travel. It's normally defined by the used CorrectionFile.
Public propertyMaxMagnification 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.
Public propertyMaxSpeed Gets or sets maximum speed. It is used during the job validation, in case the scan head validation is active.
Public propertyMonitoring 
Public propertyOrientation Gets or sets the orientation of the scan head. It defines the relation of the scan head to the workspace in 90° steps.
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 propertyPointerCalibration Gets the calibration used for the pointer.
Public propertyPointerCalibrations Gets the array of calibrations used for the hot pointer. One calibration per correction file.
Public propertyPrepareSendEnhancedDelegate Gets or sets the delegate for preparing the send enhanced delegate.
Public propertyReceiveEnhancedDelegate Gets or sets the receive enhanced command delegate.
Public propertyScanHeadInformationMap Gets the ScanHeadInformation of the axes.
Public propertySelectCorrectionFileDelegate Gets or sets the delegate for activating the (already existing) correction file.
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertySetProcessTransformationRequested Gets or sets the delegate for sending the process transformation to the scan controller.
Public propertySpotSize Size of laser spot. Can be used for converting magnification factor to absolute values.
Public propertyStatuses
(Inherited from BaseDeviceController)
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 propertySupportedTuningAxes Gets the list of supported tuning axes.
Public propertyTransceiveEnhancedDelegate Gets or sets the transceive enhanced command delegate.
Public propertyTransmitEnhancedDelegate Gets or sets the transmit enhanced command delegate.
Public propertyWavelength Gets the wavelength used by the scan head. Only used for informational purposes. It's normally defined by the used CorrectionFile.
Public propertyWorkingDistance 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.
Top
Methods
 NameDescription
Public methodCheckControllerFeature Checks whether the feature is supported by the scan head.
Public methodClearDelegates Removes all laser delegates.
Public methodConnect Connects to the device.
(Inherited from BaseDeviceController)
Public methodDisconnect Disconnects from the device.
(Inherited from BaseDeviceController)
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 methodFetchAxisParameters Gets a dictionary containing the mapping from axis to tracking error.
Public methodFetchScanHeadInfo Fills ScanHeadInformationMap with data queried from the scan head.
Public methodGetDeviceStatusRepresentation Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController)
Public methodGetFieldTransformation Returns transformation used for execution with laser.
Public methodGetInformation Queries ScanHeadInformation from the scan head.
Public methodGetPointerTransformation Returns transformation used for execution with pointer (preview).
Public methodGetScaleAndFullRotation Returns transformation used for execution with laser.
Public methodGetStatuses Gets the status word (0x0500u) of the scan head.
Protected methodGetTuningPresets Returns the tuning presets for the given axes.
Public methodGetTunings Gets a dictionary containing the mapping from axis to active/default tuning.
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.
(Overrides BasePluginInitialize)
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Protected methodInvokeFocusTesterRequested 
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Public methodIsOperational Returns true if the scan head is operational.
Protected methodLoadDataProvider Loads the data provider.
Protected methodOnDevicesChanged
(Inherited from BaseDeviceController)
Public methodOnUpdateCardConfiguration Updates the configuration of the scan controller, the scan head is assigned to.
Protected methodRaiseMonitoringError 
Public methodResetCalibration Resets the nth Calibrations.
Public methodSaveSettings Saves the axis settings on the scan head.
Public methodSelectCorrectionFile Activates the (already existing) correction file.
Public methodSendBias Sends the bias from Calibration to the connected scan controller.
Protected methodSetPreFilterUsageState 
Public methodSetTunings Builds a command list for setting the tuning.
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 methodStartMonitoring 
Public methodStopMonitoring 
Public methodToString
(Inherited from BasePlugin)
Public methodVerifyMonitoringSettings Verifies the montoring settings. Monitring should be enabled enabled exclusively, by scan controller or scan head.
Public methodVerifyMonitoringStatus Verifies the monitoring status of the scan head. Might depend on the scan controller configuration (eg. scanner monitoring).
Top
Events
 NameDescription
Public eventConnected An event that is triggered when the device is connected.
(Inherited from BaseDeviceController)
Public eventDisconnected An event that is triggered when the device is disconnected.
(Inherited from BaseDeviceController)
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventMonitoringError 
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Public eventUpdateCardConfiguration Delegate for updating the configuration of the scan controller, the scan head is assigned to.
Top
Fields
 NameDescription
Public fieldFocusTesterRequested Getting called when focus tester UI gets requested.
Top
See Also