Click or drag to resize

NLightAfxLaserDevice Class

Provides the functionalities for an nLight laser device.
Inheritance Hierarchy

Namespace: RAYLASE.MarkerPlugin.Devices.Laser.NLight
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0
Syntax
C#
Copy
public class NLightAfxLaserDevice : BaseLaserControllerPlugin

The NLightAfxLaserDevice type exposes the following members.

Constructors
 NameDescription
Public methodNLightAfxLaserDeviceInitializes a new instance of the NLightAfxLaserDevice class
Top
Properties
 NameDescription
Public propertyActivatedChainableFeatures Gets the activated chainable features.
(Inherited from BaseDeviceController)
Public propertyArmLaserDelegate Gets or sets the arm laser delegate.
(Inherited from BaseLaserController)
Public propertyAutoConfigureIO Automatically configures necessary IO pins depending on laser (eg. laser alarm, pilot and arm pins). Only supported if Features contains AutoConfigureIO.
(Inherited from BaseLaserController)
Public propertyCheckControllerFeatureDelegate Gets or sets the delegate for checking whether the automation feature is supported.
(Inherited from BaseLaserController)
Protected propertyConfigurationManager
(Inherited from BasePlugin)
Public propertyConnector The communication to the controlling device.
(Inherited from BaseLaserController)
Protected propertyDelta The delta to be used for comparing doubles.
(Inherited from BaseLaserController)
Public propertyDeviceState 
Public propertyDisarmToOffState 
Public propertyEnableChainableFeature Gets or sets the flag to enable chainable features.
(Inherited from BaseDeviceController)
Public propertyEnablePointerDelegate Gets or sets the enable pointer delegate.
(Inherited from BaseLaserController)
Public propertyFeatures Returns set of features, supported by the laser controller.
(Inherited from BaseLaserController)
Public propertyGetPowerScaleMultiplierDelegate Gets or sets the get power scale multiplier delegate.
(Inherited from BaseLaserController)
Public propertyHasConnectedStatus
(Overrides BaseDeviceControllerHasConnectedStatus)
Public propertyIsAutoConnect
(Inherited from BaseDeviceController)
Public propertyIsConnected Is true if the device is connected.
(Inherited from BaseDeviceController)
Public propertyIsInAlarm The flag to indicate that the laser device is in alarmed state.
(Inherited from BaseLaserController)
Public propertyIsInitialized
(Overrides BaseDeviceControllerIsInitialized)
Public propertyIsLaserArmedDelegate Gets or sets the is laser armed delegate.
(Inherited from BaseLaserController)
Public propertyIsPointerEnabledDelegate Gets or sets the is pointer enabled delegate.
(Inherited from BaseLaserController)
Public propertyLaserProfile Various laser settings of the device.
(Inherited from BaseLaserController)
Protected propertyLogDirectory The directory of the log file.
(Inherited from BasePlugin)
Public propertyLogger The common logger.
(Inherited from BasePlugin)
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 propertyReadLaserStatusDelegate Gets or sets the read laser status delegate.
(Inherited from BaseLaserController)
Public propertySerialNumber Serial number of the device.
(Inherited from BaseDeviceController)
Public propertySetLaserConfigDelegate Gets or sets the set laser config delegate.
(Inherited from BaseLaserController)
Public propertySetPowerCalibrationFileDelegate Gets or sets the set power calibration file delegate.
(Inherited from BaseLaserController)
Public propertySetPowerCorrectionFileDelegate Gets or sets the set power correction file delegate.
(Inherited from BaseLaserController)
Public propertySetPowerDelegate Gets or sets the set power delegate.
(Inherited from BaseLaserController)
Public propertySetPowerScaleMultiplierDelegate Gets or sets the set power scale multiplier delegate.
(Inherited from BaseLaserController)
Public propertyShouldInitializeOnStart 
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 propertyTurnLaserOffDelegate Gets or sets the turn laser off delegate.
(Inherited from BaseLaserController)
Public propertyTurnLaserOnDelegate Gets or sets the turn laser on delegate.
(Inherited from BaseLaserController)
Protected propertyValidator The validator to be used for validating property values.
(Inherited from BaseLaserController)
Top
Methods
 NameDescription
