YLPAPDLaser |
Provides the functionalities for an IPG YLP laser device.
Inheritance HierarchySystemObject
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.LaserControllerBaseLaserController
RAYLASE.Marker.Device.LaserControllerBaseSerialLaserController
RAYLASE.MarkerPlugin.Devices.LaserBaseSerialLaserControllerPlugin
RAYLASE.MarkerPlugin.Devices.Laser.IPG.YLPYLPAPDLaserDevice
RAYLASE.Marker.PluginBasePlugin
RAYLASE.Marker.DeviceBaseDeviceController
RAYLASE.Marker.Device.LaserControllerBaseLaserController
RAYLASE.Marker.Device.LaserControllerBaseSerialLaserController
RAYLASE.MarkerPlugin.Devices.LaserBaseSerialLaserControllerPlugin
RAYLASE.MarkerPlugin.Devices.Laser.IPG.YLPYLPAPDLaserDevice
Namespace: RAYLASE.MarkerPlugin.Devices.Laser.IPG.YLP
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
SyntaxC#
public class YLPAPDLaserDevice : BaseSerialLaserControllerPlugin
The YLPAPDLaserDevice type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | YLPAPDLaserDevice | The constructor. |
Properties| Name | Description | |
|---|---|---|
 | ActivatedChainableFeatures |
Gets the activated chainable features.
(Inherited from BaseDeviceController) |
| ArmLaserDelegate |
Gets or sets the arm laser delegate.
(Inherited from BaseLaserController) |
| AutoConfigureIO |
Automatically configures necessary IO pins depending on laser (eg. laser alarm, pilot and arm pins).
Only supported if Features contains AutoConfigureIO.
(Inherited from BaseLaserController) |
| CheckControllerFeatureDelegate |
Gets or sets the delegate for checking whether the automation feature is supported.
(Inherited from BaseLaserController) |
| CleanUpCommand | The delegate to generate the laser cleanup command. |
 | ConfigurationManager | (Inherited from BasePlugin) |
