Class IDimensionChannelLaserScanInfo

Class IDimensionChannelLaserScanInfo#

Class Documentation#

class IDimensionChannelLaserScanInfo#

Information about the laser scan.

Public Functions

virtual bool TryGetPixelTime(double *pixelTime) = 0#

Try to get the pixel time.

Parameters:

pixelTime – [inout] If non-null and successful, the pixel time is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLineTime(double *lineTime) = 0#

Try to get the line time.

Parameters:

lineTime – [inout] If non-null and successful, the line time is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetFrameTime(double *frameTime) = 0#

Try to get the frame time.

Parameters:

frameTime – [inout] If non-null and successful, the frame time is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetAveraging(int *averaging) = 0#

Try to get the averaging (how many times the scanning was repeated).

Parameters:

averaging – [inout] If non-null and successful, the averaging is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetScanningMode(DimensionChannelLaserScanScanningMode *mode) = 0#

Try to get the scanning mode.

Parameters:

mode – [inout] If non-null and successful, the mode is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetSampleRotation(double *sampleRotation) = 0#

Try to get the sample rotation.

Parameters:

sampleRotation – [inout] If non-null and successful, the sample rotation is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetSampleOffsetX(double *sampleOffsetX) = 0#

Try to get the sample offset in x-direction.

Parameters:

sampleOffsetX – [inout] If non-null and successful, the sample offset in x direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetSampleOffsetY(double *sampleOffsetY) = 0#

Try to get the sample offset in y-direction.

Parameters:

sampleOffsetY – [inout] If non-null and successful, the sample offset in y direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetScanDirection(DimensionChannelLaserScanScanDirection *scanDirection) = 0#

Try to get the scan direction.

Parameters:

scanDirection – [inout] If non-null and successful, the scan direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetZoomX(double *zoomX) = 0#

Try to get the zoom in x direction.

Parameters:

zoomX – [inout] If non-null, the zoom in x direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetZoomY(double *zoomY) = 0#

Try to get the zoom in y direction.

Parameters:

zoomY – [inout] If non-null, the zoom in y direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetZoomZ(double *zoomZ) = 0#

Try to get the zoom in z direction.

Parameters:

zoomZ – [inout] If non-null, the zoom in z direction is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetCropOffset(double *cropOffset) = 0#

Attempts to get the crop offset

Parameters:

cropOffset – [inout] If non-null and successful, the crop offset is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLaserAttenuatorMeas(double *laserAttenuatorMeas) = 0#

Try to get the attenuation of the laser.

Parameters:

laserAttenuatorMeas – [inout] If non-null and successful, the attenuation of the laser is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLaserBlanking(double *laserBlanking) = 0#

Try to get the laser blanking (time the laser is not active while re-positioning for the next scan line).

Parameters:

laserBlanking – [inout] If non-null and successful, the laser blanking time is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLaserAttenuatorBleach(double *laserAttenuatorBleach) = 0#

Try to get the attenuation of the laser for bleaching.

Parameters:

laserAttenuatorBleach – [inout] If non-null, the attenuator of the laser for bleaching is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLineStep(std::uint32_t *lineStep) = 0#

Try to get the line step.

Parameters:

lineStep – [inout] If non-null and successful, the line step is place here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetScanSpeed(int *scanSpeed) = 0#

Try to get the scan speed.

Parameters:

scanSpeed – [inout] If non-null and successful, the scan speed is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetAveragingMethod(DimensionChannelLaserScanAveragingMethod *averagingMethod) = 0#

Try to get the averaging method.

Parameters:

averagingMethod – [inout] If non-null and successful, the averaging method is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetAveragingMode(DimensionChannelLaserScanAveragingMode *averagingMode) = 0#

Try to get the averaging mode.

Parameters:

averagingMode – [inout] If non-null and successful, the averaging mode is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetLaserAttenuatorState(DimensionChannelLaserScanLaserAttenuatorState *attenuatorState) = 0#

Try to get the laser attenuator state

Parameters:

attenuatorState – [inout] If non-null and successful, the laser attenuator state is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual ~IDimensionChannelLaserScanInfo() = default#
Contents