BaseLaserController Class

Represents the base class of all plugins of type laser controller.

Inheritance Hierarchy

SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.DeviceBaseDeviceController
      RAYLASE.Marker.Device.LaserControllerBaseLaserController
        RAYLASE.Marker.Device.LaserControllerBaseSerialLaserController
        RAYLASE.MarkerPlugin.Devices.LaserBaseLaserControllerPlugin
        RAYLASE.MarkerPlugin.Devices.Laser.SPISPIExtendedLaserDevice

Namespace: RAYLASE.Marker.Device.LaserController
Assembly: RAYLASE.Marker.Device (in RAYLASE.Marker.Device.dll) Version: 2.19.0

Syntax

Copy

public abstract class BaseLaserController : BaseDeviceController

The BaseLaserController type exposes the following members.

Constructors

	Name	Description
	BaseLaserController	ctor

Top

Properties

	Name	Description
	ActivatedChainableFeatures	Gets the activated chainable features. (Inherited from BaseDeviceController)
	ArmLaserDelegate	Gets or sets the arm laser delegate.
	AutoConfigureIO	Automatically configures necessary IO pins depending on laser (eg. laser alarm, pilot and arm pins). Only supported if Features contains AutoConfigureIO.
	CheckControllerFeatureDelegate	Gets or sets the delegate for checking whether the automation feature is supported.
	ConfigurationManager	(Inherited from BasePlugin)
	Connector	The communication to the controlling device.
	Delta	The delta to be used for comparing doubles.
	EnableChainableFeature	Gets or sets the flag to enable chainable features. (Inherited from BaseDeviceController)
	EnablePointerDelegate	Gets or sets the enable pointer delegate.
	Features	Returns set of features, supported by the laser controller.
	GetPowerScaleMultiplierDelegate	Gets or sets the get power scale multiplier delegate.
	HasConnectedStatus	Is true if the device supports the IsConnected status. (Inherited from BaseDeviceController)
	IsAutoConnect	(Inherited from BaseDeviceController)
	IsConnected	Is true if the device is connected. (Inherited from BaseDeviceController)
	IsInAlarm	The flag to indicate that the laser device is in alarmed state.
	IsInitialized	Is true if the device is initialized. (Inherited from BaseDeviceController)
	IsLaserArmedDelegate	Gets or sets the is laser armed delegate.
	IsPointerEnabledDelegate	Gets or sets the is pointer enabled delegate.
	LaserProfile	Various laser settings of the device.
	LogDirectory	The directory of the log file. (Inherited from BasePlugin)
	Logger	The common logger. (Inherited from BasePlugin)
	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)
	ReadLaserStatusDelegate	Gets or sets the read laser status delegate.
	SerialNumber	Serial number of the device. (Inherited from BaseDeviceController)
	SetLaserConfigDelegate	Gets or sets the set laser config delegate.
	SetPowerCalibrationFileDelegate	Gets or sets the set power calibration file delegate.
	SetPowerCorrectionFileDelegate	Gets or sets the set power correction file delegate.
	SetPowerDelegate	Gets or sets the set power delegate.
	SetPowerScaleMultiplierDelegate	Gets or sets the set power scale multiplier delegate.
	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)
	TurnLaserOffDelegate	Gets or sets the turn laser off delegate.
	TurnLaserOnDelegate	Gets or sets the turn laser on delegate.
	Validator	The validator to be used for validating property values.

Top

Methods

	Name	Description
	ArmLaser(Boolean)	Arm or disarm the laser.
	ArmLaser(Boolean, Int32, IOPortCondition, NullableGuid)	Arm or disarm the laser.
	ChangeBeamProfileT	Selects a beam profile.
	CheckControllerFeature	Checks whether the automation feature is supported.
	ClearDelegates	Removes all laser delegates.
	Connect	Connects to the device. (Overrides BaseDeviceControllerConnect)
	CreateDefaultProfile	Creates the default laser profile for this device.
	Disconnect	Disconnects from the device. (Overrides BaseDeviceControllerDisconnect)
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BaseDeviceController)
	DisposeUI	Disposes the given setting view. (Inherited from BaseDeviceController)
	DoConnect	Performs the connection process.
	DoDisconnect	Performs the disconnection process.
	DoDisposeUI	(Inherited from BasePlugin)
	DoDoShowUI
	DoDoShowUICallback
	DoShowUI	(Overrides BasePluginDoShowUI(String))
	DoShowUICallback	(Overrides BasePluginDoShowUICallback(PluginSettingsView))
	EnablePointer(Boolean)	Enable or disable the pointer.
	EnablePointer(Boolean, Int32)	Enable or disable the pointer.
	EnablePointer(Boolean, IOPortCondition, NullableGuid)	Enable or disable the pointer.
	EnablePointer(Boolean, Int32, IOPortCondition, NullableGuid)	Enable or disable the pointer.
	GetDeviceStatusRepresentation	(Overrides BaseDeviceControllerGetDeviceStatusRepresentation)
	GetLaserArmed	Returns true if the laser is armed.
	GetPointerEnabled	Returns true if the laser is enabled.
	GetPowerScaleMultiplier	Gets the power scale multiplier of the laser.
	HandleExternalDeviceRequestAsync	Handles a chained request for a given list of features. (Inherited from BaseDeviceController)
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	InvokeArmedChanged
	InvokeConnected	Invokes Connected event. (Inherited from BaseDeviceController)
	InvokeDisconnected	Invokes Disconnected event. (Inherited from BaseDeviceController)
	InvokeHasPointerChanged	Invoke HasPointerChanged.
	InvokeInitialized	Invokes Initialized event. (Inherited from BaseDeviceController)
	InvokePointerEnabledChanged
	InvokeStatusChanged	Invokes StatusChanged event. (Inherited from BaseDeviceController)
	IsAnalog	Returns whether the laser’s power is controlled via an analog voltage.
	NormalizePowerValue	Convert power value from a device specific value to a percentage.
	OnDevicesChanged	(Inherited from BaseDeviceController)
	ReadLaserStatus	Reads the status of the laser. Updates IsInAlarm.
	SetLaserConfig	Send the laser configuration to the card
	SetOpticalPulseWidthT	Sets the optical pulse width.
	SetPower	Sets the laser power.
	SetPowerCalibrationFile	Sets the power calibration file (*.pcl).
	SetPowerCorrectionFile	Sets the power correction file (*.pc3).
	SetPowerScaleMultiplier	Sets the PowerScaleMultiplier of the laser.
	SetPulseRepetition	Sets the PRR (Pulse Repetition Rate).
	SetPulseWidth	Sets the pulse width.
	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
	TurnLaserOn	Activates the laser
	UsePowerCorrectionValue	TODO: Use the power correction file.
	ValidateDouble	Validates whether a value is within a range.
	ValidateDutyCycle	Validates a given laser duty cycle.
	ValidateFrequency	Validates a given laser PRR within its allowable range.
	ValidatePower	Validates a given laser power within its allowable range.
	ValidateProperties	Validate property values.
	ValidateRange	Validates whether a given range falls within a boundary.

Top

Events

	Name	Description
	ArmedChanged	Getting called when the arm status changed.
	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.
	Initialized	An event that is triggered when the device is initialized. (Inherited from BaseDeviceController)
	PointerEnabledChanged	Getting called when the pointer status changed.
	StatusChanged	An event that is triggered when the status of the device is changed. (Inherited from BaseDeviceController)

Top

Reference

RAYLASE.Marker.Device.LaserController Namespace