GoWebScan API
Home
Topics
Types
Files
All
Classes
Files
Functions
Variables
Typedefs
Macros
Modules
Pages
GoWebScanCalInputTile.h
Go to the documentation of this file.
1
/**
2
* @file GoWebScanCalInputTile.h
3
* @brief Declares a GoWebScanCalInputTile 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_H
12
#define GO_WEB_SCAN_CAL_INPUT_TILE_H
13
14
#include <
GoWebScanSdk/GoWebScanSdkDef.h
>
15
#include <
GoWebScanSdk/GoWebScanCalInputItem.h
>
16
17
kBeginHeader()
18
19
/**
20
* @class GoWebScanCalInputTile
21
* @extends kObject
22
* @ingroup GoWebScanSdk-Calibration
23
* @brief Represents a container for raw sensor messages from a single node used
24
* during calibration data collection.
25
*/
26
typedef
kObject
GoWebScanCalInputTile
;
27
28
// Forward declaration
29
typedef
kObject
GoWebScanCalInputItem
;
30
31
/**
32
* Constructs a GoWebScanCalInputTile object.
33
*
34
* @public @memberof GoWebScanCalInputTile
35
* @param tile Receives the constructed GoWebScanCalInputTile object.
36
* @param position Y-axis index of the tile.
37
* @param time Timestamp of the tile (microseconds).
38
* @param allocator Memory allocator (or kNULL for default).
39
* @return Operation status.
40
*/
41
GoWebScanFx(
kStatus
)
GoWebScanCalInputTile_Construct
(GoWebScanCalInputTile* tile,
k64s
position,
k64s
time,
kAlloc
allocator);
42
43
/**
44
* Adds sensor data (contained in a GoWebScanCalInputItem object) to the tile.
45
*
46
* @public @memberof GoWebScanCalInputTile
47
* @param tile GoWebScanCalInputTile object.
48
* @param item Input item.
49
* @return Operation status.
50
*/
51
GoWebScanFx(
kStatus
)
GoWebScanCalInputTile_AddItem
(GoWebScanCalInputTile tile, GoWebScanCalInputItem* item);
52
53
/**
54
* Removes sensor data (contained in a GoWebScanCalInputItem object) from the tile.
55
*
56
* @public @memberof GoWebScanCalInputTile
57
* @param tile GoWebScanCalInputTile object.
58
* @param item Pointer to the removed input item.
59
* @return Operation status.
60
*/
61
GoWebScanFx(
kStatus
)
GoWebScanCalInputTile_RemoveItem
(GoWebScanCalInputTile tile, GoWebScanCalInputItem* item);
62
63
/**
64
* Gets the number of message items in the tile.
65
*
66
* @public @memberof GoWebScanCalInputTile
67
* @param tile GoWebScanCalInputTile object.
68
* @return Item count.
69
*/
70
GoWebScanFx(
kSize
)
GoWebScanCalInputTile_ItemCount
(GoWebScanCalInputTile tile);
71
72
/**
73
* Gets the message item at a specific index in the tile.
74
*
75
* @public @memberof GoWebScanCalInputTile
76
* @param tile GoWebScanCalInputTile object.
77
* @param index Item index.
78
* @return GoWebScanCalInputItem object representing the message.
79
*/
80
GoWebScanFx(GoWebScanCalInputItem)
GoWebScanCalInputTile_ItemAt
(GoWebScanCalInputTile tile,
kSize
index);
81
82
/**
83
* Gets the Y-axis index of the tile.
84
*
85
* @public @memberof GoWebScanCalInputTile
86
* @param tile GoWebScanCalInputTile object.
87
* @return Y-axis index.
88
*/
89
GoWebScanFx(
k64s
)
GoWebScanCalInputTile_Position
(GoWebScanCalInputTile tile);
90
91
/**
92
* Gets the timestamp of the tile in microseconds.
93
*
94
* @public @memberof GoWebScanCalInputTile
95
* @param tile GoWebScanCalInputTile object.
96
* @return Time of tile (microseconds).
97
*/
98
GoWebScanFx(
k64s
)
GoWebScanCalInputTile_Time
(GoWebScanCalInputTile tile);
99
100
kEndHeader()
101
#include <GoWebScanSdk/GoWebScanCalInputTile.x.h>
102
103
#endif
GoWebScanCalInputTile::GoWebScanCalInputTile_RemoveItem
kStatus GoWebScanCalInputTile_RemoveItem(GoWebScanCalInputTile tile, GoWebScanCalInputItem *item)
Removes sensor data (contained in a GoWebScanCalInputItem object) from the tile.
GoWebScanCalInputTile::GoWebScanCalInputTile_ItemAt
GoWebScanCalInputItem GoWebScanCalInputTile_ItemAt(GoWebScanCalInputTile tile, kSize index)
Gets the message item at a specific index in the tile.
kSize
kAlloc
GoWebScanSdkDef.h
Essential GoWebScan declarations.
GoWebScanCalInputTile::GoWebScanCalInputTile_Position
k64s GoWebScanCalInputTile_Position(GoWebScanCalInputTile tile)
Gets the Y-axis index of the tile.
GoWebScanCalInputTile::GoWebScanCalInputTile_Construct
kStatus GoWebScanCalInputTile_Construct(GoWebScanCalInputTile *tile, k64s position, k64s time, kAlloc allocator)
Constructs a GoWebScanCalInputTile object.
GoWebScanCalInputItem
Represents a raw sensor message used for calibration collection and processing.
GoWebScanCalInputTile
Represents a container for raw sensor messages from a single node used during calibration data collec...
GoWebScanCalInputTile::GoWebScanCalInputTile_AddItem
kStatus GoWebScanCalInputTile_AddItem(GoWebScanCalInputTile tile, GoWebScanCalInputItem *item)
Adds sensor data (contained in a GoWebScanCalInputItem object) to the tile.
GoWebScanCalInputItem.h
Declares a GoWebScanCalInputItem object.
k64s
GoWebScanCalInputTile::GoWebScanCalInputTile_Time
k64s GoWebScanCalInputTile_Time(GoWebScanCalInputTile tile)
Gets the timestamp of the tile in microseconds.
kObject
kStatus
GoWebScanCalInputTile::GoWebScanCalInputTile_ItemCount
kSize GoWebScanCalInputTile_ItemCount(GoWebScanCalInputTile tile)
Gets the number of message items in the tile.
GoWebScanCalInputTile.h
This site is best viewed with Firefox. Copyright (C) 2003-2016 by LMI Technologies.