| Connector |
The communication to the controlling device.
(Inherited from BaseLaserController) |
| Delta |
The delta to be used for comparing doubles.
(Inherited from BaseLaserController) |
| DeviceManager | (Inherited from BaseSerialLaserController) |
| DoRead | (Inherited from BaseSerialLaserController) |
| EnableChainableFeature |
Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController) |
| EnablePointerDelegate |
Gets or sets the enable pointer delegate.
(Inherited from BaseLaserController) |
| EnableSerialPort |
If true the serial port will be used.
(Inherited from BaseSerialLaserController) |
| Features |
Returns set of features, supported by the laser controller.
(Inherited from BaseLaserController) |
| GetPowerScaleMultiplierDelegate |
Gets or sets the get power scale multiplier delegate.
(Inherited from BaseLaserController) |
| Green | (Inherited from BaseSerialLaserController) |
| HasConnectedStatus |
Is true if the device supports the IsConnected status.
(Inherited from BaseDeviceController) |
| IsAutoConnect | (Inherited from BaseDeviceController) |
| IsCommunicationOk |
Is true if the serial port communication is established,
false e. g. if an expected answer could not be received.
May be caused by a timeout or unexpected response.
(Inherited from BaseSerialLaserController) |
| IsConnected |
Is true if the device is connected.
(Inherited from BaseDeviceController) |
| IsInAlarm |
The flag to indicate that the laser device is in alarmed state.
(Inherited from BaseLaserController) |
| IsInitialized |
Is true if the device is initialized.
(Inherited from BaseDeviceController) |
| IsLaserArmedDelegate |
Gets or sets the is laser armed delegate.
(Inherited from BaseLaserController) |
| IsNew | (Inherited from BaseSerialLaserController) |
| IsPointerEnabledDelegate |
Gets or sets the is pointer enabled delegate.
(Inherited from BaseLaserController) |
| IsSerialPortOpen |
Flag to signal if the serial port is open.
(Inherited from BaseSerialLaserController) |
| IsStillUnused |
Is true if the serial port communication is established,
but still not used ("gray" state).
(Inherited from BaseSerialLaserController) |
| LaserProfile |
Various laser settings of the device.
(Inherited from BaseLaserController) |
| LastMessageStrings | (Inherited from BaseSerialLaserController) |
| LightGray | (Inherited from BaseSerialLaserController) |
| LogDirectory |
The directory of the log file.
(Inherited from BasePlugin) |
| Logger |
The common logger.
(Inherited from BasePlugin) |
| MessageHandler | (Inherited from BaseSerialLaserController) |
| 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) |
| ReadApdModeDescriptionCommand | The delegate to generate the laser ReadApdModeDescription command. |
| ReadApdModeIndexCommand | The delegate to generate the laser ReadApdModeIndex command. |
| ReadLaserMainStateCommand | The delegate to generate the get laser main state command. |
| ReadLaserStatusDelegate |
Gets or sets the read laser status delegate.
(Inherited from BaseLaserController) |
| ReadNumberOfApdModesCommand | The delegate to generate the laser ReadNumberOfApdModes command. |
| Red | (Inherited from BaseSerialLaserController) |
| SerialNumber |
Serial number of the device.
(Inherited from BaseDeviceController) |
| SerialPort |
The serial port to control this laser device.
(Inherited from BaseSerialLaserController) |
| SetApdModeIndexCommand | The delegate to generate the laser pulse width command. |
| SetEeOffCommand | The delegate to disable emission. |
| SetEeOnCommand | The delegate to enable emission. |
| SetLaserConfigDelegate |
Gets or sets the set laser config delegate.
(Inherited from BaseLaserController) |
| SetLaserEmissionOffCommand | The delegate to stop emission. |
| SetLaserEmissionOnCommand | The delegate to start emission. |
| SetOperatingPowerCommand | The delegate to generate the laser power command. |
| SetPowerCalibrationFileDelegate |
Gets or sets the set power calibration file delegate.
(Inherited from BaseLaserController) |
| SetPowerCorrectionFileDelegate |
Gets or sets the set power correction file delegate.
(Inherited from BaseLaserController) |
| SetPowerDelegate |
Gets or sets the set power delegate.
(Inherited from BaseLaserController) |
| SetPowerScaleMultiplierDelegate |
Gets or sets the set power scale multiplier delegate.
(Inherited from BaseLaserController) |
| SetPulseRepetitionCommand | The delegate to generate the laser PRR command. |
| SetupCommand | The delegate to generate the laser setup command. |
| 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) |
| Transparent | (Inherited from BaseSerialLaserController) |
| TurnLaserOffDelegate |
Gets or sets the turn laser off delegate.
(Inherited from BaseLaserController) |
| TurnLaserOnDelegate |
Gets or sets the turn laser on delegate.
(Inherited from BaseLaserController) |
| Validator |
The validator to be used for validating property values.
(Inherited from BaseLaserController) |
| ValidPulseWidths |
The allowed pulse widths for this laser device, given in ns.
(Inherited from BaseSerialLaserController) |
| Yellow | (Inherited from BaseSerialLaserController) |
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) |
Events| Name | Description | |
|---|---|---|
 | ArmedChanged |
Getting called when the arm status changed.
(Inherited from BaseLaserController) |
| CommunicationError |
An event that is triggered when the device is connected but a communication error occured.
(Inherited from BaseSerialLaserController) |
| CommunicationOk |
An event that is triggered when the device is connected and communication ok.
(Inherited from BaseSerialLaserController) |
| 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) |
| HasPointerChanged |
Getting called when the hasPointer changed.
(Inherited from BaseLaserController) |
| Initialized |
An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController) |
| PointerEnabledChanged |
Getting called when the pointer status changed.
(Inherited from BaseLaserController) |
| SerialPortClosed |
An event that is triggered when the serial port is closed.
(Inherited from BaseSerialLaserController) |
| SerialPortOpened |
An event that is triggered when the serial port is opened.
(Inherited from BaseSerialLaserController) |
| StatusChanged |
An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController) |
| StillUnused |
An event that is triggered when the COM port is connected but still not used.
(Inherited from BaseSerialLaserController) |
| Uninitialized |
An event that is triggered when the device is uninitialized.
(Inherited from BaseSerialLaserController) |
| Used |
An event that is triggered when the COM port is used.
(Inherited from BaseSerialLaserController) |
See Also