GoWebScanCalInputNode.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalInputNode.h
* @brief   Declares a GoWebScanCalInputNode 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_NODE_H
#define GO_WEB_SCAN_CAL_INPUT_NODE_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <GoWebScanSdk/GoWebScanCalInputItem.h>

/**
* @class   GoWebScanCalInputNode
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a container for raw sensor messages of a particular data type
*          from a single node for calibration processing. An X section of the calibration 
*          bar corresponding to this node is contained in the messages.       
*/
typedef kObject GoWebScanCalInputNode;

// Forward declaration
typedef kObject GoWebScanCalInputItem; 

/**
 * Constructs a GoWebScanCalInputNode object.
 * 
 * @public              @memberof GoWebScanCalInputNode
 * @param   node        Receives the constructed GoWebScanCalInputNode object.
 * @param   source      Data source
 * @param   plane       System plane.
 * @param   column      Node column index.
 * @param   allocator   Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputNode_Construct(GoWebScanCalInputNode* node, GoWebScanDataSource source, GoWebScanSystemPlane plane, k32s column, kAlloc allocator);

/**
 * Adds sensor message data, contained in a GoWebScanCalInputItem object, to the node input.
 * 
 * @public          @memberof GoWebScanCalInputNode
 * @param   node    GoWebScanCalInputNode object.
 * @param   item    Input item.
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputNode_AddItem(GoWebScanCalInputNode node, GoWebScanCalInputItem* item);

/**
 * Gets the count of item messages in the node input.
 * 
 * @public          @memberof GoWebScanCalInputNode
 * @param   node    GoWebScanCalInputNode object.
 * @return          Number of item messages.
 */
GoWebScanFx(kSize) GoWebScanCalInputNode_ItemCount(GoWebScanCalInputNode node);

/**
 * Gets the item message at a specific index in the node input.
 * 
 * @public          @memberof GoWebScanCalInputNode
 * @param   node    GoWebScanCalInputNode object.
 * @param   index   Item index.
 * @return          Item count.
 */
GoWebScanFx(GoWebScanCalInputItem) GoWebScanCalInputNode_ItemAt(GoWebScanCalInputNode node, kSize index);

/**
* Gets the system plane of the node input.
* 
* @public          @memberof GoWebScanCalInputNode
* @param   node    GoWebScanCalInputNode object.
* @return          System plane.
*/
GoWebScanFx(GoWebScanSystemPlane) GoWebScanCalInputNode_Plane(GoWebScanCalInputNode node);

/**
* Gets the node column index of the node input.
* 
* @public          @memberof GoWebScanCalInputNode
* @param   node    GoWebScanCalInputNode object.
* @return          Node column index.
*/
GoWebScanFx(k32s) GoWebScanCalInputNode_Column(GoWebScanCalInputNode node);

/**
 * Sets the number of dropped frames in the node input.
 * 
 * @public              @memberof GoWebScanCalInputNode
 * @param   node        GoWebScanCalInputNode object.
 * @param   dropCount   Number of dropped frames.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalInputNode_SetFrameDropCount(GoWebScanCalInputNode node, k64s dropCount);

/**
* Gets the number of dropped frames in the node input.
* 
* @public          @memberof GoWebScanCalInputNode
* @param   node    GoWebScanCalInputNode object.
* @return          Number of dropped frames.
*/
GoWebScanFx(k64s) GoWebScanCalInputNode_FrameDropCount(GoWebScanCalInputNode node);

/**
* Sets the number of times the node has been disabled due to dropped or latent frames.
* 
* @public                   @memberof GoWebScanCalInputNode
* @param   node             GoWebScanCalInputNode object.
* @param   disableCount     Number of disables.
* @return                   Operation status.
*/
GoWebScanFx(kStatus) GoWebScanCalInputNode_SetDisableCount(GoWebScanCalInputNode node, k64s disableCount);

/**
* Gets the number of times the node has been disabled due to dropped or latent frames.
* 
* @public              @memberof GoWebScanCalInputNode
* @param   node        GoWebScanCalInputNode object.
* @return              Number of disables.
*/
GoWebScanFx(k64s) GoWebScanCalInputNode_DisableCount(GoWebScanCalInputNode node);

#include <GoWebScanSdk/GoWebScanCalInputNode.x.h>

#endif