GoWebScanCalTarget.h

Go to the documentation of this file.

/**
* @file    GoWebScanCalTarget.h
* @brief   Declares a GoWebScanCalTarget 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_TARGET_H
#define GO_WEB_SCAN_CAL_TARGET_H

#include <GoWebScanSdk/GoWebScanSdkDef.h>
#include <kApi/Data/kXml.h>

/**
* @class   GoWebScanCalTarget
* @extends kObject
* @ingroup GoWebScanSdk-Calibration
* @brief   Represents a container for user-specified dimensions of the calibration target which
*          are used during system calibration processing. The dimensions are stored as an XML file. 
* @see     GoWebScanCal, GoWebScanCalProcessor, GoWebScanCalProcessorNode
*/
typedef kObject GoWebScanCalTarget;

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

/**
 * Constructs and loads a GoWebScanCalTarget object from a saved XML file.
 * 
 * @public              @memberof GoWebScanCalTarget
 * @param   target      Receives the constructed GoWebScanCalTarget object.
 * @param   fileName    Filename (including path). Expected to be an XML file.
 * @param   alloc       Memory allocator (or kNULL for default).
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalTarget_Load(GoWebScanCalTarget* target, const kChar* fileName, kAlloc alloc);

/**
 * Writes and stores a GoWebScanCalTarget object to a XML file.
 * 
 * @public              @memberof GoWebScanCalTarget
 * @param   target      GoWebScanCalTarget object.
 * @param   fileName    Filename (including path). Expected to be an XML file. If the file does
 *                      not exist, it will be created.
 * @return              Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalTarget_Store(GoWebScanCalTarget target, const kChar* fileName);

/**
 * Sets the width of the calibration target in mils. If not set, a default width of 4000 mils
 * is set.
 * 
 * @public          @memberof GoWebScanCalTarget
 * @param   target  GoWebScanCalTarget object.
 * @param   width   Target width (mils).
 * @return          Operation status.
 */
GoWebScanFx(kStatus) GoWebScanCalTarget_SetWidth(GoWebScanCalTarget target, kSize width); 

/**
* Gets the width of the calibration target in mils.
* 
* @public          @memberof GoWebScanCalTarget
* @param   target  GoWebScanCalTarget object.
* @return          Target width (mils).
*/
GoWebScanFx(kSize) GoWebScanCalTarget_Width(GoWebScanCalTarget target); 

/**
* Sets the height of the calibration target in mils. If not set, a default width of 2000 mils
* is set.
* 
* @public          @memberof GoWebScanCalTarget
* @param   target  GoWebScanCalTarget object.
* @param   height  Target height (mils).
* @return          Operation status.
*/
GoWebScanFx(kStatus) GoWebScanCalTarget_SetHeight(GoWebScanCalTarget target, kSize height); 

/**
* Gets the height of the calibration target in mils.
* 
* @public          @memberof GoWebScanCalTarget
* @param   target  GoWebScanCalTarget object.
* @return          Target height (mils).
*/
GoWebScanFx(kSize) GoWebScanCalTarget_Height(GoWebScanCalTarget target);

#include <GoWebScanSdk/GoWebScanCalTarget.x.h>

#endif