GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanCalInputTileSet.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanCalInputTileSet.h
3 * @brief Declares a GoWebScanCalInputTileSet 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_TILE_SET_H
12 #define GO_WEB_SCAN_CAL_INPUT_TILE_SET_H
13 
16 
17 kBeginHeader()
18 
19 /**
20 * @class GoWebScanCalInputTileSet
21 * @extends kObject
22 * @ingroup GoWebScanSdk-Calibration
23 * @brief Represents a Y-matched tile spanning a system plane for a particular data type.
24 * These tile sets are provided as input to the calibration bar detector logic.
25 */
27 
28 /**
29  * Constructs a GoWebScanCalInputTileSet object.
30  *
31  * @public @memberof GoWebScanCalInputTileSet
32  * @param set Receives the constructed GoWebScanCalInputTileSet object.
33  * @param topCount Number of nodes in the top plane.
34  * @param bottomCount Number of nodes in the bottom plane.
35  * @param position Y-axis index of the tile.
36  * @param allocator Memory allocator (or kNULL for default).
37  * @return Operation status.
38  */
39 GoWebScanFx(kStatus) GoWebScanCalInputTileSet_Construct(GoWebScanCalInputTileSet* set, kSize topCount, kSize bottomCount, k64s position, kAlloc allocator);
40 
41 /**
42  * Adds a tile to the set at a specific plane and node column for a given data source. Ownership
43  * of the input tile is passed to the class and the input tile pointer is set to null afterwards.
44  *
45  * @public @memberof GoWebScanCalInputTileSet
46  * @param set GoWebScanCalInputTileSet object.
47  * @param tile Pointer to input tile to add to the set. Pointer is set to kNULL after
48  * the tile is added.
49  * @param dataSource Data source.
50  * @param plane System plane.
51  * @param column Node column index.
52  * @return Operation status.
53  */
54 GoWebScanFx(kStatus) GoWebScanCalInputTileSet_SetTile(GoWebScanCalInputTileSet set, GoWebScanCalInputTile* tile, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column);
55 
56 /**
57  * Gets a tile at a specific plane and node column in the set (for a particular data source).
58  *
59  * @public @memberof GoWebScanCalInputTileSet
60  * @param set GoWebScanCalInputTileSet object.
61  * @param dataSource Data source.
62  * @param plane System plane.
63  * @param column Node column index.
64  * @return Tile at the specified index.
65  */
66 GoWebScanFx(GoWebScanCalInputTile) GoWebScanCalInputTileSet_TileAt(GoWebScanCalInputTileSet set, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column);
67 
68 /**
69  * Gets the Y-axis index of the tile.
70  *
71  * @public @memberof GoWebScanCalInputTileSet
72  * @param set GoWebScanCalInputTileSet object.
73  * @return Y-axis index of the tile.
74  */
75 GoWebScanFx(k64s) GoWebScanCalInputTileSet_Position(GoWebScanCalInputTileSet set);
76 
77 /**
78  * Gets the number of node columns in a plane.
79  *
80  * @public @memberof GoWebScanCalInputTileSet
81  * @param set GoWebScanCalInputTileSet object.
82  * @param plane System plane.
83  * @return Number of node columns for a plane.
84  */
85 GoWebScanFx(kSize) GoWebScanCalInputTileSet_ColumnCount(GoWebScanCalInputTileSet set, GoWebScanSystemPlane plane);
86 
87 kEndHeader()
88 #include <GoWebScanSdk/GoWebScanCalInputTileSet.x.h>
89 
90 #endif
Represents a type of sensor data.
kStatus GoWebScanCalInputTileSet_SetTile(GoWebScanCalInputTileSet set, GoWebScanCalInputTile *tile, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column)
Adds a tile to the set at a specific plane and node column for a given data source.
Essential GoWebScan declarations.
GoWebScanCalInputTile GoWebScanCalInputTileSet_TileAt(GoWebScanCalInputTileSet set, GoWebScanDataSource dataSource, GoWebScanSystemPlane plane, kSize column)
Gets a tile at a specific plane and node column in the set (for a particular data source)...
kStatus GoWebScanCalInputTileSet_Construct(GoWebScanCalInputTileSet *set, kSize topCount, kSize bottomCount, k64s position, kAlloc allocator)
Constructs a GoWebScanCalInputTileSet object.
kSize GoWebScanCalInputTileSet_ColumnCount(GoWebScanCalInputTileSet set, GoWebScanSystemPlane plane)
Gets the number of node columns in a plane.
Represents a container for raw sensor messages from a single node used during calibration data collec...
Represents a Y-matched tile spanning a system plane for a particular data type. These tile sets are p...
k64s GoWebScanCalInputTileSet_Position(GoWebScanCalInputTileSet set)
Gets the Y-axis index of the tile.
Represents the top or bottom plane of the system.
Declares a GoWebScanCalInputTile object.