FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kAlgMsg.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ALG_MSG_H
9 #define K_FIRESYNC_ALG_MSG_H
10 
11 #include <kFireSync/Data/kMsgSet.h>
12 
13 kBeginHeader()
14 
15 
16 #define kALG_MSG_MAX_PARTS (4)
17 
37 //typedef kMsgSet kAlgMsg; --forward-declared in kFsDef.x.h
38 
46 kFsFx(kSize) kAlgMsg_FrameCount(kAlgMsg msg);
47 
55 kFsFx(kSize) kAlgMsg_PartCount(kAlgMsg msg);
56 
65 kFsFx(kType) kAlgMsg_PartType(kAlgMsg msg, kSize partIndex);
66 
75 kFsFx(kSize) kAlgMsg_PartDimensionCount(kAlgMsg msg, kSize partIndex);
76 
86 kFsFx(kSize) kAlgMsg_PartLength(kAlgMsg msg, kSize partIndex, kSize dimensionIndex);
87 
97 kFsFx(void*) kAlgMsg_Part(kAlgMsg msg, kSize frameIndex, kSize partIndex);
98 
99 kEndHeader()
100 
101 #define kAlgMsg_Part_(MSG, FI, PI) kxAlgMsg_Part_(MSG, FI, PI)
102 
103 #include <kFireSync/Data/kAlgMsg.x.h>
104 
105 #endif
kSize kAlgMsg_PartDimensionCount(kAlgMsg msg, kSize partIndex)
Reports the dimensionality of the specified content part.
Declares the kMsgSet type.
kSize kAlgMsg_PartLength(kAlgMsg msg, kSize partIndex, kSize dimensionIndex)
Reports the length of the specified part dimension.
Abstract base class for algorithm data messages.
kType kAlgMsg_PartType(kAlgMsg msg, kSize partIndex)
Reports the data type of the specified content part.
kSize kAlgMsg_PartCount(kAlgMsg msg)
Reports the number of content parts for each frame.
kSize kAlgMsg_FrameCount(kAlgMsg msg)
Reports the number of frames in the message.
void * kAlgMsg_Part(kAlgMsg msg, kSize frameIndex, kSize partIndex)
Gets a pointer to the specified frame content part.