GoWebScanEncoderSim.h

Go to the documentation of this file.

/**
* @file    GoWebScanEncoderSim.h
* @brief   Declares a GoWebScanEncoderSim object.
*
* @internal
* Copyright (C) 2017-2026 by LMI Technologies Inc.
* Licensed under the MIT License.
* Redistributed files must retain the above copyright notice.
*/

#ifndef GO_WEB_SCAN_ENCODER_SIM_H
#define GO_WEB_SCAN_ENCODER_SIM_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @class   GoWebScanEncoderSim
* @extends kObject
* @ingroup GoWebScanSdk-Control
* @brief   Represents an encoder simulator which simulates forward motion by overriding 
*          encoder values in data messages with simulated values that are based on the 
*          message timestamp. Note that the encoder value is only overridden internally
*          in GoWebScan. Message received directly from the sensor outside of GoWebScan
*          will have the original encoder value.
*          
*          This class can be used to test web or detection mode without requiring
*          an encoder or moving chain (both modes will not work without chain motion).
*/
typedef kObject GoWebScanEncoderSim;

/**
 * Constructs a GoWebScanEncoderSim object.
 * @public              @memberof GoWebScanEncoderSim
 * @param   sim         Receives the constructed GoWebScanEncoderSim object.
 * @param   resolution  Encoder resolution of simulator (mils/tick).
 * @param   speed       Speed of forward motion (mils/second).
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanEncoderSim_Construct(GoWebScanEncoderSim* sim, k64f resolution, k64f speed, kAlloc allocator);

/**
 * Converts a timestamp into a simulated encoder value.
 * 
 * @public          @memberof GoWebScanEncoderSim
 * @param   sim     GoWebScanEncoderSim object.
 * @param   time    Timestamp (microseconds).
 * @return          Simulated encoder value (ticks).
 */
GoWebScanFx(k64s) GoWebScanEncoderSim_Convert(GoWebScanEncoderSim sim, k64s time);

#include <GoWebScanSdk/GoWebScanEncoderSim.x.h>

#endif