Public methodArmLaser(Boolean)
(Overrides BaseLaserControllerArmLaser(Boolean))
Public methodArmLaser(Boolean, Int32, IOPortCondition, NullableGuid) Arm or disarm the laser.
(Inherited from BaseLaserController)
Public methodChangeBeamProfileT
(Overrides BaseLaserControllerChangeBeamProfileT(UInt16, Boolean))
Public methodCheckControllerFeature Checks whether the automation feature is supported.
(Inherited from BaseLaserController)
Public methodClearDelegates Removes all laser delegates.
(Inherited from BaseLaserController)
Public methodConnect Connects to the device.
(Inherited from BaseLaserController)
Protected methodCreateDefaultProfile
(Overrides BaseLaserControllerCreateDefaultProfile)
Public methodDisconnect Disconnects from the device.
(Inherited from BaseLaserController)
Public methodDispose
(Inherited from BasePlugin)
Protected methodDispose(Boolean)
(Inherited from BaseDeviceController)
Public methodDisposeUI Disposes the given setting view.
(Inherited from BaseDeviceController)
Protected methodDoConnect
(Overrides BaseLaserControllerDoConnect)
Protected methodDoDisconnect
(Overrides BaseLaserControllerDoDisconnect)
Protected methodDoDisposeUI
(Overrides BasePluginDoDisposeUI(PluginSettingsView))
Protected methodDoDoDoShowUI
(Overrides BaseLaserControllerPluginDoDoDoShowUI(String))
Protected methodDoDoDoShowUICallback
(Overrides BaseLaserControllerPluginDoDoDoShowUICallback(PluginSettingsView))
Protected methodDoDoShowUI
(Inherited from BaseLaserControllerPlugin)
Protected methodDoDoShowUICallback
(Inherited from BaseLaserControllerPlugin)
Protected methodDoShowUI
(Inherited from BaseLaserController)
Protected methodDoShowUICallback
(Inherited from BaseLaserController)
Public methodEnablePointer(Boolean)
(Overrides BaseLaserControllerEnablePointer(Boolean))
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
(Overrides BaseLaserControllerGetDeviceStatusRepresentation)
Public methodGetLaserArmed
(Overrides BaseLaserControllerGetLaserArmed)
Public methodGetPointerEnabled
(Overrides BaseLaserControllerGetPointerEnabled)
Public methodGetPowerScaleMultiplier Gets the power scale multiplier of the laser.
(Inherited from BaseLaserController)
Public methodHandleExternalDeviceRequestAsync
(Overrides BaseDeviceControllerHandleExternalDeviceRequestAsync(IListTupleChainableFeatureType, ExpandoObject, CancellationToken))
Public methodInitialize
(Overrides BasePluginInitialize)
Public methodInvokeArmedChanged
(Inherited from BaseLaserController)
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 methodInvokeStatusChanged Invokes StatusChanged event.
(Inherited from BaseDeviceController)
Protected methodIsAnalog Returns whether the laser’s power is controlled via an analog voltage.
(Inherited from BaseLaserController)
Public methodNormalizePowerValue
(Overrides BaseLaserControllerNormalizePowerValue(Double))
Protected methodOnDevicesChanged
(Inherited from BaseDeviceController)
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
(Overrides BaseLaserControllerSetPulseRepetition(Double))
Public methodSetPulseWidth
(Overrides BaseLaserControllerSetPulseWidth(String))
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)
Public methodUpdateLaserState 
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
(Overrides BaseLaserControllerValidateProperties)
Protected methodValidateRange Validates whether a given range falls within a boundary.
(Inherited from BaseLaserController)
Top
Events
 NameDescription
Public eventArmedChanged Getting called when the arm status changed.
(Inherited from BaseLaserController)
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 eventHasPointerChanged Getting called when the hasPointer changed.
(Inherited from BaseLaserController)
Public eventInitialized An event that is triggered when the device is initialized.
(Inherited from BaseDeviceController)
Public eventPointerEnabledChanged Getting called when the pointer status changed.
(Inherited from BaseLaserController)
Public eventStatusChanged An event that is triggered when the status of the device is changed.
(Inherited from BaseDeviceController)
Top
See Also