GoWebScan API
GoWebScanSystemMsg Class Reference

Description

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).

Inheritance diagram for GoWebScanSystemMsg:
Inheritance graph

Public Member Functions

kStatus GoWebScanPipeMsg_Acquire (GoWebScanPipeMsg msg)
 Increments the msg's reference count. More...
 
GoWebScanMsgStampGoWebScanPipeMsg_GetStamp (GoWebScanPipeMsg msg)
 Gets the stamp associated with the message. More...
 
kStatus GoWebScanPipeMsg_Relinquish (GoWebScanPipeMsg msg)
 Decrements the msg's reference count. More...
 
kStatus GoWebScanPipeMsg_SetStamp (GoWebScanPipeMsg msg, const GoWebScanMsgStamp *stamp)
 Sets the stamp associated with the message. More...
 
kSize GoWebScanPipeMsg_Size (GoWebScanPipeMsg msg)
 Gets the size, in bytes, of the message's data buffer. More...
 
GoWebScanMsgType GoWebScanPipeMsg_TypeId (GoWebScanPipeMsg msg)
 Gets the message type. More...
 
kStatus GoWebScanSystemMsg_Clear (GoWebScanSystemMsg msg)
 Recycles all messages contained in the system message. More...
 
kStatus GoWebScanSystemMsg_Construct (GoWebScanSystemMsg *msg, GoWebScanPipeMsgPool pool, kAlloc allocator)
 Constructs a GoWebScanSystemMsg msg. More...
 
kStatus GoWebScanSystemMsg_Destroy (GoWebScanSystemMsg msg)
 Destroys a GoWebScanSystemMsg object. More...
 
kStatus GoWebScanSystemMsg_SetTile (GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane, GoWebScanPipeMsg tile)
 Adds a tile message to the system message. More...
 
kSize GoWebScanSystemMsg_Size (GoWebScanSystemMsg msg)
 Gets the size, in bytes, of the message data buffer. More...
 
GoWebScanPipeMsg GoWebScanSystemMsg_TileAt (GoWebScanSystemMsg msg, GoWebScanPlaneTileId id, GoWebScanSystemPlane plane)
 Gets the tile message of a specified type and plane. More...
 

The documentation for this class was generated from the following file: