YLPAPDLaser |
The YLPAPDLaserDevice type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AppendMessage |
Adds the given string to the list of received messages, with a
preceding timestamp in the manner of the RAYGUIDE log data.
The list is a ring buffer with at most 200 entries and shown in the
GUI.
(Inherited from BaseSerialLaserController) |
 | ArmLaser(Boolean) |
Overrides the ArmLaser() method because it is necessary to have
the commands SetEeOnCommand and SetLaserEmissionOnCommand
exclusively under control of the RS232 interface. Otherwise it is
not possible to set the pulse duration.
(Overrides BaseLaserControllerArmLaser(Boolean)) |
| ArmLaser(Boolean, Int32, IOPortCondition, NullableGuid) |
Arm or disarm the laser.
(Inherited from BaseLaserController) |
| ChangeBeamProfileT |
Selects a beam profile.
(Inherited from BaseLaserController) |
| CheckControllerFeature |
Checks whether the automation feature is supported.
(Inherited from BaseLaserController) |
| CheckOnLaserReadySerial |
Checks if the laser is ready by retrieving its state by the RS-232
connection.
(Overrides BaseSerialLaserControllerCheckOnLaserReadySerial) |
| ClearDelegates |
Removes all laser delegates.
(Inherited from BaseLaserController) |
| Connect |
Connects to the device.
(Inherited from BaseLaserController) |
| ConnectSerialPort |
Connects with the serial port.
(Inherited from BaseSerialLaserController) |
| CreateDefaultProfile |
Creates the default laser profile for this device.
(Overrides BaseLaserControllerCreateDefaultProfile) |
| Disconnect |
Disconnects from the device.
(Inherited from BaseLaserController) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Inherited from BaseSerialLaserController) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) |
| DoConnect |
Performs the connection process.
(Inherited from BaseSerialLaserController) |
| DoDisconnect |
Stops the message handler thread and closes the serial port.
(Inherited from BaseSerialLaserController) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoDoDoShowUI | (Overrides BaseSerialLaserControllerPluginDoDoDoShowUI(String)) |
| DoDoDoShowUICallback | (Overrides BaseSerialLaserControllerPluginDoDoDoShowUICallback(PluginSettingsView)) |
| DoDoShowUI | (Inherited from BaseSerialLaserControllerPlugin) |
| DoDoShowUICallback | (Inherited from BaseSerialLaserControllerPlugin) |
| DoShowUI | (Inherited from BaseLaserController) |
| DoShowUICallback | (Inherited from BaseLaserController) |
| EnablePointer(Boolean) |
Enable or disable the pointer.
(Inherited from BaseLaserController) |
| EnablePointer(Boolean, Int32) |
Enable or disable the pointer.
(Inherited from BaseLaserController) |
| EnablePointer(Boolean, IOPortCondition, NullableGuid) |
Enable or disable the pointer.
(Inherited from BaseLaserController) |
| EnablePointer(Boolean, Int32, IOPortCondition, NullableGuid) |
Enable or disable the pointer.
(Inherited from BaseLaserController) |
| GetDeviceStatusRepresentation | (Inherited from BaseSerialLaserController) |
| GetLaserArmed |
Returns true if the laser is armed.
(Inherited from BaseLaserController) |
| GetLaserState | Sends the GetLaserState command to the laser. |
| GetPointerEnabled |
Returns true if the laser is enabled.
(Inherited from BaseLaserController) |
| GetPowerScaleMultiplier |
Gets the power scale multiplier of the laser.
(Inherited from BaseLaserController) |
| GetPulseDurationList | Creates the list of available pulse durations settable with the serial command SetApdModeIndex ($69). |
| GetUsedScanController |
Retrieves the scan controller associated with this laser.
(Inherited from BaseSerialLaserController) |
| HandleExternalDeviceRequestAsync |
Handles a chained request for a given list of features.
(Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken)) |
| HandleSerialMessagesThread |
Receives as own thread all messages from the serial port. It will
run endless, listens at the configured COM port with a timeout of
1000 ms and ends when _isToRead is set to false.
(Overrides BaseSerialLaserControllerHandleSerialMessagesThread(Thread)) |
| Initialize |
Plug-in specific initialization can be done here if necessary.
(Overrides BasePluginInitialize) |
| InvokeArmedChanged | (Inherited from BaseLaserController) |
| InvokeCommunicationError |
Invokes communication error event.
(Inherited from BaseSerialLaserController) |
| InvokeCommunicationOk |
Invokes communication OK event.
(Inherited from BaseSerialLaserController) |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
| InvokeHasPointerChanged |
Invoke HasPointerChanged.
(Inherited from BaseLaserController) |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
| InvokePointerEnabledChanged | (Inherited from BaseLaserController) |
| InvokeSerialPortClosed |
Invokes the serial port closed event.
(Inherited from BaseSerialLaserController) |
| InvokeSerialPortOpened |
Invokes the serial port opened event.
(Inherited from BaseSerialLaserController) |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
| InvokeStillUnused |
Invokes still unused event.
(Inherited from BaseSerialLaserController) |
| InvokeUninitialized |
Invokes the Uninitialized event.
(Inherited from BaseSerialLaserController) |
| InvokeUsed |
Invokes used event.
(Inherited from BaseSerialLaserController) |
| IsAnalog |
Returns whether the laser’s power is controlled via an analog voltage.
(Inherited from BaseLaserController) |
| NormalizePowerValue |
Convert power value from a device specific value to a percentage.
(Overrides BaseLaserControllerNormalizePowerValue(Double)) |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| OnSerialPortConnected |
In this method class dependent actions can be done when the serial
port could be opened, e. g. getting the laser state.
(Overrides BaseSerialLaserControllerOnSerialPortConnected(Boolean)) |
| OnSerialPortDisconnected |
In this method class dependent actions can be done when the serial
port is disconnected.
(Overrides BaseSerialLaserControllerOnSerialPortDisconnected) |
| ReadLaserStatus |
Reads the status of the laser. Updates IsInAlarm.
(Inherited from BaseLaserController) |
| SetLaserConfig |
Send the laser configuration to the card
(Inherited from BaseLaserController) |
| SetOpticalPulseWidthT |
Sets the optical pulse width.
(Inherited from BaseLaserController) |
| SetPower |
Sets the laser power.
(Inherited from BaseLaserController) |
| SetPowerCalibrationFile |
Sets the power calibration file (*.pcl).
(Inherited from BaseLaserController) |
| SetPowerCorrectionFile |
Sets the power correction file (*.pc3).
(Inherited from BaseLaserController) |
| SetPowerScaleMultiplier |
Sets the PowerScaleMultiplier of the laser.
(Overrides BaseLaserControllerSetPowerScaleMultiplier(Double, Boolean)) |
| SetPulseRepetition |
Sets the PRR (Pulse Repetition Rate).
(Overrides BaseLaserControllerSetPulseRepetition(Double)) |
| SetPulseWidth |
Sets the pulse width.
(Overrides BaseLaserControllerSetPulseWidth(String)) |
| 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) |
| ToString | (Inherited from BasePlugin) |
| TurnLaserOff |
Deactivate the laser
(Overrides BaseLaserControllerTurnLaserOff) |
| TurnLaserOn |
Activates the laser
(Overrides BaseLaserControllerTurnLaserOn) |
| UpdateLaserStateGui |
Handles the traffic lights in the settings dialog, in the menu bar
and the device configuration dialog.
(Overrides BaseSerialLaserControllerUpdateLaserStateGui(Int32, String)) |
| UsePowerCorrectionValue |
TODO: Use the power correction file.
(Inherited from BaseLaserController) |
| ValidateDouble |
Validates whether a value is within a range.
(Inherited from BaseLaserController) |
| ValidateDutyCycle |
Validates a given laser duty cycle.
(Inherited from BaseLaserController) |
| ValidateFrequency |
Validates a given laser PRR within its allowable range.
(Inherited from BaseLaserController) |
| ValidatePower |
Validates a given laser power within its allowable range.
(Inherited from BaseLaserController) |
| ValidateProperties |
Validate property values.
(Overrides BaseSerialLaserControllerValidateProperties) |
| ValidateRange |
Validates whether a given range falls within a boundary.
(Inherited from BaseLaserController) |
See Also