FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kProfileMsg.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PROFILE_MSG_H
9 #define K_FIRESYNC_PROFILE_MSG_H
10 
11 #include <kFireSync/Data/kMsgSet.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kMsgSet kProfileMsg; --forward-declared in kFsDef.x.h
22 
23 
34 kFsFx(kStatus) kProfileMsg_Construct(kProfileMsg* msg, kType pointType, kSize pointCount, kSize profileCount, kAlloc allocator);
35 
46 kFsFx(kStatus) kProfileMsg_BeginAttach(kProfileMsg msg, kType pointType, kSize pointCount, kSize profileCount);
47 
59 kFsFx(kStatus) kProfileMsg_Attach(kProfileMsg msg, kSize itemIndex, kStamp* stamp, void* pointData, void* intensityData);
60 
69 kFsFx(kStatus) kProfileMsg_Assign(kProfileMsg msg, kProfileMsg source);
70 
79 kFsFx(kStamp*) kProfileMsg_StampAt(kProfileMsg msg, kSize itemIndex);
80 
90 kFsFx(void*) kProfileMsg_PointAt(kProfileMsg msg, kSize itemIndex, kSize pointIndex);
91 
101 kFsFx(k8u*) kProfileMsg_IntensityAt(kProfileMsg msg, kSize itemIndex, kSize pointIndex);
102 
110 kFsFx(kType) kProfileMsg_PointType(kProfileMsg msg);
111 
119 kFsFx(kSize) kProfileMsg_PointCount(kProfileMsg msg);
120 
128 kFsFx(kSize) kProfileMsg_ProfileCount(kProfileMsg msg);
129 
130 kEndHeader()
131 
132 #include <kFireSync/Data/kProfileMsg.x.h>
133 
134 #endif
kProfileMsg::kProfileMsg_PointAt
void * kProfileMsg_PointAt(kProfileMsg msg, kSize itemIndex, kSize pointIndex)
Returns a pointer to a specific point.
kMsgSet.h
Declares the kMsgSet type.
kProfileMsg::kProfileMsg_Attach
kStatus kProfileMsg_Attach(kProfileMsg msg, kSize itemIndex, kStamp *stamp, void *pointData, void *intensityData)
Attaches one of the profiles to external buffer(s).
kProfileMsg::kProfileMsg_Assign
kStatus kProfileMsg_Assign(kProfileMsg msg, kProfileMsg source)
Copies the source message.
kProfileMsg::kProfileMsg_BeginAttach
kStatus kProfileMsg_BeginAttach(kProfileMsg msg, kType pointType, kSize pointCount, kSize profileCount)
Prepare attaching the message content to external buffer(s).
kProfileMsg::kProfileMsg_StampAt
kStamp * kProfileMsg_StampAt(kProfileMsg msg, kSize itemIndex)
Returns a pointer to the stamp specified by item index.
kStamp
Represents acquisition metadata associated with a data message.
Definition: kNodeDef.h:2263
kProfileMsg::kProfileMsg_Construct
kStatus kProfileMsg_Construct(kProfileMsg *msg, kType pointType, kSize pointCount, kSize profileCount, kAlloc allocator)
Constructs a kProfileMsg object.
kProfileMsg::kProfileMsg_IntensityAt
k8u * kProfileMsg_IntensityAt(kProfileMsg msg, kSize itemIndex, kSize pointIndex)
Returns a pointer to a specific intensity value.
kProfileMsg
Represents a data message (FPGA LUT).