GoWebScan API
Home
Topics
Types
Files
All
Classes
Files
Functions
Variables
Typedefs
Macros
Modules
Pages
GoWebScanCalInput.h
Go to the documentation of this file.
1
/**
2
* @file GoWebScanCalInput.h
3
* @brief Declares a GoWebScanCalInput 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_INPUT_H
12
#define GO_WEB_SCAN_CAL_INPUT_H
13
14
#include <
GoWebScanSdk/GoWebScanSdkDef.h
>
15
16
kBeginHeader()
17
18
/**
19
* @class GoWebScanCalInput
20
* @extends kObject
21
* @ingroup GoWebScanSdk-Calibration
22
* @brief Represents Y-matched system data containing a calibration bar, used for
23
* calibration processing. The GoWebScanCalInput object contains a list of
24
* GoWebScanCalInputNode objects which represent containers of individual
25
* node messages. The message are raw sensor data and undergo no resampling
26
* or merging.
27
*/
28
typedef
kObject
GoWebScanCalInput
;
29
30
// Forward declarations
31
typedef
kObject
GoWebScanCalInputNode
;
32
typedef
kObject
GoWebScanCalInputItem
;
33
34
/**
35
* Constructs a GoWebScanCalInput object.
36
*
37
* @public @memberof GoWebScanCalInput
38
* @param input Receives the constructed GoWebScanCalInput object.
39
* @param topCount Number of top nodes.
40
* @param bottomCount Number of bottom nodes.
41
* @param allocator Memory allocator (or kNULL for default).
42
* @return Operation status.
43
*/
44
GoWebScanFx(
kStatus
)
GoWebScanCalInput_Construct
(GoWebScanCalInput* input,
kSize
topCount,
kSize
bottomCount,
kAlloc
allocator);
45
46
/**
47
* Sets the properties of the input dataset.
48
*
49
* @public @memberof GoWebScanCalInput
50
* @param input GoWebScanCalInput object.
51
* @param startTile Index of starting tile of dataset.
52
* @param tileCount Number of tiles.
53
* @param tileExtent Tile extent in Y-axis (mils).
54
* @return Operation status.
55
*/
56
GoWebScanFx(
kStatus
)
GoWebScanCalInput_SetTileInfo
(GoWebScanCalInput input,
k64s
startTile,
k64s
tileCount,
k64s
tileExtent);
57
58
/**
59
* Constructs and adds a node input to the system input. Each node is defined by a unique column,
60
* data source, and system plane.
61
*
62
* @public @memberof GoWebScanCalInput
63
* @param input GoWebScanCalInput object.
64
* @param source Data source.
65
* @param plane System plane.
66
* @param column Node column index.
67
* @return Operation status.
68
*/
69
GoWebScanFx(
kStatus
)
GoWebScanCalInput_CreateNode
(GoWebScanCalInput input,
GoWebScanDataSource
source,
GoWebScanSystemPlane
plane,
kSize
column);
70
71
/**
72
* Gets the node input object for a specified column, source, and plane.
73
*
74
* @public @memberof GoWebScanCalInput
75
* @param input GoWebScanCalInput object.
76
* @param source Data source.
77
* @param plane System plane.
78
* @param column Node column index.
79
* @return GoWebScanCalInputNode object representing node input.
80
*/
81
GoWebScanFx(GoWebScanCalInputNode)
GoWebScanCalInput_GetNode
(GoWebScanCalInput input,
GoWebScanDataSource
source,
GoWebScanSystemPlane
plane,
kSize
column);
82
83
/**
84
* Gets the start Y position of the input set of data in mils.
85
*
86
* @public @memberof GoWebScanCalInput
87
* @param input GoWebScanCalInput object.
88
* @return Start Y position (mils).
89
*/
90
GoWebScanFx(
k64s
)
GoWebScanCalInput_StartY
(GoWebScanCalInput input);
91
92
/**
93
* Gets the extent of the input data in the Y axis in mils.
94
*
95
* @public @memberof GoWebScanCalInput
96
* @param input GoWebScanCalInput object.
97
* @return Y extent (mils).
98
*/
99
GoWebScanFx(
k64s
)
GoWebScanCalInput_YExtent
(GoWebScanCalInput input);
100
101
kEndHeader()
102
#include <GoWebScanSdk/GoWebScanCalInput.x.h>
103
104
#endif
GoWebScanCalInput::GoWebScanCalInput_SetTileInfo
kStatus GoWebScanCalInput_SetTileInfo(GoWebScanCalInput input, k64s startTile, k64s tileCount, k64s tileExtent)
Sets the properties of the input dataset.
GoWebScanDataSource
Represents a type of sensor data.
kSize
kAlloc
GoWebScanSdkDef.h
Essential GoWebScan declarations.
GoWebScanCalInput
Represents Y-matched system data containing a calibration bar, used for calibration processing...
GoWebScanCalInputItem
Represents a raw sensor message used for calibration collection and processing.
GoWebScanCalInput::GoWebScanCalInput_YExtent
k64s GoWebScanCalInput_YExtent(GoWebScanCalInput input)
Gets the extent of the input data in the Y axis in mils.
GoWebScanCalInput::GoWebScanCalInput_StartY
k64s GoWebScanCalInput_StartY(GoWebScanCalInput input)
Gets the start Y position of the input set of data in mils.
GoWebScanCalInputNode
Represents a container for raw sensor messages of a particular data type from a single node for calib...
k64s
GoWebScanSystemPlane
Represents the top or bottom plane of the system.
GoWebScanCalInput::GoWebScanCalInput_Construct
kStatus GoWebScanCalInput_Construct(GoWebScanCalInput *input, kSize topCount, kSize bottomCount, kAlloc allocator)
Constructs a GoWebScanCalInput object.
kObject
kStatus
GoWebScanCalInput::GoWebScanCalInput_GetNode
GoWebScanCalInputNode GoWebScanCalInput_GetNode(GoWebScanCalInput input, GoWebScanDataSource source, GoWebScanSystemPlane plane, kSize column)
Gets the node input object for a specified column, source, and plane.
GoWebScanCalInput::GoWebScanCalInput_CreateNode
kStatus GoWebScanCalInput_CreateNode(GoWebScanCalInput input, GoWebScanDataSource source, GoWebScanSystemPlane plane, kSize column)
Constructs and adds a node input to the system input.
GoWebScanCalInput.h
This site is best viewed with Firefox. Copyright (C) 2003-2016 by LMI Technologies.