GoWebScanCalInputItem.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalInputItem.h
* @brief   Declares a GoWebScanCalInputItem 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_CAL_INPUT_ITEM_H
#define GO_WEB_SCAN_CAL_INPUT_ITEM_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>

/**
* @struct  GoWebScanCalInputStamp
* @extends kValue
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a stamp containing properties of the input message.
*/
typedef struct GoWebScanCalInputStamp
{
    GoWebScanDataSource source;         ///< Data source of message.
    GoWebScanSystemPlane plane;         ///< System plane of message.
    k32s column;                        ///< Node column index.
    k32s deviceId;                      ///< Sensor ID. Profile ID for vision systems.
    k32s bankId;                        ///< Bank index.
    k64s position;                      ///< Y-axis position (mils).
    k64s timeStamp;                     ///< Timestamp of message (internal units approximating microseconds). See GoStamp.
    k64s frame;                         ///< Frame index.
    k64s encoder;                       ///< Encoder value (ticks).
    k64u status;
    /**<
    * Bit mask containing frame information:
    *
    * - Bit 0: Represents sensor digital input state.
    * - Bit 4: Represents Master digital input state.
    * - Bits 8 and 9: Represents inter-frame digital pulse trigger
                    (Master digital input if a Master is connected, otherwise
                    sensor digital input. Value is cleared after each frame
                    and clamped at 3 if more than 3 pulses are received).
    */
    k32u xResolution;                   ///< x-resolution (nm)
    k32u zResolution;                   ///< z-resolution (nm)
    k32s xOffset;                       ///< x-offset (um)
    k32s zOffset;                       ///< z-offset (um)
} GoWebScanCalInputStamp; 

/**
* @class   GoWebScanCalInputItem
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a raw sensor message used for calibration collection
*          and processing.         
*/
typedef kObject GoWebScanCalInputItem;

/**
 * Constructs a GoWebScanCalInputItem object.
 * 
 * @public              @memberof GoWebScanCalInputItem
 * @param   item        Receives the constructed GoWebScanCalInputItem object.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputItem_Construct(GoWebScanCalInputItem* item, kAlloc allocator);

/**
 * Clones a GoWebScanCalInputItem object.
 * 
 * @public          @memberof GoWebScanCalInputItem
 * @param   item    GoWebScanCalInputItem object.
 * @param   clone   Receives the constructed cloned GoWebScanCalInputItem object.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputItem_Clone(GoWebScanCalInputItem item, GoWebScanCalInputItem* clone);

/**
 * Sets the stamp for an input item.
 * 
 * @public          @memberof GoWebScanCalInputItem
 * @param   item    GoWebScanCalInputItem object.
 * @param   stamp   Stamp of input item.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputItem_SetStamp(GoWebScanCalInputItem item, GoWebScanCalInputStamp* stamp);

/**
* Gets a pointer to the stamp for an input item.
* 
* @public          @memberof GoWebScanCalInputItem
* @param   item    GoWebScanCalInputItem object.
* @return          Pointer to stamp of input item.
*/
GoWebScanFx(GoWebScanCalInputStamp*) GoWebScanCalInputItem_GetStamp(GoWebScanCalInputItem item);

/**
 * Adds data to an input item. The class takes ownership of the data object.
 * 
 * @public          @memberof GoWebScanCalInputItem
 * @param   item    GoWebScanCalInputItem object.
 * @param   data    Message data.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputItem_SetData(GoWebScanCalInputItem item, kObject data);

/**
* Gets data of an input item. The class continues to own the data object.
* 
* @public          @memberof GoWebScanCalInputItem
* @param   item    GoWebScanCalInputItem object. 
* @return          Message data.
*/
GoWebScanFx(kObject) GoWebScanCalInputItem_Data(GoWebScanCalInputItem item);

#include <GoWebScanSdk/GoWebScanCalInputItem.x.h>

#endif