Click or drag to resize

BaseSerialLaserControllerPlugin Methods

The BaseSerialLaserControllerPlugin type exposes the following members.

Methods
 NameDescription
Protected methodAppendMessage 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)
Public methodArmLaser(Boolean) Arm or disarm the laser.
(Inherited from BaseLaserController)
Public methodArmLaser(Boolean, Int32, IOPortCondition, NullableGuid) Arm or disarm the laser.
(Inherited from BaseLaserController)
Public methodChangeBeamProfileT Selects a beam profile.
(Inherited from BaseLaserController)
Public methodCheckControllerFeature Checks whether the automation feature is supported.
(Inherited from BaseLaserController)
Public methodCheckOnLaserReadySerial Checks if the laser is ready by retrieving its state by the RS-232 connection.
(Inherited from BaseSerialLaserController)
Public methodClearDelegates Removes all laser delegates.
(Inherited from BaseLaserController)
Public methodConnect Connects to the device.
(Inherited from BaseLaserController)
Protected methodConnectSerialPort Connects with the serial port.
(Inherited from BaseSerialLaserController)
Protected methodCreateDefaultProfile Creates the default laser profile for this device.
(Inherited from BaseLaserController)
Public methodDisconnect Disconnects from the device.
(Inherited from BaseLaserController)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BaseSerialLaserController)
Public methodDisposeUI Disposes the given setting view.
(Inherited from BaseDeviceController)
Protected methodDoConnect Performs the connection process.
(Inherited from BaseSerialLaserController)
Protected methodDoDisconnect Stops the message handler thread and closes the serial port.
(Inherited from BaseSerialLaserController)
Protected methodDoDisposeUI
(Inherited from BasePlugin)
Protected methodDoDoDoShowUI 
Protected methodDoDoDoShowUICallback 
Protected methodDoDoShowUI
(Overrides BaseLaserControllerDoDoShowUI(String))
Protected methodDoDoShowUICallback
(Overrides BaseLaserControllerDoDoShowUICallback(PluginSettingsView))
Protected methodDoShowUI
(Inherited from BaseLaserController)
Protected methodDoShowUICallback
(Inherited from BaseLaserController)
Public methodEnablePointer(Boolean) Enable or disable the pointer.
(Inherited from BaseLaserController)
Public methodEnablePointer(Boolean, Int32) Enable or disable the pointer.
(Inherited from BaseLaserController)
Public methodEnablePointer(Boolean, IOPortCondition, NullableGuid) Enable or disable the pointer.
(Inherited from BaseLaserController)
Public methodEnablePointer(Boolean, Int32, IOPortCondition, NullableGuid) Enable or disable the pointer.
(Inherited from BaseLaserController)
Public methodGetDeviceStatusRepresentation
(Inherited from BaseSerialLaserController)
Public methodGetLaserArmed Returns true if the laser is armed.
(Inherited from BaseLaserController)
Public methodGetPointerEnabled Returns true if the laser is enabled.
(Inherited from BaseLaserController)
Public methodGetPowerScaleMultiplier Gets the power scale multiplier of the laser.
(Inherited from BaseLaserController)
Protected methodGetUsedScanController Retrieves the scan controller associated with this laser.
(Inherited from BaseSerialLaserController)
Public methodHandleExternalDeviceRequestAsync Handles a chained request for a given list of features.
(Inherited from BaseDeviceController)
Protected methodHandleSerialMessagesThread(Thread) The concrete message handler is to be implemented by the derived class.
(Inherited from BaseSerialLaserController)
Public methodInitialize Plug-in specific initialization can be done here if necessary.
(Inherited from BasePlugin)
Public methodInvokeArmedChanged
(Inherited from BaseLaserController)
Protected methodInvokeCommunicationError Invokes communication error event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeCommunicationOk Invokes communication OK event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeConnected Invokes Connected event.
(Inherited from BaseDeviceController)
Protected methodInvokeDisconnected Invokes Disconnected event.
(Inherited from BaseDeviceController)
Public methodInvokeHasPointerChanged Invoke HasPointerChanged.
(Inherited from BaseLaserController)
Protected methodInvokeInitialized Invokes Initialized event.
(Inherited from BaseDeviceController)
Public methodInvokePointerEnabledChanged
(Inherited from BaseLaserController)
Protected methodInvokeSerialPortClosed Invokes the serial port closed event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeSerialPortOpened Invokes the serial port opened event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Protected methodInvokeStillUnused Invokes still unused event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeUninitialized Invokes the Uninitialized event.
(Inherited from BaseSerialLaserController)
Protected methodInvokeUsed Invokes used event.
(Inherited from BaseSerialLaserController)
Protected methodIsAnalog Returns whether the laser’s power is controlled via an analog voltage.
(Inherited from BaseLaserController)
Public methodNormalizePowerValue Convert power value from a device specific value to a percentage.
(Inherited from BaseLaserController)
Protected methodOnDevicesChanged
(Inherited from BaseDeviceController)
Protected methodOnSerialPortConnected In this method class dependent actions can be done when the serial port could be opened, e. g. getting the laser state.
(Inherited from BaseSerialLaserController)
Protected methodOnSerialPortDisconnected In this method class dependent actions can be done when the serial port is disconnected.
(Inherited from BaseSerialLaserController)
Public methodReadLaserStatus Reads the status of the laser. Updates IsInAlarm.
(Inherited from BaseLaserController)
Public methodSetLaserConfig Send the laser configuration to the card
(Inherited from BaseLaserController)
Public methodSetOpticalPulseWidthT Sets the optical pulse width.
(Inherited from BaseLaserController)
Public methodSetPower Sets the laser power.
(Inherited from BaseLaserController)
Public methodSetPowerCalibrationFile Sets the power calibration file (*.pcl).
(Inherited from BaseLaserController)
Public methodSetPowerCorrectionFile Sets the power correction file (*.pc3).
(Inherited from BaseLaserController)
Public methodSetPowerScaleMultiplier Sets the PowerScaleMultiplier of the laser.
(Inherited from BaseLaserController)
Public methodSetPulseRepetition Sets the PRR (Pulse Repetition Rate).
(Inherited from BaseLaserController)
Public methodSetPulseWidth Sets the pulse width.
(Inherited from BaseLaserController)
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 methodToString
(Inherited from BasePlugin)
Public methodTurnLaserOff Deactivate the laser
(Inherited from BaseLaserController)
Public methodTurnLaserOn Activates the laser
(Inherited from BaseLaserController)
Protected methodUpdateLaserStateGui Updates the traffic lights in the settings dialog, the menu bar and the Configure devices dialog.
(Inherited from BaseSerialLaserController)
Protected methodUsePowerCorrectionValue TODO: Use the power correction file.
(Inherited from BaseLaserController)
Protected methodValidateDouble Validates whether a value is within a range.
(Inherited from BaseLaserController)
Public methodValidateDutyCycle Validates a given laser duty cycle.
(Inherited from BaseLaserController)
Public methodValidateFrequency Validates a given laser PRR within its allowable range.
(Inherited from BaseLaserController)
Public methodValidatePower Validates a given laser power within its allowable range.
(Inherited from BaseLaserController)
Public methodValidateProperties Validate property values.
(Inherited from BaseSerialLaserController)
Protected methodValidateRange Validates whether a given range falls within a boundary.
(Inherited from BaseLaserController)
Top
See Also