GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanTileListMsg.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanTileListMsg.h
3 * @brief Declares a GoWebScanTileListMsg 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_TILE_LIST_MSG_H
11 #define GO_SCANNER_TILE_LIST_MSG_H
12 
15 
16 kBeginHeader()
17 
18 /**
19 * @class GoWebScanTileListMsg
20 * @extends GoWebScanPipeMsg
21 * @ingroup GoWebScanSdk-Messages
22 * @brief Represents a list of tiles (of the same type and plane) that are matched by Y-position.
23 * This message type contains data after syncronization and prior to merging.
24 */
26 
27 /**
28 * Constructs a GoWebScanTileListMsg object.
29 *
30 * @public @memberof GoWebScanTileListMsg
31 * @param msg Receives the constructed GoWebScanTileListMsg object.
32 * @param pool Message pool of GoWebScanTileListMsg objects
33 * @param allocator Memory allocator (or kNULL for default).
34 * @return Operation status.
35 */
36 GoWebScanFx(kStatus) GoWebScanTileListMsg_Construct(GoWebScanTileListMsg* msg, GoWebScanPipeMsgPool pool, kAlloc allocator);
37 
38 /**
39 * Destroys a GoWebScanTileListMsg object.
40 *
41 * @public @memberof GoWebScanTileListMsg
42 * @param msg GoWebScanTileListMsg object.
43 * @return Operation status.
44 */
45 GoWebScanFx(kStatus) GoWebScanTileListMsg_Destroy(GoWebScanTileListMsg msg);
46 
47 /**
48 * Adds a tile to the list.
49 *
50 * @public @memberof GoWebScanTileListMsg
51 * @param msg GoWebScanTileListMsg object.
52 * @param tile Tile message to add.
53 * @return Operation status.
54 */
55 GoWebScanFx(kStatus) GoWebScanTileListMsg_Add(GoWebScanTileListMsg msg, GoWebScanPipeMsg tile);
56 
57 /**
58 * Recycles all tiles contained in the list.
59 *
60 * @public @memberof GoWebScanTileListMsg
61 * @param msg GoWebScanTileListMsg object.
62 * @return Operation status.
63 */
64 GoWebScanFx(kStatus) GoWebScanTileListMsg_Clear(GoWebScanTileListMsg msg);
65 
66 /**
67 * Gets the size, in bytes, of the message data buffer.
68 *
69 * @public @memberof GoWebScanTileListMsg
70 * @param msg GoWebScanTileListMsg object.
71 * @return Message data buffer size (bytes).
72 */
73 GoWebScanFx(kSize) GoWebScanTileListMsg_Size(GoWebScanTileListMsg msg);
74 
75 /**
76 * Gets the count of tiles in the list.
77 *
78 * @public @memberof GoWebScanTileListMsg
79 * @param msg GoWebScanTileListMsg object.
80 * @return Message count.
81 */
82 GoWebScanFx(kSize) GoWebScanTileListMsg_Count(GoWebScanTileListMsg msg);
83 
84 /**
85 * Gets the tile message of a specified index of the list.
86 *
87 * @public @memberof GoWebScanTileListMsg
88 * @param msg GoWebScanTileListMsg object.
89 * @param index Tile index.
90 * @return Tile message.
91 */
92 GoWebScanFx(GoWebScanPipeMsg) GoWebScanTileListMsg_At(GoWebScanTileListMsg msg, kSize index);
93 
94 kEndHeader()
95 #include <GoWebScanSdk/GoWebScanTileListMsg.x.h>
96 
97 #endif
98 
kStatus GoWebScanTileListMsg_Add(GoWebScanTileListMsg msg, GoWebScanPipeMsg tile)
Adds a tile to the list.
Represents a list of tiles (of the same type and plane) that are matched by Y-position. This message type contains data after syncronization and prior to merging.
kSize GoWebScanTileListMsg_Size(GoWebScanTileListMsg msg)
Gets the size, in bytes, of the message data buffer.
Declares the GoWebScanPipeMsg class.
kSize GoWebScanTileListMsg_Count(GoWebScanTileListMsg msg)
Gets the count of tiles in the list.
Essential GoWebScan declarations.
GoWebScanPipeMsg GoWebScanTileListMsg_At(GoWebScanTileListMsg msg, kSize index)
Gets the tile message of a specified index of the list.
kStatus GoWebScanTileListMsg_Destroy(GoWebScanTileListMsg msg)
Destroys a GoWebScanTileListMsg object.
kStatus GoWebScanTileListMsg_Construct(GoWebScanTileListMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
Constructs a GoWebScanTileListMsg object.
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...
kStatus GoWebScanTileListMsg_Clear(GoWebScanTileListMsg msg)
Recycles all tiles contained in the list.