GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalTarget.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalTarget.h
3 * @brief Declares a GoWebScanCalTarget object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 
11 #ifndef GO_WEB_SCAN_CAL_TARGET_H
12 #define GO_WEB_SCAN_CAL_TARGET_H
13 
15 #include <kApi/Data/kXml.h>
16 
17 kBeginHeader()
18 
19 /**
20 * @class GoWebScanCalTarget
21 * @extends kObject
22 * @ingroup GoWebScanSdk-Calibration
23 * @brief Represents a container for user-specified dimensions of the calibration target which
24 * are used during system calibration processing. The dimensions are stored as an XML file.
25 * @see GoWebScanCal, GoWebScanCalProcessor, GoWebScanCalProcessorNode
26 */
28 
29 /**
30  * Constructs a GoWebScanCalTarget object.
31  *
32  * @public @memberof GoWebScanCalTarget
33  * @param target Receives the constructed GoWebScanCalTarget object.
34  * @param allocator Memory allocator (or kNULL for default).
35  * @return Operation status.
36  */
37 GoWebScanFx(kStatus) GoWebScanCalTarget_Construct(GoWebScanCalTarget* target, kAlloc allocator);
38 
39 /**
40  * Constructs and loads a GoWebScanCalTarget object from a saved XML file.
41  *
42  * @public @memberof GoWebScanCalTarget
43  * @param target Receives the constructed GoWebScanCalTarget object.
44  * @param fileName Filename (including path). Expected to be an XML file.
45  * @param alloc Memory allocator (or kNULL for default).
46  * @return Operation status.
47  */
48 GoWebScanFx(kStatus) GoWebScanCalTarget_Load(GoWebScanCalTarget* target, const kChar* fileName, kAlloc alloc);
49 
50 /**
51  * Writes and stores a GoWebScanCalTarget object to a XML file.
52  *
53  * @public @memberof GoWebScanCalTarget
54  * @param target GoWebScanCalTarget object.
55  * @param fileName Filename (including path). Expected to be an XML file. If the file does
56  * not exist, it will be created.
57  * @return Operation status.
58  */
59 GoWebScanFx(kStatus) GoWebScanCalTarget_Store(GoWebScanCalTarget target, const kChar* fileName);
60 
61 /**
62  * Sets the width of the calibration target in mils. If not set, a default width of 4000 mils
63  * is set.
64  *
65  * @public @memberof GoWebScanCalTarget
66  * @param target GoWebScanCalTarget object.
67  * @param width Target width (mils).
68  * @return Operation status.
69  */
70 GoWebScanFx(kStatus) GoWebScanCalTarget_SetWidth(GoWebScanCalTarget target, kSize width);
71 
72 /**
73 * Gets the width of the calibration target in mils.
74 *
75 * @public @memberof GoWebScanCalTarget
76 * @param target GoWebScanCalTarget object.
77 * @return Target width (mils).
78 */
79 GoWebScanFx(kSize) GoWebScanCalTarget_Width(GoWebScanCalTarget target);
80 
81 /**
82 * Sets the height of the calibration target in mils. If not set, a default width of 2000 mils
83 * is set.
84 *
85 * @public @memberof GoWebScanCalTarget
86 * @param target GoWebScanCalTarget object.
87 * @param height Target height (mils).
88 * @return Operation status.
89 */
90 GoWebScanFx(kStatus) GoWebScanCalTarget_SetHeight(GoWebScanCalTarget target, kSize height);
91 
92 /**
93 * Gets the height of the calibration target in mils.
94 *
95 * @public @memberof GoWebScanCalTarget
96 * @param target GoWebScanCalTarget object.
97 * @return Target height (mils).
98 */
99 GoWebScanFx(kSize) GoWebScanCalTarget_Height(GoWebScanCalTarget target);
100 
101 kEndHeader()
102 #include <GoWebScanSdk/GoWebScanCalTarget.x.h>
103 
104 #endif
kStatus GoWebScanCalTarget_Construct(GoWebScanCalTarget *target, kAlloc allocator)
Constructs a GoWebScanCalTarget object.
Essential GoWebScan declarations.
kStatus GoWebScanCalTarget_SetHeight(GoWebScanCalTarget target, kSize height)
Sets the height of the calibration target in mils.
kStatus GoWebScanCalTarget_SetWidth(GoWebScanCalTarget target, kSize width)
Sets the width of the calibration target in mils.
kSize GoWebScanCalTarget_Height(GoWebScanCalTarget target)
Gets the height of the calibration target in mils.
kStatus GoWebScanCalTarget_Store(GoWebScanCalTarget target, const kChar *fileName)
Writes and stores a GoWebScanCalTarget object to a XML file.
kStatus GoWebScanCalTarget_Load(GoWebScanCalTarget *target, const kChar *fileName, kAlloc alloc)
Constructs and loads a GoWebScanCalTarget object from a saved XML file.
kSize GoWebScanCalTarget_Width(GoWebScanCalTarget target)
Gets the width of the calibration target in mils.
Represents a container for user-specified dimensions of the calibration target which are used during ...