GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanSystemMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanSystemMsg.h
3 * @brief Declares a GoWebScanSystemMsg 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 #ifndef GO_SCANNER_SYSTEM_MSG_H
11 #define GO_SCANNER_SYSTEM_MSG_H
12 
15 
16 kBeginHeader()
17 
18 /**
19 * @class GoWebScanSystemMsg
20 * @extends GoWebScanPipeMsg
21 * @ingroup GoWebScanSdk-Messages
22 * @brief Represents a container of GoWebScanPipeMsg tile messages of each tile type (profile, tracheid,
23 * and vision) and each system plane (top and bottom). This message is used to contain the
24 * X and Y-axis matched tile output of merging, and also of board detection (where the tiles
25 * represent a detected board).
26 */
28 
29 /**
30 * Constructs a GoWebScanSystemMsg msg.
31 *
32 * @public @memberof GoWebScanSystemMsg
33 * @param msg Receives the constructed GoWebScanSystemMsg msg.
34 * @param pool Message pool of GoWebScanSystemMsg objects
35 * @param allocator Memory allocator (or kNULL for default).
36 * @return Operation status.
37 */
38 GoWebScanFx(kStatus) GoWebScanSystemMsg_Construct(GoWebScanSystemMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);
39 
40 /**
41 * Destroys a GoWebScanSystemMsg object.
42 *
43 * @public @memberof GoWebScanSystemMsg
44 * @param msg GoWebScanSystemMsg object.
45 * @return Operation status.
46 */
47 GoWebScanFx(kStatus) GoWebScanSystemMsg_Destroy(GoWebScanSystemMsg msg);
48 
49 /**
50 * Gets the size, in bytes, of the message data buffer.
51 *
52 * @public @memberof GoWebScanSystemMsg
53 * @param msg GoWebScanSystemMsg object.
54 * @return Message data buffer size (bytes).
55 */
56 GoWebScanFx(kSize) GoWebScanSystemMsg_Size(GoWebScanSystemMsg msg);
57 
58 /**
59 * Recycles all messages contained in the system message.
60 *
61 * @public @memberof GoWebScanSystemMsg
62 * @param msg GoWebScanSystemMsg object.
63 * @return Operation status.
64 */
65 GoWebScanFx(kStatus) GoWebScanSystemMsg_Clear(GoWebScanSystemMsg msg);
66 
67 /**
68 * Adds a tile message to the system message.
69 *
70 * @public @memberof GoWebScanSystemMsg
71 * @param msg GoWebScanSystemMsg object.
72 * @param id Tile type (profile, trachied, or vision).
73 * @param plane System plane of tile.
74 * @param tile Tile message to add.
75 * @return Operation status.
76 */
77 GoWebScanFx(kStatus) GoWebScanSystemMsg_SetTile(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane, GoWebScanPipeMsg tile);
78 
79 /**
80 * Gets the tile message of a specified type and plane.
81 *
82 * @public @memberof GoWebScanSystemMsg
83 * @param msg GoWebScanSystemMsg object.
84 * @param id Tile type (profile, trachied, or vision).
85 * @param plane System plane of tile.
86 * @return Tile message.
87 */
88 GoWebScanFx(GoWebScanPipeMsg) GoWebScanSystemMsg_TileAt(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane);
89 
90 kEndHeader()
91 #include <GoWebScanSdk/GoWebScanSystemMsg.x.h>
92 
93 #endif
94 
kStatus GoWebScanSystemMsg_SetTile(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane, GoWebScanPipeMsg tile)
Adds a tile message to the system message.
GoWebScanPipeMsg GoWebScanSystemMsg_TileAt(GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane)
Gets the tile message of a specified type and plane.
Declares the GoWebScanPipeMsg class.
Essential GoWebScan declarations.
Represents a container of GoWebScanPipeMsg tile messages of each tile type (profile, tracheid, and vision) and each system plane (top and bottom). This message is used to contain the X and Y-axis matched tile output of merging, and also of board detection (where the tiles represent a detected board).
kStatus GoWebScanSystemMsg_Clear(GoWebScanSystemMsg msg)
Recycles all messages contained in the system message.
Represents the top or bottom plane of the system.
kStatus GoWebScanSystemMsg_Construct(GoWebScanSystemMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanSystemMsg msg.
kSize GoWebScanSystemMsg_Size(GoWebScanSystemMsg msg)
Gets the size, in bytes, of the message data buffer.
Represents a pool of GoWebScanPipeMsg objects. The pool allocates GoWebScanPipeMsg objects with a def...
Base class for a msg that can be processed with a GoWebScanPipeTask and submitted to the GoWebScanPip...
Represents an ID for types of plane tile messages.
kStatus GoWebScanSystemMsg_Destroy(GoWebScanSystemMsg msg)
Destroys a GoWebScanSystemMsg object.