Base |
The BaseDistanceSensor type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Calibrate | Calibrates the distance sensor device, if the device can be calibrated. |
| ClearBuffer | Clear all incoming data from the TCP buffer. |
| Connect |
Connects to the device.
(Inherited from BaseDeviceController) |
| Connect(ActionBoolean) | Connect to a device non-blocking and update UI on success. |
 | CreateScanHeadList | Lists all available scan heads with distance sensors other than the current distance sensor. |
| Disconnect |
Disconnects from the device.
(Inherited from BaseDeviceController) |
| Dispose | (Inherited from BasePlugin) |
| Dispose(Boolean) | (Overrides BaseDeviceControllerDispose(Boolean)) |
| DisposeUI |
Disposes the given setting view.
(Inherited from BaseDeviceController) |
| DoDisposeUI | (Inherited from BasePlugin) |
| DoShowUI |
Shows the specific UI embedded in the plug-in instance. The content will be wrapped by a preset view.
(Inherited from BasePlugin) |
| DoShowUICallback |
Invokes the callback that can be used when the DoShowUI method is done.
(Inherited from BasePlugin) |
| GetCheckedHeightDeviationAt | Gets the same measurement value as GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) but might measure multiple times at the same location and adds sanity checks. |
| GetCorrectedRaydimeMeasurementsAt(dvec2, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(dvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a XY position at measure distance. Requires the distance sensor to be calibrated beforehand so that the z height of 0 is the calibrated distance. |
| GetCorrectedRaydimeMeasurementsAt(dvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a single position. |
| GetCorrectedRaydimeMeasurementsAt(IListdvec2, Double, NullableDouble, NullableDouble, NullableCancellationToken) | GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) for a XY position at measure distance. Requires the distance sensor to be calibrated beforehand so that the z height of 0 is the calibrated distance. |
| GetCorrectedRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) | Use the distance sensor to measure the distance in µm and apply angle error to measured value. Measuring at 0,0,0 will obtain the same result as GetRaydimeMeasurementAt(Nullabledvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken). Measuring e.g. at the corner will result in a smaller distance difference than measured when the beam angle is taken into account. |
| GetDeviceStatusRepresentation |
Returns the color and description of device state. Useful for UI purpose.
(Inherited from BaseDeviceController) |
| GetMovableRange | Gets the X, Y and Z min/max values which are in the movable range. |
| GetRaydimeMeasurementAt | Same as GetRaydimeMeasurementsAt(IListdvec3, Double, NullableDouble, NullableDouble, NullableCancellationToken) but measures on a single position only. |
| GetRaydimeMeasurementsAt | Use the distance sensor to measure the distance in µm at a given position. |
| GoToAndTrigger | Moves to a position and sends a hardware trigger or does nothing else in case of software trigger. |
| 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) |
| InternalGetRaydimeMeasurementsAt | |
| InvokeConnected |
Invokes Connected event.
(Inherited from BaseDeviceController) |
| InvokeDeviceUIRequested | Callback method to show the nested scan head settings dialog. |
| InvokeDisconnected |
Invokes Disconnected event.
(Inherited from BaseDeviceController) |
| InvokeInitialized |
Invokes Initialized event.
(Inherited from BaseDeviceController) |
| InvokeStatusChanged |
Invokes StatusChanged event.
(Inherited from BaseDeviceController) |
| InvokeUninitialized | Invokes Uninitialized event. |
| OnDevicesChanged | (Inherited from BaseDeviceController) |
| ReEvaluateMeasurements | Re-evaluates measurements and re-measures invalid locations to make sure the position can either not be measured or the measurement is correct. Sets the average Peak and RawPeak values to the original results. |
| ResolveAngleError(BaseDistanceSensorResult) | ResolveAngleError(dvec3, Double) from a BaseDistanceSensorResult. |
| ResolveAngleError(dvec3, Double) | Takes the measurement angle into account and treats the measured distance error as hypotenuse to get the actual object height difference to the expected value. |
 | SanityCheckMeasurements | Check if measurements at a position are sensible. At least two measurements are needed for the check. It is checked that the measurements are not exactly the same value and that the values are within the sanityCheckThreshold from each other (measurements must be very close but not the same). |
| SendClientHardwareTrigger | Toggles the scan controller's DistanceSensorTriggerOut port with approx. one ms pulse width using the client API. |
| SendSoftwareTrigger | Send a software trigger to the distance sensor device. |
| 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) |
| TriggerChanged | Implements a trigger change and must set the configuration on the remote RAYDIME METER accordingly. |
| TurnLaserOn | Turns the measurement laser on or off. |
| UpdateScanController | Updates the scan controller after a scan head change. |
| UpdateScanHead | |
| WaitForCorrectedRaydimeMeasurement | Get a measurement at current position. In case of a hardware trigger, the data must be made available through an independent trigger. In software trigger mode, a software trigger will be sent first. |
| WaitForRaydimeMeasurement | Device specific implementation of a height deviation distance measurement. The result is expected to be 0. Due to errors in the physical domain, a delta could be measured. It does not return the whole distance but the deviation from the expected distance. To trigger the measurement, either set up the RDM I/O ports on the SPICE card, for plain trigger without movement implement SendClientHardwareTrigger or implement SendSoftwareTrigger for a software trigger on the distance sensor device. |
See Also