|
FireSync API
|
Abstract base class for algorithm data messages.
kAlgMsg is intended to serve as the base class for messages that contain camera algorithm data. Use of kAlgMsg is not strictly limited to this purpose. If desired, kAlgMsg can also be extended by applications to represent the output from pipe blocks.
kAlgMsg supports the delivery of multipart frames (that is, frames consisting of more than one type of data content) and supports the delivery of multiple frames in a single message (aka "batching"). For compatibility with FireSync message infrastructure, the first content part should always be of type kStamp; the remaining content parts can be defined as needed by particular algorithms. The kAlgMsg implementation supports up to kALG_MSG_MAX_PARTS content parts; this value can be increased by adjusting the constant, if needed.
Public Member Functions | |
| kSize | kAlgMsg_FrameCount (kAlgMsg msg) |
| Reports the number of frames in the message. More... | |
| void * | kAlgMsg_Part (kAlgMsg msg, kSize frameIndex, kSize partIndex) |
| Gets a pointer to the specified frame content part. More... | |
| kSize | kAlgMsg_PartCount (kAlgMsg msg) |
| Reports the number of content parts for each frame. More... | |
| kSize | kAlgMsg_PartDimensionCount (kAlgMsg msg, kSize partIndex) |
| Reports the dimensionality of the specified content part. More... | |
| kSize | kAlgMsg_PartLength (kAlgMsg msg, kSize partIndex, kSize dimensionIndex) |
| Reports the length of the specified part dimension. More... | |
| kType | kAlgMsg_PartType (kAlgMsg msg, kSize partIndex) |
| Reports the data type of the specified content part. More... | |
 Public Member Functions inherited from kMsgSet | |
| kSize | kMsgSet_Count (kMsgSet set) |
| Gets the count of stamped items in this message set. More... | |
| kStatus | kMsgSet_DataAt (kMsgSet set, kSize index, kArrayList *list) |
| Gets a list of data items at the specified stamp index. More... | |
| kStatus | kMsgSet_SetStampAt (kMsgSet set, kSize index, const kStamp *stamp) |
| Sets the stamp at the specified index. More... | |
| const kStamp * | kMsgSet_StampAt (kMsgSet set, kSize index) |
| Gets the stamp at the specified index. More... | |
Related | |
| #define | kAlgMsg_PartT(kAlgMsg_msg, kSize_frameIndex, kSize_partIndex, T) |
| Gets a strongly-typed pointer to the specified frame content part. More... | |
| #define | kALG_MSG_MAX_PARTS |
| Maximum number of content parts supported by kAlgMsg. | |
