Gocator API

GoDataTypes.h
Go to the documentation of this file.
1 /**
2 * @file GoDataTypes.h
3 * @brief Declares Gocator data message classes and related types.
4 *
5 * @internal
6 * Copyright (C) 2016-2020 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_DATA_TYPES_H
11 #define GO_SDK_DATA_TYPES_H
12
13 #include <GoSdk/GoSdkDef.h>
14 kBeginHeader()
15
16 /**
17 * @class GoDataMsg
18 * @extends kObject
19 * @ingroup GoSdk-DataChannel
20 * @brief Represents a base message sourced from the data channel.
21 */
22 typedef kObject GoDataMsg;
23
24 /**
25 * Returns the message type for a data channel message given in a GoDataSet.
26 *
27 * @public @memberof GoDataMsg
28 * @version Introduced in firmware 4.0.10.27
29 * @param message A data channel message.
30 * @return A GoDataMessageType value.
31 */
32 GoFx(GoDataMessageType) GoDataMsg_Type(GoDataMsg message);
33
34 /**
35 * Gets the source of the data stream.
36 *
37 * @public @memberof GoDataMsg
38 * @version Introduced in firmware 5.2
39 * @param message Message object.
40 * @return A GoDataStep value.
41 */
42 GoFx(GoDataStep) GoDataMsg_StreamStep(GoDataMsg message);
43
44 /**
45 * Gets the identifier of the data stream from the source.
46 *
47 * @public @memberof GoDataMsg
48 * @version Introduced in firmware 5.2
49 * @param message Message object.
50 * @return Stream step identifier number.
51 */
52 GoFx(k32s) GoDataMsg_StreamStepId(GoDataMsg message);
53
54 /**
55 * Sets the source of the data stream.
56 *
57 * @public @memberof GoDataMsg
58 * @version Introduced in firmware 5.2
59 * @param message Message object.
60 * @param streamStep streamStep value
61 * @return Result status.
62 */
63 GoFx(kStatus) GoDataMsg_SetStreamStep(GoDataMsg message, GoDataStep streamStep);
64
65 /**
66 * Sets the identifier of the data stream from the source.
67 *
68 * @public @memberof GoDataMsg
69 * @version Introduced in firmware 5.2
70 * @param message Message object.
71 * @param streamStepId streamStepId value
72 * @return Result status.
73 */
74 GoFx(kStatus) GoDataMsg_SetStreamStepId(GoDataMsg message, k32s streamStepId);
75
76
77 /**
78 * @struct GoStamp
79 * @extends kValue
80 * @ingroup GoSdk-DataChannel
81 * @brief Represents an acquisition stamp.
82 */
83 typedef struct GoStamp
84 {
85 k64u frameIndex; ///< Frame index (counts up from zero).
86 k64u timestamp; ///< Timestamp in internal units approximating microseconds where the true time in us = timestamp value / 1.024.
87 k64s encoder; ///< Position (encoder ticks).
88 k64s encoderAtZ; ///< Encoder value latched at z-index mark (encoder ticks).
89 k64u status;
90 /**<
91 * Bit mask containing frame information:
92 *
93 * - Bit 0: Represents sensor digital input state.
94 * - Bit 4: Represents Master digital input state.
95 * - Bits 8 and 9: Represents inter-frame digital pulse trigger
96 (Master digital input if a Master is connected, otherwise
97 sensor digital input. Value is cleared after each frame
98 and clamped at 3 if more than 3 pulses are received).
99 */
100 k32u id; ///< Source device ID.
101 k32u reserved32u; ///< Reserved.
102 k64u reserved64u; ///< Reserved.
103 } GoStamp;
104
105 /**
106 * @class GoStampMsg
107 * @extends GoDataMsg
108 * @ingroup GoSdk-DataChannel
109 * @brief Represents a message containing a set of acquisition stamps.
110 */
111 typedef GoDataMsg GoStampMsg;
112
113 /**
114 * Gets the stamp source.
115 *
116 * @public @memberof GoStampMsg
117 * @version Introduced in firmware 4.0.10.27
118 * @param msg Message object.
119 * @return Stamp source.
120 */
121 GoFx(GoDataSource) GoStampMsg_Source(GoStampMsg msg);
122
123 /**
124 * Returns the number of stamps contained in this message.
125 *
126 * @public @memberof GoStampMsg
127 * @version Introduced in firmware 4.0.10.27
128 * @param msg Message object.
129 * @return Count of stamps.
130 */
131 GoFx(kSize) GoStampMsg_Count(GoStampMsg msg);
132
133 /**
134 * Gets the stamp at the specified index.
135 *
136 * @public @memberof GoStampMsg
137 * @version Introduced in firmware 4.0.10.27
138 * @param msg Message object.
139 * @param index Stamp index.
140 * @return Stamp pointer.
141 */
142 GoFx(GoStamp*) GoStampMsg_At(GoStampMsg msg, kSize index);
143
144 /**
145 * @class GoVideoMsg
146 * @extends GoDataMsg
147 * @ingroup GoSdk-DataChannel
148 * @brief Represents a data message containing a video image.
149 */
150 typedef GoDataMsg GoVideoMsg;
151
152 /**
153 * Gets the video source.
154 *
155 * @public @memberof GoVideoMsg
156 * @version Introduced in firmware 4.0.10.27
157 * @param msg Message object.
158 * @return Video source.
159 */
160 GoFx(GoDataSource) GoVideoMsg_Source(GoVideoMsg msg);
161
162
163 /**
164 * Gets the camera index that the video data originates from.
165 *
166 * @public @memberof GoVideoMsg
167 * @version Introduced in firmware 4.0.10.27
168 * @param msg Message object.
169 * @return Camera index.
170 */
171 GoFx(kSize) GoVideoMsg_CameraIndex(GoVideoMsg msg);
172
173
174 /**
175 * Gets the image width, in pixels.
176 *
177 * @public @memberof GoVideoMsg
178 * @version Introduced in firmware 4.0.10.27
179 * @param msg Message object.
180 * @return Image width, in pixels.
181 */
182 GoFx(kSize) GoVideoMsg_Width(GoVideoMsg msg);
183
184 /**
185 * Gets the image height, in pixels.
186 *
187 * @public @memberof GoVideoMsg
188 * @version Introduced in firmware 4.0.10.27
189 * @param msg Message object.
190 * @return Image height, in pixels.
191 */
192 GoFx(kSize) GoVideoMsg_Height(GoVideoMsg msg);
193
194 /**
195 * Gets the data type used to represent an image pixel.
196 *
197 * @public @memberof GoVideoMsg
198 * @version Introduced in firmware 4.0.10.27
199 * @param msg Message object.
200 * @return Pixel type.
201 */
202 GoFx(GoPixelType) GoVideoMsg_PixelType(GoVideoMsg msg);
203
204 /**
205 * Gets the image pixel size, in bytes.
206 *
207 * @public @memberof GoVideoMsg
208 * @version Introduced in firmware 4.0.10.27
209 * @param msg Message object.
210 * @return Pixel size, in bytes.
211 */
212 GoFx(kSize) GoVideoMsg_PixelSize(GoVideoMsg msg);
213
214 /**
215 * Gets the pixel format descriptor.
216 *
217 * @public @memberof GoVideoMsg
218 * @version Introduced in firmware 4.0.10.27
219 * @param msg Message object.
220 * @return Pixel format.
221 */
222 GoFx(kPixelFormat) GoVideoMsg_PixelFormat(GoVideoMsg msg);
223
224 /**
225 * Gets the image color filter array.
226 *
227 * @public @memberof GoVideoMsg
228 * @version Introduced in firmware 4.0.10.27
229 * @param msg Message object.
230 * @return Color filter array.
231 */
232 GoFx(kCfa) GoVideoMsg_Cfa(GoVideoMsg msg);
233
234 /**
235 * Gets a pointer to a row within the image.
236 *
237 * @public @memberof GoVideoMsg
238 * @version Introduced in firmware 4.0.10.27
239 * @param msg Message object.
240 * @param rowIndex Row index.
241 * @return Row pointer.
242 */
243 GoFx(void*) GoVideoMsg_RowAt(GoVideoMsg msg, kSize rowIndex);
244
245 /**
246 * Gets the exposure index.
247 *
248 * @public @memberof GoVideoMsg
249 * @version Introduced in firmware 4.0.10.27
250 * @param msg Message object.
251 * @return Exposure index.
252 */
253 GoFx(kSize) GoVideoMsg_ExposureIndex(GoVideoMsg msg);
254
255 /**
256 * Gets the exposure.
257 *
258 * @public @memberof GoVideoMsg
259 * @version Introduced in firmware 4.0.10.27
260 * @param msg Message object.
261 * @return Exposure in uS.
262 */
263 GoFx(k32u) GoVideoMsg_Exposure(GoVideoMsg msg);
264
265 /**
266 * Indicates whether the video message data requires horizontal flipping to match up with profile data.
267 *
268 * @public @memberof GoVideoMsg
269 * @version Introduced in firmware 4.4.4.14
270 * @param msg Message object.
271 * @return kTRUE if rotation is required, kFALSE otherwise.
272 */
273 GoFx(kBool) GoVideoMsg_IsFlippedX(GoVideoMsg msg);
274
275 /**
276 * Indicates whether the video message data requires vertical flipping to match up with profile data.
277 *
278 * @public @memberof GoVideoMsg
279 * @version Introduced in firmware 4.4.4.14
280 * @param msg Message object.
281 * @return kTRUE if rotation is required, kFALSE otherwise.
282 */
283 GoFx(kBool) GoVideoMsg_IsFlippedY(GoVideoMsg msg);
284
285 /// @cond (Gocator_1x00)
286 /**
287 * @class GoRangeMsg
288 * @extends GoDataMsg
289 * @ingroup GoSdk-DataChannel
290 * @brief Represents a data message containing a set of range data.
291 */
292 typedef GoDataMsg GoRangeMsg;
293
294 /**
295 * Gets the Range source.
296 *
297 * @public @memberof GoRangeMsg
298 * @version Introduced in firmware 4.0.10.27
299 * @param msg Message object.
300 * @return Range source.
301 */
302 GoFx(GoDataSource) GoRangeMsg_Source(GoRangeMsg msg);
303
304 /**
305 * Gets the count of Range data in this message.
306 *
307 * @public @memberof GoRangeMsg
308 * @version Introduced in firmware 4.0.10.27
309 * @param msg Message object.
310 * @return Count of Range data.
311 */
312 GoFx(kSize) GoRangeMsg_Count(GoRangeMsg msg);
313
314
315 /**
316 * Gets the Range z-resolution, in nanometers.
317 *
318 * @public @memberof GoRangeMsg
319 * @version Introduced in firmware 4.0.10.27
320 * @param msg Message object.
321 * @return Z resolution (nm).
322 */
323 GoFx(k32u) GoRangeMsg_ZResolution(GoRangeMsg msg);
324
325 /**
326 * Gets the Range z-offset, in micrometers.
327 *
328 * @public @memberof GoRangeMsg
329 * @version Introduced in firmware 4.0.10.27
330 * @param msg Message object.
331 * @return Z offset (um).
332 */
333 GoFx(k32s) GoRangeMsg_ZOffset(GoRangeMsg msg);
334
335 /**
336 * Gets a pointer to Range data.
337 *
338 * @public @memberof GoRangeMsg
339 * @version Introduced in firmware 4.0.10.27
340 * @param msg Message object.
341 * @param index Range array index.
342 * @return Range pointer.
343 */
344 GoFx(k16s*) GoRangeMsg_At(GoRangeMsg msg, kSize index);
345
346 /**
347 * Gets the exposure.
348 *
349 * @public @memberof GoRangeMsg
350 * @version Introduced in firmware 4.0.10.27
351 * @param msg Message object.
352 * @return Exposure in uS.
353 */
354 GoFx(k32u) GoRangeMsg_Exposure(GoRangeMsg msg);
355
356
357 /**
358 * @class GoRangeIntensityMsg
359 * @extends GoDataMsg
360 * @ingroup GoSdk-DataChannel
361 * @brief Represents a data message containing a set of range intensity data.
362 */
363 typedef GoDataMsg GoRangeIntensityMsg;
364
365 /**
366 * Gets the range intensity source.
367 *
368 * @public @memberof GoRangeIntensityMsg
369 * @version Introduced in firmware 4.0.10.27
370 * @param msg Message object.
371 * @return Range intensity source.
372 */
373 GoFx(GoDataSource) GoRangeIntensityMsg_Source(GoRangeIntensityMsg msg);
374
375 /**
376 * Gets the count of range intensity data in this message.
377 *
378 * @public @memberof GoRangeIntensityMsg
379 * @version Introduced in firmware 4.0.10.27
380 * @param msg Message object.
381 * @return Count of range intensity data.
382 */
383 GoFx(kSize) GoRangeIntensityMsg_Count(GoRangeIntensityMsg msg);
384
385 /**
386 * Gets a pointer to range intensity data.
387 *
388 * @public @memberof GoRangeIntensityMsg
389 * @version Introduced in firmware 4.0.10.27
390 * @param msg Message object.
391 * @param index Range intensity array index.
392 * @return Range intensity data pointer.
393 */
394 GoFx(k8u*) GoRangeIntensityMsg_At(GoRangeIntensityMsg msg, kSize index);
395
396 /**
397 * Gets the exposure.
398 *
399 * @public @memberof GoRangeIntensityMsg
400 * @version Introduced in firmware 4.0.10.27
401 * @param msg Message object.
402 * @return Exposure in uS.
403 */
404 GoFx(k32u) GoRangeIntensityMsg_Exposure(GoRangeIntensityMsg msg);
405
406 /// @endcond
407
408 /// @cond (Gocator_1x00 || Gocator_2x00)
409 /**
410 * @class GoProfilePointCloudMsg
411 * @extends GoDataMsg
412 * @ingroup GoSdk-DataChannel
413 * @brief Represents a data message containing a set of profile arrays.
414 */
415 typedef GoDataMsg GoProfilePointCloudMsg;
416
417 /**
418 * Gets the profile source.
419 *
420 * @public @memberof GoProfilePointCloudMsg
421 * @version Introduced in firmware 4.8.1.70
422 * @param msg Message object.
423 * @return Profile source.
424 */
425 GoFx(GoDataSource) GoProfilePointCloudMsg_Source(GoProfilePointCloudMsg msg);
426
427 /**
428 * Gets the count of profile arrays in this message.
429 *
430 * @public @memberof GoProfilePointCloudMsg
431 * @version Introduced in firmware 4.8.1.70
432 * @param msg Message object.
433 * @return Count of profile arrays.
434 */
435 GoFx(kSize) GoProfilePointCloudMsg_Count(GoProfilePointCloudMsg msg);
436
437 /**
438 * Gets the count of ranges in each profile array.
439 *
440 * @public @memberof GoProfilePointCloudMsg
441 * @version Introduced in firmware 4.8.1.70
442 * @param msg Message object.
443 * @return Range count.
444 */
445 GoFx(kSize) GoProfilePointCloudMsg_Width(GoProfilePointCloudMsg msg);
446
447 /**
448 * Gets the profile x-resolution, in nanometers.
449 *
450 * @public @memberof GoProfilePointCloudMsg
451 * @version Introduced in firmware 4.8.1.70
452 * @param msg Message object.
453 * @return X resolution (nm).
454 */
455 GoFx(k32u) GoProfilePointCloudMsg_XResolution(GoProfilePointCloudMsg msg);
456
457 /**
458 * Gets the profile z-resolution, in nanometers.
459 *
460 * @public @memberof GoProfilePointCloudMsg
461 * @version Introduced in firmware 4.8.1.70
462 * @param msg Message object.
463 * @return Z resolution (nm).
464 */
465 GoFx(k32u) GoProfilePointCloudMsg_ZResolution(GoProfilePointCloudMsg msg);
466
467 /**
468 * Gets the profile x-offset, in micrometers.
469 *
470 * @public @memberof GoProfilePointCloudMsg
471 * @version Introduced in firmware 4.8.1.70
472 * @param msg Message object.
473 * @return X offset (um).
474 */
475 GoFx(k32s) GoProfilePointCloudMsg_XOffset(GoProfilePointCloudMsg msg);
476
477 /**
478 * Gets the profile z-offset, in micrometers.
479 *
480 * @public @memberof GoProfilePointCloudMsg
481 * @version Introduced in firmware 4.8.1.70
482 * @param msg Message object.
483 * @return Z offset (um).
484 */
485 GoFx(k32s) GoProfilePointCloudMsg_ZOffset(GoProfilePointCloudMsg msg);
486
487 /**
488 * Gets a pointer to a profile array.
489 *
490 * @public @memberof GoProfilePointCloudMsg
491 * @version Introduced in firmware 4.8.1.70
492 * @param msg Message object.
493 * @param index Profile array index.
494 * @return Profile pointer.
495 */
496 GoFx(kPoint16s*) GoProfilePointCloudMsg_At(GoProfilePointCloudMsg msg, kSize index);
497
498 /**
499 * Gets the exposure.
500 *
501 * @public @memberof GoProfilePointCloudMsg
502 * @version Introduced in firmware 4.8.1.70
503 * @param msg Message object.
504 * @return Exposure in uS.
505 */
506 GoFx(k32u) GoProfilePointCloudMsg_Exposure(GoProfilePointCloudMsg msg);
507
508
509 /**
510 * Gets the source camera index.
511 *
512 * @public @memberof GoProfilePointCloudMsg
513 * @version Introduced in firmware 4.8.1.70
514 * @param msg Message object.
515 * @return Camera index (0 - Front camera, 1 - Back camera).
516 */
517 GoFx(k8u) GoProfilePointCloudMsg_CameraIndex(GoProfilePointCloudMsg msg);
518
519
520 /**
521 * @class GoUniformProfileMsg
522 * @extends GoDataMsg
523 * @ingroup GoSdk-DataChannel
524 * @brief Represents a data message containing a set of re-sampled profile arrays.
525 */
526 typedef GoDataMsg GoUniformProfileMsg;
527
528 /**
529 * Gets the profile source.
530 *
531 * @public @memberof GoUniformProfileMsg
532 * @version Introduced in firmware 4.8.1.70
533 * @param msg Message object.
534 * @return Profile source.
535 */
536 GoFx(GoDataSource) GoUniformProfileMsg_Source(GoUniformProfileMsg msg);
537
538 /**
539 * Gets the count of re-sampled profile arrays in this message.
540 *
541 * @public @memberof GoUniformProfileMsg
542 * @version Introduced in firmware 4.8.1.70
543 * @param msg Message object.
544 * @return Count of profile arrays.
545 */
546 GoFx(kSize) GoUniformProfileMsg_Count(GoUniformProfileMsg msg);
547
548 /**
549 * Gets the count of points in each re-sampled profile array.
550 *
551 * @public @memberof GoUniformProfileMsg
552 * @version Introduced in firmware 4.8.1.70
553 * @param msg Message object.
554 * @return Point count.
555 */
556 GoFx(kSize) GoUniformProfileMsg_Width(GoUniformProfileMsg msg);
557
558 /**
559 * Gets the x-resolution, in nanometers.
560 *
561 * @public @memberof GoUniformProfileMsg
562 * @version Introduced in firmware 4.8.1.70
563 * @param msg Message object.
564 * @return X resolution (nm).
565 */
566 GoFx(k32u) GoUniformProfileMsg_XResolution(GoUniformProfileMsg msg);
567
568 /**
569 * Gets the profile z-resolution, in nanometers.
570 *
571 * @public @memberof GoUniformProfileMsg
572 * @version Introduced in firmware 4.8.1.70
573 * @param msg Message object.
574 * @return Z resolution (nm).
575 */
576 GoFx(k32u) GoUniformProfileMsg_ZResolution(GoUniformProfileMsg msg);
577
578 /**
579 * Gets the profile x-offset, in micrometers.
580 *
581 * @public @memberof GoUniformProfileMsg
582 * @version Introduced in firmware 4.8.1.70
583 * @param msg Message object.
584 * @return X offset (um).
585 */
586 GoFx(k32s) GoUniformProfileMsg_XOffset(GoUniformProfileMsg msg);
587
588 /**
589 * Gets the profile z-offset, in micrometers.
590 *
591 * @public @memberof GoUniformProfileMsg
592 * @version Introduced in firmware 4.8.1.70
593 * @param msg Message object.
594 * @return Z offset (um).
595 */
596 GoFx(k32s) GoUniformProfileMsg_ZOffset(GoUniformProfileMsg msg);
597
598 /**
599 * Gets a pointer to a re-sampled profile array.
600 *
601 * @public @memberof GoUniformProfileMsg
602 * @version Introduced in firmware 4.8.1.70
603 * @param msg Message object.
604 * @param index Profile array index.
605 * @return Data pointer.
606 */
607 GoFx(k16s*) GoUniformProfileMsg_At(GoUniformProfileMsg msg, kSize index);
608
609 /**
610 * Gets the exposure.
611 *
612 * @public @memberof GoUniformProfileMsg
613 * @version Introduced in firmware 4.8.1.70
614 * @param msg Message object.
615 * @return Exposure in uS.
616 */
617 GoFx(k32u) GoUniformProfileMsg_Exposure(GoUniformProfileMsg msg);
618
619 /**
620 * @class GoProfileIntensityMsg
621 * @extends GoDataMsg
622 * @ingroup GoSdk-DataChannel
623 * @brief Represents a data message containing a set of profile intensity arrays.
624 */
625 typedef GoDataMsg GoProfileIntensityMsg;
626
627 /**
628 * Gets the profile source.
629 *
630 * @public @memberof GoProfileIntensityMsg
631 * @version Introduced in firmware 4.0.10.27
632 * @param msg Message object.
633 * @return Profile source.
634 */
635 GoFx(GoDataSource) GoProfileIntensityMsg_Source(GoProfileIntensityMsg msg);
636
637 /**
638 * Gets the count of profile intensity arrays in this message.
639 *
640 * @public @memberof GoProfileIntensityMsg
641 * @version Introduced in firmware 4.0.10.27
642 * @param msg Message object.
643 * @return Count of profile arrays.
644 */
645 GoFx(kSize) GoProfileIntensityMsg_Count(GoProfileIntensityMsg msg);
646
647 /**
648 * Gets the count of intensity values in each profile intensity array.
649 *
650 * @public @memberof GoProfileIntensityMsg
651 * @version Introduced in firmware 4.0.10.27
652 * @param msg Message object.
653 * @return Intensity count.
654 */
655 GoFx(kSize) GoProfileIntensityMsg_Width(GoProfileIntensityMsg msg);
656
657 /**
658 * Gets the x-resolution, in nanometers.
659 *
660 * @public @memberof GoProfileIntensityMsg
661 * @version Introduced in firmware 4.0.10.27
662 * @param msg Message object.
663 * @return X resolution (nm).
664 */
665 GoFx(k32u) GoProfileIntensityMsg_XResolution(GoProfileIntensityMsg msg);
666
667 /**
668 * Gets the profile x-offset, in micrometers.
669 *
670 * @public @memberof GoProfileIntensityMsg
671 * @version Introduced in firmware 4.0.10.27
672 * @param msg Message object.
673 * @return X offset (um).
674 */
675 GoFx(k32s) GoProfileIntensityMsg_XOffset(GoProfileIntensityMsg msg);
676
677 /**
678 * Gets a pointer to a profile intensity array.
679 *
680 * @public @memberof GoProfileIntensityMsg
681 * @version Introduced in firmware 4.0.10.27
682 * @param msg Message object.
683 * @param index Profile intensity array index.
684 * @return Data pointer.
685 */
686 GoFx(k8u*) GoProfileIntensityMsg_At(GoProfileIntensityMsg msg, kSize index);
687
688 /**
689 * Gets the exposure.
690 *
691 * @public @memberof GoProfileIntensityMsg
692 * @version Introduced in firmware 4.0.10.27
693 * @param msg Message object.
694 * @return Exposure in uS.
695 */
696 GoFx(k32u) GoProfileIntensityMsg_Exposure(GoProfileIntensityMsg msg);
697
698 /**
699 * Gets the source camera index.
700 *
701 * @public @memberof GoProfileIntensityMsg
702 * @version Introduced in firmware 4.1.3.106
703 * @param msg Message object.
704 * @return Camera index (0 - Front camera, 1 - Back camera).
705 */
706 GoFx(k8u) GoProfileIntensityMsg_CameraIndex(GoProfileIntensityMsg msg);
707
708 /// @endcond
709
710 /// @cond (Gocator_2x00 || Gocator_3x00)
711 /**
712 * @class GoUniformSurfaceMsg
713 * @extends GoDataMsg
714 * @ingroup GoSdk-DataChannel
715 * @brief Represents a data message containing a surface array.
716 */
717 typedef GoDataMsg GoUniformSurfaceMsg;
718
719 /**
720 * Gets the profile source.
721 *
722 * @public @memberof GoUniformSurfaceMsg
723 * @version Introduced in firmware 4.8.1.70
724 * @param msg Message object.
725 * @return Profile source.
726 */
727 GoFx(GoDataSource) GoUniformSurfaceMsg_Source(GoUniformSurfaceMsg msg);
728
729 /**
730 * Gets the length of the surface (row count).
731 *
732 * @public @memberof GoUniformSurfaceMsg
733 * @version Introduced in firmware 4.8.1.70
734 * @param msg Message object.
735 * @return Surface length.
736 */
737 GoFx(kSize) GoUniformSurfaceMsg_Length(GoUniformSurfaceMsg msg);
738
739 /**
740 * Gets the width of the surface (column count).
741 *
742 * @public @memberof GoUniformSurfaceMsg
743 * @version Introduced in firmware 4.8.1.70
744 * @param msg Message object.
745 * @return Surface width;
746 */
747 GoFx(kSize) GoUniformSurfaceMsg_Width(GoUniformSurfaceMsg msg);
748
749 /**
750 * Gets the surface x-resolution, in nanometers.
751 *
752 * @public @memberof GoUniformSurfaceMsg
753 * @version Introduced in firmware 4.8.1.70
754 * @param msg Message object.
755 * @return X resolution (nm).
756 */
757 GoFx(k32u) GoUniformSurfaceMsg_XResolution(GoUniformSurfaceMsg msg);
758
759 /**
760 * Gets the surface y-resolution, in nanometers.
761 *
762 * @public @memberof GoUniformSurfaceMsg
763 * @version Introduced in firmware 4.8.1.70
764 * @param msg Message object.
765 * @return Y resolution (nm).
766 */
767 GoFx(k32u) GoUniformSurfaceMsg_YResolution(GoUniformSurfaceMsg msg);
768
769 /**
770 * Gets the surface z-resolution, in nanometers.
771 *
772 * @public @memberof GoUniformSurfaceMsg
773 * @version Introduced in firmware 4.8.1.70
774 * @param msg Message object.
775 * @return Z resolution (nm).
776 */
777 GoFx(k32u) GoUniformSurfaceMsg_ZResolution(GoUniformSurfaceMsg msg);
778
779 /**
780 * Gets the surface x-offset, in micrometers.
781 *
782 * @public @memberof GoUniformSurfaceMsg
783 * @version Introduced in firmware 4.8.1.70
784 * @param msg Message object.
785 * @return X offset (um).
786 */
787 GoFx(k32s) GoUniformSurfaceMsg_XOffset(GoUniformSurfaceMsg msg);
788
789 /**
790 * Gets the surface y-offset, in micrometers.
791 *
792 * @public @memberof GoUniformSurfaceMsg
793 * @version Introduced in firmware 4.8.1.70
794 * @param msg Message object.
795 * @return Y offset (um).
796 */
797 GoFx(k32s) GoUniformSurfaceMsg_YOffset(GoUniformSurfaceMsg msg);
798
799 /**
800 * Gets the surface z-offset, in micrometers.
801 *
802 * @public @memberof GoUniformSurfaceMsg
803 * @version Introduced in firmware 4.8.1.70
804 * @param msg Message object.
805 * @return Z offset (um).
806 */
807 GoFx(k32s) GoUniformSurfaceMsg_ZOffset(GoUniformSurfaceMsg msg);
808
809 /**
810 * Gets a pointer to a surface row.
811 *
812 * @public @memberof GoUniformSurfaceMsg
813 * @version Introduced in firmware 4.8.1.70
814 * @param msg Message object.
815 * @param index Surface row index.
816 * @return Row pointer.
817 */
818 GoFx(k16s*) GoUniformSurfaceMsg_RowAt(GoUniformSurfaceMsg msg, kSize index);
819
820 /**
821 * Gets the exposure.
822 *
823 * @public @memberof GoUniformSurfaceMsg
824 * @version Introduced in firmware 4.8.1.70
825 * @param msg Message object.
826 * @return Exposure in uS.
827 */
828 GoFx(k32u) GoUniformSurfaceMsg_Exposure(GoUniformSurfaceMsg msg);
829
830 /// @endcond
831
832 /// @cond (Gocator_3x00)
833 /**
834 * @class GoSurfacePointCloudMsg
835 * @extends GoDataMsg
836 * @ingroup GoSdk-DataChannel
837 * @brief Represents a data message containing a surface array.
838 */
839 typedef GoDataMsg GoSurfacePointCloudMsg;
840
841 /**
842 * Gets the profile source.
843 *
844 * @public @memberof GoSurfacePointCloudMsg
845 * @version Introduced in firmware 4.8.1.66
846 * @param msg Message object.
847 * @return Profile source.
848 */
849 GoFx(GoDataSource) GoSurfacePointCloudMsg_Source(GoSurfacePointCloudMsg msg);
850
851 /**
852 * Gets the length of the surface (row count).
853 *
854 * @public @memberof GoSurfacePointCloudMsg
855 * @version Introduced in firmware 4.8.1.66
856 * @param msg Message object.
857 * @return Surface length.
858 */
859 GoFx(kSize) GoSurfacePointCloudMsg_Length(GoSurfacePointCloudMsg msg);
860
861 /**
862 * Gets the width of the surface (column count).
863 *
864 * @public @memberof GoSurfacePointCloudMsg
865 * @version Introduced in firmware 4.8.1.66
866 * @param msg Message object.
867 * @return Surface width;
868 */
869 GoFx(kSize) GoSurfacePointCloudMsg_Width(GoSurfacePointCloudMsg msg);
870
871 /**
872 * Gets the surface x-resolution, in nanometers.
873 *
874 * @public @memberof GoSurfacePointCloudMsg
875 * @version Introduced in firmware 4.8.1.66
876 * @param msg Message object.
877 * @return X resolution (nm).
878 */
879 GoFx(k32u) GoSurfacePointCloudMsg_XResolution(GoSurfacePointCloudMsg msg);
880
881 /**
882 * Gets the surface y-resolution, in nanometers.
883 *
884 * @public @memberof GoSurfacePointCloudMsg
885 * @version Introduced in firmware 4.8.1.66
886 * @param msg Message object.
887 * @return Y resolution (nm).
888 */
889 GoFx(k32u) GoSurfacePointCloudMsg_YResolution(GoSurfacePointCloudMsg msg);
890
891 /**
892 * Gets the surface z-resolution, in nanometers.
893 *
894 * @public @memberof GoSurfacePointCloudMsg
895 * @version Introduced in firmware 4.8.1.66
896 * @param msg Message object.
897 * @return Z resolution (nm).
898 */
899 GoFx(k32u) GoSurfacePointCloudMsg_ZResolution(GoSurfacePointCloudMsg msg);
900
901 /**
902 * Gets the surface x-offset, in micrometers.
903 *
904 * @public @memberof GoSurfacePointCloudMsg
905 * @version Introduced in firmware 4.8.1.66
906 * @param msg Message object.
907 * @return X offset (um).
908 */
909 GoFx(k32s) GoSurfacePointCloudMsg_XOffset(GoSurfacePointCloudMsg msg);
910
911 /**
912 * Gets the surface y-offset, in micrometers.
913 *
914 * @public @memberof GoSurfacePointCloudMsg
915 * @version Introduced in firmware 4.8.1.66
916 * @param msg Message object.
917 * @return Y offset (um).
918 */
919 GoFx(k32s) GoSurfacePointCloudMsg_YOffset(GoSurfacePointCloudMsg msg);
920
921 /**
922 * Gets the surface z-offset, in micrometers.
923 *
924 * @public @memberof GoSurfacePointCloudMsg
925 * @version Introduced in firmware 4.8.1.66
926 * @param msg Message object.
927 * @return Z offset (um).
928 */
929 GoFx(k32s) GoSurfacePointCloudMsg_ZOffset(GoSurfacePointCloudMsg msg);
930
931 /**
932 * Gets a pointer to a surface row.
933 *
934 * @public @memberof GoSurfacePointCloudMsg
935 * @version Introduced in firmware 4.8.1.66
936 * @param msg Message object.
937 * @param index Surface row index.
938 * @return Row pointer.
939 */
940 GoFx(kPoint3d16s*) GoSurfacePointCloudMsg_RowAt(GoSurfacePointCloudMsg msg, kSize index);
941
942 /**
943 * Gets the exposure.
944 *
945 * @public @memberof GoSurfacePointCloudMsg
946 * @version Introduced in firmware 4.8.1.66
947 * @param msg Message object.
948 * @return Exposure in uS.
949 */
950 GoFx(k32u) GoSurfacePointCloudMsg_Exposure(GoSurfacePointCloudMsg msg);
951
952 /**
953 * Is the unresampled surface data adjacent/sorted?
954 *
955 * @public @memberof GoSurfacePointCloudMsg
956 * @version Introduced in firmware 4.8.0.100
957 * @param msg Message object.
958 * @return Is the data adjacent?
959 */
960 GoFx(kBool) GoSurfacePointCloudMsg_IsAdjacent(GoSurfacePointCloudMsg msg);
961
962 /**
963 * @class GoSurfaceIntensityMsg
964 * @extends GoDataMsg
965 * @ingroup GoSdk-DataChannel
966 * @brief Represents a data message containing a surface intensity array.
967 */
968 typedef GoDataMsg GoSurfaceIntensityMsg;
969
970 /**
971 * Gets the profile source.
972 *
973 * @public @memberof GoSurfaceIntensityMsg
974 * @version Introduced in firmware 4.0.10.27
975 * @param msg Message object.
976 * @return Profile source.
977 */
978 GoFx(GoDataSource) GoSurfaceIntensityMsg_Source(GoSurfaceIntensityMsg msg);
979
980 /**
981 * Gets the length of the surface (row count).
982 *
983 * @public @memberof GoSurfaceIntensityMsg
984 * @version Introduced in firmware 4.0.10.27
985 * @param msg Message object.
986 * @return Surface length.
987 */
988 GoFx(kSize) GoSurfaceIntensityMsg_Length(GoSurfaceIntensityMsg msg);
989
990 /**
991 * Gets the width of the surface (column count).
992 *
993 * @public @memberof GoSurfaceIntensityMsg
994 * @version Introduced in firmware 4.0.10.27
995 * @param msg Message object.
996 * @return Surface width;
997 */
998 GoFx(kSize) GoSurfaceIntensityMsg_Width(GoSurfaceIntensityMsg msg);
999
1000 /**
1001 * Gets the surface x-resolution, in nanometers.
1002 *
1003 * @public @memberof GoSurfaceIntensityMsg
1004 * @version Introduced in firmware 4.0.10.27
1005 * @param msg Message object.
1006 * @return X resolution (nm).
1007 */
1008 GoFx(k32u) GoSurfaceIntensityMsg_XResolution(GoSurfaceIntensityMsg msg);
1009
1010 /**
1011 * Gets the surface y-resolution, in nanometers.
1012 *
1013 * @public @memberof GoSurfaceIntensityMsg
1014 * @version Introduced in firmware 4.0.10.27
1015 * @param msg Message object.
1016 * @return Y resolution (nm).
1017 */
1018 GoFx(k32u) GoSurfaceIntensityMsg_YResolution(GoSurfaceIntensityMsg msg);
1019
1020 /**
1021 * Gets the surface x-offset, in micrometers.
1022 *
1023 * @public @memberof GoSurfaceIntensityMsg
1024 * @version Introduced in firmware 4.0.10.27
1025 * @param msg Message object.
1026 * @return X offset (um).
1027 */
1028 GoFx(k32s) GoSurfaceIntensityMsg_XOffset(GoSurfaceIntensityMsg msg);
1029
1030 /**
1031 * Gets the surface y-offset, in micrometers.
1032 *
1033 * @public @memberof GoSurfaceIntensityMsg
1034 * @version Introduced in firmware 4.0.10.27
1035 * @param msg Message object.
1036 * @return Y offset (um).
1037 */
1038 GoFx(k32s) GoSurfaceIntensityMsg_YOffset(GoSurfaceIntensityMsg msg);
1039
1040 /**
1041 * Gets a pointer to a surface intensity row.
1042 *
1043 * @public @memberof GoSurfaceIntensityMsg
1044 * @version Introduced in firmware 4.0.10.27
1045 * @param msg Message object.
1046 * @param index Surface intensity row index.
1047 * @return Data pointer.
1048 */
1049 GoFx(k8u*) GoSurfaceIntensityMsg_RowAt(GoSurfaceIntensityMsg msg, kSize index);
1050
1051 /**
1052 * Gets the exposure.
1053 *
1054 * @public @memberof GoSurfaceIntensityMsg
1055 * @version Introduced in firmware 4.0.10.27
1056 * @param msg Message object.
1057 * @return Exposure in uS.
1058 */
1059 GoFx(k32u) GoSurfaceIntensityMsg_Exposure(GoSurfaceIntensityMsg msg);
1060
1061
1062 /**
1063 * @class GoSectionMsg
1064 * @extends GoDataMsg
1065 * @ingroup GoSdk-DataChannel
1066 * @brief Represents a data message containing a set of section arrays.
1067 */
1068 typedef GoDataMsg GoSectionMsg;
1069
1070 /**
1071 * Gets the section ID.
1072 *
1073 * @public @memberof GoSectionMsg
1074 * @version Introduced in firmware 4.4.4.14
1075 * @param msg Message object.
1076 * @return Section ID.
1077 */
1078 GoFx(k32u) GoSectionMsg_Id(GoSectionMsg msg);
1079
1080 /**
1081 * Gets the section source.
1082 *
1083 * @public @memberof GoSectionMsg
1084 * @version Introduced in firmware 4.4.4.14
1085 * @param msg Message object.
1086 * @return Section source.
1087 */
1088 GoFx(GoDataSource) GoSectionMsg_Source(GoSectionMsg msg);
1089
1090 /**
1091 * Gets the count of section arrays in this message.
1092 *
1093 * @public @memberof GoSectionMsg
1094 * @version Introduced in firmware 4.4.4.14
1095 * @param msg Message object.
1096 * @return Count of section arrays.
1097 */
1098 GoFx(kSize) GoSectionMsg_Count(GoSectionMsg msg);
1099
1100 /**
1101 * Gets the count of points in each section array.
1102 *
1103 * @public @memberof GoSectionMsg
1104 * @version Introduced in firmware 4.4.4.14
1105 * @param msg Message object.
1106 * @return Point count.
1107 */
1108 GoFx(kSize) GoSectionMsg_Width(GoSectionMsg msg);
1109
1110 /**
1111 * Gets the x-resolution, in nanometers.
1112 *
1113 * @public @memberof GoSectionMsg
1114 * @version Introduced in firmware 4.4.4.14
1115 * @param msg Message object.
1116 * @return X resolution (nm).
1117 */
1118 GoFx(k32u) GoSectionMsg_XResolution(GoSectionMsg msg);
1119
1120 /**
1121 * Gets the z-resolution, in nanometers.
1122 *
1123 * @public @memberof GoSectionMsg
1124 * @version Introduced in firmware 4.4.4.14
1125 * @param msg Message object.
1126 * @return Z resolution (nm).
1127 */
1128 GoFx(k32u) GoSectionMsg_ZResolution(GoSectionMsg msg);
1129
1130 /**
1131 * Gets the X-Pose, in micrometers.
1132 *
1133 * @public @memberof GoSectionMsg
1134 * @version Introduced in firmware 4.4.4.14
1135 * @param msg Message object.
1136 * @return X Pose (um).
1137 */
1138 GoFx(k32s) GoSectionMsg_XPose(GoSectionMsg msg);
1139
1140 /**
1141 * Gets the Y-Pose, in micrometers.
1142 *
1143 * @public @memberof GoSectionMsg
1144 * @version Introduced in firmware 4.4.4.14
1145 * @param msg Message object.
1146 * @return Y Pose (um).
1147 */
1148 GoFx(k32s) GoSectionMsg_YPose(GoSectionMsg msg);
1149
1150 /**
1151 * Gets the Pose Angle, in microdegrees.
1152 *
1153 * @public @memberof GoSectionMsg
1154 * @version Introduced in firmware 4.4.4.14
1155 * @param msg Message object.
1156 * @return Angle Pose (microdegrees).
1157 */
1158 GoFx(k32s) GoSectionMsg_AnglePose(GoSectionMsg msg);
1159
1160 /**
1161 * Gets the x-offset, in micrometers.
1162 *
1163 * @public @memberof GoSectionMsg
1164 * @version Introduced in firmware 4.4.4.14
1165 * @param msg Message object.
1166 * @return X offset (um).
1167 */
1168 GoFx(k32s) GoSectionMsg_XOffset(GoSectionMsg msg);
1169
1170 /**
1171 * Gets the z-offset, in micrometers.
1172 *
1173 * @public @memberof GoSectionMsg
1174 * @version Introduced in firmware 4.4.4.14
1175 * @param msg Message object.
1176 * @return Z offset (um).
1177 */
1178 GoFx(k32s) GoSectionMsg_ZOffset(GoSectionMsg msg);
1179
1180 /**
1181 * Gets a pointer to a section array.
1182 *
1183 * @public @memberof GoSectionMsg
1184 * @version Introduced in firmware 4.4.4.14
1185 * @param msg Message object.
1186 * @param index Section array index.
1187 * @return Data pointer.
1188 */
1189 GoFx(k16s*) GoSectionMsg_At(GoSectionMsg msg, kSize index);
1190
1191 /**
1192 * Gets the exposure.
1193 *
1194 * @public @memberof GoSectionMsg
1195 * @version Introduced in firmware 4.4.4.14
1196 * @param msg Message object.
1197 * @return Exposure in uS.
1198 */
1199 GoFx(k32u) GoSectionMsg_Exposure(GoSectionMsg msg);
1200
1201
1202 /**
1203 * @class GoSectionIntensityMsg
1204 * @extends GoDataMsg
1205 * @ingroup GoSdk-DataChannel
1206 * @brief Represents a data message containing a set of profile intensity arrays.
1207 */
1208 typedef GoDataMsg GoSectionIntensityMsg;
1209
1210 /**
1211 * Gets the section ID.
1212 *
1213 * @public @memberof GoSectionIntensityMsg
1214 * @version Introduced in firmware 4.4.4.14
1215 * @param msg Message object.
1216 * @return Section ID.
1217 */
1218 GoFx(k32u) GoSectionIntensityMsg_Id(GoSectionIntensityMsg msg);
1219
1220 /**
1221 * Gets the section source.
1222 *
1223 * @public @memberof GoSectionIntensityMsg
1224 * @version Introduced in firmware 4.4.4.14
1225 * @param msg Message object.
1226 * @return Section source.
1227 */
1228 GoFx(GoDataSource) GoSectionIntensityMsg_Source(GoSectionIntensityMsg msg);
1229
1230 /**
1231 * Gets the count of section arrays in this message.
1232 *
1233 * @public @memberof GoSectionIntensityMsg
1234 * @version Introduced in firmware 4.4.4.14
1235 * @param msg Message object.
1236 * @return Count of section arrays.
1237 */
1238 GoFx(kSize) GoSectionIntensityMsg_Count(GoSectionIntensityMsg msg);
1239
1240 /**
1241 * Gets the count of points in each section array.
1242 *
1243 * @public @memberof GoSectionIntensityMsg
1244 * @version Introduced in firmware 4.4.4.14
1245 * @param msg Message object.
1246 * @return Point count.
1247 */
1248 GoFx(kSize) GoSectionIntensityMsg_Width(GoSectionIntensityMsg msg);
1249
1250 /**
1251 * Gets the x-resolution, in nanometers.
1252 *
1253 * @public @memberof GoSectionIntensityMsg
1254 * @version Introduced in firmware 4.4.4.14
1255 * @param msg Message object.
1256 * @return X resolution (nm).
1257 */
1258 GoFx(k32u) GoSectionIntensityMsg_XResolution(GoSectionIntensityMsg msg);
1259
1260 /**
1261 * Gets the X-Pose, in micrometers.
1262 *
1263 * @public @memberof GoSectionIntensityMsg
1264 * @version Introduced in firmware 4.4.4.14
1265 * @param msg Message object.
1266 * @return X Pose (um).
1267 */
1268 GoFx(k32s) GoSectionIntensityMsg_XPose(GoSectionIntensityMsg msg);
1269
1270 /**
1271 * Gets the Y-Pose, in micrometers.
1272 *
1273 * @public @memberof GoSectionIntensityMsg
1274 * @version Introduced in firmware 4.4.4.14
1275 * @param msg Message object.
1276 * @return Y Pose (um).
1277 */
1278 GoFx(k32s) GoSectionIntensityMsg_YPose(GoSectionIntensityMsg msg);
1279
1280 /**
1281 * Gets the Pose Angle, in microdegrees.
1282 *
1283 * @public @memberof GoSectionIntensityMsg
1284 * @version Introduced in firmware 4.4.4.14
1285 * @param msg Message object.
1286 * @return Angle Pose (microdegrees).
1287 */
1288 GoFx(k32s) GoSectionIntensityMsg_AnglePose(GoSectionIntensityMsg msg);
1289
1290 /**
1291 * Gets the x-offset, in micrometers.
1292 *
1293 * @public @memberof GoSectionIntensityMsg
1294 * @version Introduced in firmware 4.4.4.14
1295 * @param msg Message object.
1296 * @return X offset (um).
1297 */
1298 GoFx(k32s) GoSectionIntensityMsg_XOffset(GoSectionIntensityMsg msg);
1299
1300 /**
1301 * Gets a pointer to a Section intensity array.
1302 *
1303 * @public @memberof GoSectionIntensityMsg
1304 * @version Introduced in firmware 4.4.4.14
1305 * @param msg Message object.
1306 * @param index Section intensity array index.
1307 * @return Data pointer.
1308 */
1309 GoFx(k8u*) GoSectionIntensityMsg_At(GoSectionIntensityMsg msg, kSize index);
1310
1311 /**
1312 * Gets the exposure.
1313 *
1314 * @public @memberof GoSectionIntensityMsg
1315 * @version Introduced in firmware 4.4.4.14
1316 * @param msg Message object.
1317 * @return Exposure in uS.
1318 */
1319 GoFx(k32u) GoSectionIntensityMsg_Exposure(GoSectionIntensityMsg msg);
1320
1321 /// @endcond
1322
1323
1324 /**
1325 * @struct GoMeasurementData
1326 * @extends kValue
1327 * @ingroup GoSdk-DataChannel
1328 * @brief Represents a measurement result.
1329 */
1330 typedef struct GoMeasurementData
1331 {
1332 k64f value; ///< Measurement value.
1333 GoDecision decision; ///< Measurement decision value.
1334 GoDecisionCode decisionCode; ///< Measurement decision code - relevant only when the value represents a failure.
1335 } GoMeasurementData;
1336
1337 /**
1338 * @class GoMeasurementMsg
1339 * @extends GoDataMsg
1340 * @ingroup GoSdk-DataChannel
1341 * @brief Represents a message containing a set of GoMeasurementData.
1342 */
1343 typedef GoDataMsg GoMeasurementMsg;
1344
1345 /**
1346 * Gets the measurement identifier.
1347 *
1348 * @public @memberof GoMeasurementMsg
1349 * @version Introduced in firmware 4.0.10.27
1350 * @param msg Message object.
1351 * @return Measurement identifier.
1352 */
1353 GoFx(k16u) GoMeasurementMsg_Id(GoMeasurementMsg msg);
1354
1355 /**
1356 * Count of measurements in this message.
1357 *
1358 * @public @memberof GoMeasurementMsg
1359 * @version Introduced in firmware 4.0.10.27
1360 * @param msg Message object.
1361 * @return Count of measurements.
1362 */
1363 GoFx(kSize) GoMeasurementMsg_Count(GoMeasurementMsg msg);
1364
1365 /**
1366 * Gets the measurement at the specified index.
1367 *
1368 * @public @memberof GoMeasurementMsg
1369 * @version Introduced in firmware 4.0.10.27
1370 * @param msg Message object.
1371 * @param index Measurement index.
1372 * @return Measurement pointer.
1373 */
1374 GoFx(GoMeasurementData*) GoMeasurementMsg_At(GoMeasurementMsg msg, kSize index);
1375
1376
1377 /**
1378 * @class GoAlignMsg
1379 * @extends GoDataMsg
1380 * @ingroup GoSdk-DataChannel
1381 * @brief Represents a message containing an alignment result.
1382 */
1383 typedef GoDataMsg GoAlignMsg;
1384
1385 /**
1386 * Gets the alignment result.
1387 *
1388 * @public @memberof GoAlignMsg
1389 * @version Introduced in firmware 4.0.10.27
1390 * @param msg Message object.
1391 * @return Alignment result.
1392 */
1393 GoFx(kStatus) GoAlignMsg_Status(GoAlignMsg msg);
1394
1395 /**
1396 * @class GoExposureCalMsg
1397 * @extends GoDataMsg
1398 * @ingroup GoSdk-DataChannel
1399 * @brief Represents a message containing exposure calibration results.
1400 */
1401 typedef GoDataMsg GoExposureCalMsg;
1402
1403 /**
1404 * Gets the exposure calibration result.
1405 *
1406 * @public @memberof GoExposureCalMsg
1407 * @version Introduced in firmware 4.0.10.27
1408 * @param msg Message object.
1409 * @return Exposure calibration result.
1410 */
1411 GoFx(kStatus) GoExposureCalMsg_Status(GoExposureCalMsg msg);
1412
1413 /**
1414 * Gets the calibrated exposure.
1415 *
1416 * @public @memberof GoExposureCalMsg
1417 * @version Introduced in firmware 4.0.10.27
1418 * @param msg Message object.
1419 * @return Calibrated exposure value in uS if the result is kOK.
1420 */
1421 GoFx(k64f) GoExposureCalMsg_Exposure(GoExposureCalMsg msg);
1422
1423
1424 /**
1425 * @class GoEdgeMatchMsg
1426 * @extends GoDataMsg
1427 * @ingroup GoSdk-DataChannel
1428 * @brief Represents a message containing edge based part matching results.
1429 */
1430 typedef GoDataMsg GoEdgeMatchMsg;
1431
1432 /**
1433 * Gets the edge match decision.
1434 *
1435 * @public @memberof GoEdgeMatchMsg
1436 * @version Introduced in firmware 4.2.4.7
1437 * @param msg Message object.
1438 * @return Edge match decision.
1439 */
1440 GoFx(k8u) GoEdgeMatchMsg_Decision(GoEdgeMatchMsg msg);
1441
1442 /**
1443 * Gets the edge match X offset.
1444 *
1445 * @public @memberof GoEdgeMatchMsg
1446 * @version Introduced in firmware 4.2.4.7
1447 * @param msg Message object.
1448 * @return Edge match X offset.
1449 */
1450 GoFx(k64f) GoEdgeMatchMsg_XOffset(GoEdgeMatchMsg msg);
1451
1452 /**
1453 * Gets the edge match Y offset.
1454 *
1455 * @public @memberof GoEdgeMatchMsg
1456 * @version Introduced in firmware 4.2.4.7
1457 * @param msg Message object.
1458 * @return Edge match Y offset.
1459 */
1460 GoFx(k64f) GoEdgeMatchMsg_YOffset(GoEdgeMatchMsg msg);
1461
1462 /**
1463 * Gets the edge match Z angle.
1464 *
1465 * @public @memberof GoEdgeMatchMsg
1466 * @version Introduced in firmware 4.2.4.7
1467 * @param msg Message object.
1468 * @return Edge match Z angle.
1469 */
1470 GoFx(k64f) GoEdgeMatchMsg_ZAngle(GoEdgeMatchMsg msg);
1471
1472 /**
1473 * Gets the edge match quality value.
1474 *
1475 * @public @memberof GoEdgeMatchMsg
1476 * @version Introduced in firmware 4.2.4.7
1477 * @param msg Message object.
1478 * @return Edge match quality value.
1479 */
1480 GoFx(k64f) GoEdgeMatchMsg_QualityValue(GoEdgeMatchMsg msg);
1481
1482 /**
1483 * Gets the edge match quality decision.
1484 *
1485 * @public @memberof GoEdgeMatchMsg
1486 * @version Introduced in firmware 4.2.4.7
1487 * @param msg Message object.
1488 * @return Edge match quality decision.
1489 */
1490 GoFx(k8u) GoEdgeMatchMsg_QualityDecision(GoEdgeMatchMsg msg);
1491
1492
1493 /**
1494 * @class GoEllipseMatchMsg
1495 * @extends GoDataMsg
1496 * @ingroup GoSdk-DataChannel
1497 * @brief Represents a message containing ellipse based part matching results.
1498 */
1499 typedef GoDataMsg GoEllipseMatchMsg;
1500
1501 /**
1502 * Gets the ellipse match decision.
1503 *
1504 * @public @memberof GoEllipseMatchMsg
1505 * @version Introduced in firmware 4.2.4.7
1506 * @param msg Message object.
1507 * @return Ellipse match quality decision.
1508 */
1509 GoFx(k8u) GoEllipseMatchMsg_Decision(GoEllipseMatchMsg msg);
1510
1511 /**
1512 * Gets the ellipse match X offset.
1513 *
1514 * @public @memberof GoEllipseMatchMsg
1515 * @version Introduced in firmware 4.2.4.7
1516 * @param msg Message object.
1517 * @return Ellipse match X offset.
1518 */
1519 GoFx(k64f) GoEllipseMatchMsg_XOffset(GoEllipseMatchMsg msg);
1520
1521 /**
1522 * Gets the ellipse match Y offset.
1523 *
1524 * @public @memberof GoEllipseMatchMsg
1525 * @version Introduced in firmware 4.2.4.7
1526 * @param msg Message object.
1527 * @return Ellipse match Y offset.
1528 */
1529 GoFx(k64f) GoEllipseMatchMsg_YOffset(GoEllipseMatchMsg msg);
1530
1531 /**
1532 * Gets the ellipse match Z angle.
1533 *
1534 * @public @memberof GoEllipseMatchMsg
1535 * @version Introduced in firmware 4.2.4.7
1536 * @param msg Message object.
1537 * @return Ellipse match Z angle.
1538 */
1539 GoFx(k64f) GoEllipseMatchMsg_ZAngle(GoEllipseMatchMsg msg);
1540
1541 /**
1542 * Gets the ellipse match minor value.
1543 *
1544 * @public @memberof GoEllipseMatchMsg
1545 * @version Introduced in firmware 4.2.4.7
1546 * @param msg Message object.
1547 * @return Ellipse match minor value.
1548 */
1549 GoFx(k64f) GoEllipseMatchMsg_MinorValue(GoEllipseMatchMsg msg);
1550
1551 /**
1552 * Gets the ellipse match minor decision.
1553 *
1554 * @public @memberof GoEllipseMatchMsg
1555 * @version Introduced in firmware 4.2.4.7
1556 * @param msg Message object.
1557 * @return Ellipse match minor decision.
1558 */
1559 GoFx(k8u) GoEllipseMatchMsg_MinorDecision(GoEllipseMatchMsg msg);
1560
1561 /**
1562 * Gets the ellipse match major value.
1563 *
1564 * @public @memberof GoEllipseMatchMsg
1565 * @version Introduced in firmware 4.2.4.7
1566 * @param msg Message object.
1567 * @return Ellipse match major value.
1568 */
1569 GoFx(k64f) GoEllipseMatchMsg_MajorValue(GoEllipseMatchMsg msg);
1570
1571 /**
1572 * Gets the ellipse match major decision.
1573 *
1574 * @public @memberof GoEllipseMatchMsg
1575 * @version Introduced in firmware 4.2.4.7
1576 * @param msg Message object.
1577 * @return Ellipse match major decision.
1578 */
1579 GoFx(k8u) GoEllipseMatchMsg_MajorDecision(GoEllipseMatchMsg msg);
1580
1581
1582 /**
1583 * @class GoBoundingBoxMatchMsg
1584 * @extends GoDataMsg
1585 * @ingroup GoSdk-DataChannel
1586 * @brief Represents a message containing bounding box based part matching results.
1587 */
1588 typedef GoDataMsg GoBoundingBoxMatchMsg;
1589
1590 /**
1591 * Gets the bounding box match major value.
1592 *
1593 * @public @memberof GoBoundingBoxMatchMsg
1594 * @version Introduced in firmware 4.2.4.7
1595 * @param msg Message object.
1596 * @return Bounding box match major value.
1597 */
1598 GoFx(k8u) GoBoundingBoxMatchMsg_Decision(GoBoundingBoxMatchMsg msg);
1599
1600 /**
1601 * Gets the bounding box match X offset.
1602 *
1603 * @public @memberof GoBoundingBoxMatchMsg
1604 * @version Introduced in firmware 4.2.4.7
1605 * @param msg Message object.
1606 * @return Bounding box match X offset.
1607 */
1608 GoFx(k64f) GoBoundingBoxMatchMsg_XOffset(GoBoundingBoxMatchMsg msg);
1609
1610 /**
1611 * Gets the bounding box match Y offset.
1612 *
1613 * @public @memberof GoBoundingBoxMatchMsg
1614 * @version Introduced in firmware 4.2.4.7
1615 * @param msg Message object.
1616 * @return Bounding box match Y offset.
1617 */
1618 GoFx(k64f) GoBoundingBoxMatchMsg_YOffset(GoBoundingBoxMatchMsg msg);
1619
1620 /**
1621 * Gets the bounding box match Z angle.
1622 *
1623 * @public @memberof GoBoundingBoxMatchMsg
1624 * @version Introduced in firmware 4.2.4.7
1625 * @param msg Message object.
1626 * @return Bounding box match Z angle.
1627 */
1628 GoFx(k64f) GoBoundingBoxMatchMsg_ZAngle(GoBoundingBoxMatchMsg msg);
1629
1630 /**
1631 * Gets the bounding box match length value.
1632 *
1633 * @public @memberof GoBoundingBoxMatchMsg
1634 * @version Introduced in firmware 4.2.4.7
1635 * @param msg Message object.
1636 * @return Bounding box match length value.
1637 */
1638 GoFx(k64f) GoBoundingBoxMatchMsg_LengthValue(GoBoundingBoxMatchMsg msg);
1639
1640 /**
1641 * Gets the bounding box match length decision.
1642 *
1643 * @public @memberof GoBoundingBoxMatchMsg
1644 * @version Introduced in firmware 4.2.4.7
1645 * @param msg Message object.
1646 * @return Bounding box match length decision.
1647 */
1648 GoFx(k8u) GoBoundingBoxMatchMsg_LengthDecision(GoBoundingBoxMatchMsg msg);
1649
1650 /**
1651 * Gets the bounding box match width value.
1652 *
1653 * @public @memberof GoBoundingBoxMatchMsg
1654 * @version Introduced in firmware 4.2.4.7
1655 * @param msg Message object.
1656 * @return Bounding box match width value.
1657 */
1658 GoFx(k64f) GoBoundingBoxMatchMsg_WidthValue(GoBoundingBoxMatchMsg msg);
1659
1660 /**
1661 * Gets the bounding box match width decision.
1662 *
1663 * @public @memberof GoBoundingBoxMatchMsg
1664 * @version Introduced in firmware 4.2.4.7
1665 * @param msg Message object.
1666 * @return Bounding box match width decision.
1667 */
1668 GoFx(k8u) GoBoundingBoxMatchMsg_WidthDecision(GoBoundingBoxMatchMsg msg);
1669
1670
1671 /**
1672 * @class GoEventMsg
1673 * @extends GoDataMsg
1674 * @ingroup GoSdk-DataChannel
1675 * @brief Represents a message containing an event (See GoEventType).
1676 */
1677 typedef GoDataMsg GoEventMsg;
1678
1679 /**
1680 * Gets the event type.
1681 *
1682 * @public @memberof GoEventMsg
1683 * @version Introduced in firmware 4.5.3.57
1684 * @param msg Message object.
1685 * @return Event type.
1686 */
1687 GoFx(GoEventType) GoEventMsg_Type(GoEventMsg msg);
1688
1689
1690 /**
1691 * @class GoTracheidMsg
1692 * @extends GoDataMsg
1693 * @ingroup GoSdk-DataChannel
1694 * @brief Represents a data message containing a set of tracheid data.
1695 */
1696 typedef GoDataMsg GoTracheidMsg;
1697
1698 /**
1699 * @struct GoTracheidEllipse
1700 * @extends kValue
1701 * @ingroup GoSdk-DataChannel
1702 * @brief Represents a tracheid ellipse.
1703 */
1704 typedef struct GoTracheidEllipse
1705 {
1706 k64f area; ///< Ellipse area
1707 k64f angle; ///< Ellipse angle
1708 k64f scatter; ///< Ellipse scatter
1709 k64f minor; ///< Ellipse minor
1710 k64f major; ///< Ellipse major
1711
1712 } GoTracheidEllipse;
1713
1714 /**
1715 * Gets the tracheid source.
1716 *
1717 * @public @memberof GoTracheidMsg
1718 * @version Introduced in firmware 4.5.3.57
1719 * @param msg Message object.
1720 * @return Tracheid source.
1721 */
1722 GoFx(GoDataSource) GoTracheidMsg_Source(GoTracheidMsg msg);
1723
1724 /**
1725 * Gets the count of tracheid arrays in this message.
1726 *
1727 * @public @memberof GoTracheidMsg
1728 * @version Introduced in firmware 4.6.4.66
1729 * @param msg Message object.
1730 * @return Count of tracheid arrays.
1731 */
1732 GoFx(kSize) GoTracheidMsg_Count(GoTracheidMsg msg);
1733
1734 /**
1735 * Gets the count of ellipses in each tracheid array.
1736 *
1737 * @public @memberof GoTracheidMsg
1738 * @version Introduced in firmware 4.6.4.66
1739 * @param msg Message object.
1740 * @return Ellipse count.
1741 */
1742 GoFx(kSize) GoTracheidMsg_Width(GoTracheidMsg msg);
1743
1744 /**
1745 * Gets the tracheid camera index.
1746 *
1747 * @public @memberof GoTracheidMsg
1748 * @version Introduced in firmware 4.5.3.57
1749 * @param msg Message object.
1750 * @return Tracheid camera index.
1751 */
1752 GoFx(k8u) GoTracheidMsg_CameraIndex(GoTracheidMsg msg);
1753
1754 /**
1755 * Gets a pointer to a tracheid ellipse array.
1756 *
1757 * @public @memberof GoTracheidMsg
1758 * @version Introduced in firmware 4.6.4.66
1759 * @param msg Message object.
1760 * @param index Tracheid ellipse array index.
1761 * @return Tracheid ellipse array.
1762 */
1763 GoFx(GoTracheidEllipse*) GoTracheidMsg_At(GoTracheidMsg msg, kSize index);
1764
1765 /**
1766 * @class GoPointFeatureMsg
1767 * @extends GoDataMsg
1768 * @ingroup GoSdk-DataChannel
1769 * @brief Represents a message containing Point Feature data.
1770 */
1771 typedef GoDataMsg GoPointFeatureMsg;
1772
1773 /**
1774 * Gets the point feature identifier.
1775 *
1776 * @public @memberof GoPointFeatureMsg
1777 * @version Introduced in firmware 4.6.3.43
1778 * @param msg Message object.
1779 * @return Point Feature identifier.
1780 */
1781 GoFx(k16u) GoPointFeatureMsg_Id(GoPointFeatureMsg msg);
1782
1783 /**
1784 * The point data in this message.
1785 *
1786 * @public @memberof GoPointFeatureMsg
1787 * @version Introduced in firmware 4.6.3.43
1788 * @param msg Message object.
1789 * @return Corrdinates of point feature in nanometers.
1790 */
1791 GoFx(kPoint3d64f) GoPointFeatureMsg_Position(GoPointFeatureMsg msg);
1792
1793 /**
1794 * @class GoLineFeatureMsg
1795 * @extends GoDataMsg
1796 * @ingroup GoSdk-DataChannel
1797 * @brief Represents a message containing Linear Feature data.
1798 */
1799 typedef GoDataMsg GoLineFeatureMsg;
1800
1801 /**
1802 * Gets the linear feature identifier.
1803 *
1804 * @public @memberof GoLineFeatureMsg
1805 * @version Introduced in firmware 4.6.3.43
1806 * @param msg Message object.
1807 * @return Line Feature identifier.
1808 */
1809 GoFx(k16u) GoLineFeatureMsg_Id(GoLineFeatureMsg msg);
1810
1811 /**
1812 * Gets a point on the linear feature.
1813 *
1814 * @public @memberof GoLineFeatureMsg
1815 * @version Introduced in firmware 4.6.3.43
1816 * @param msg Message object.
1817 * @return Position of the linear feature in nanometers.
1818 */
1819 GoFx(kPoint3d64f) GoLineFeatureMsg_Position(GoLineFeatureMsg msg);
1820
1821 /**
1822 * The direction vector of the linear feature.
1823 *
1824 * @public @memberof GoLineFeatureMsg
1825 * @version Introduced in firmware 4.6.3.43
1826 * @param msg Message object.
1827 * @return Direction of the linear feature.
1828 */
1829 GoFx(kPoint3d64f) GoLineFeatureMsg_Direction(GoLineFeatureMsg msg);
1830
1831 /**
1832 * @class GoPlaneFeatureMsg
1833 * @extends GoDataMsg
1834 * @ingroup GoSdk-DataChannel
1835 * @brief Represents a message containing Planear Feature data.
1836 */
1837 typedef GoDataMsg GoPlaneFeatureMsg;
1838
1839 /**
1840 * Gets the planear feature identifier.
1841 *
1842 * @public @memberof GoPlaneFeatureMsg
1843 * @version Introduced in firmware 4.6.3.43
1844 * @param msg Message object.
1845 * @return Plane Feature identifier.
1846 */
1847 GoFx(k16u) GoPlaneFeatureMsg_Id(GoPlaneFeatureMsg msg);
1848
1849 /**
1850 * Gets the normal vector of the planear feature.
1851 *
1852 * @public @memberof GoPlaneFeatureMsg
1853 * @version Introduced in firmware 4.6.3.43
1854 * @param msg Message object.
1855 * @return The vector normal to the plane.
1856 */
1857 GoFx(kPoint3d64f) GoPlaneFeatureMsg_Normal(GoPlaneFeatureMsg msg);
1858
1859 /**
1860 * Gets shortest distance from the origin to the plane. Is parallel to the normal vector.
1861 *
1862 * @public @memberof GoPlaneFeatureMsg
1863 * @version Introduced in firmware 4.6.3.43
1864 * @param msg Message object.
1865 * @return Shortest distance to the origin in nanometers.
1866 */
1867 GoFx(k64f) GoPlaneFeatureMsg_DistanceToOrigin(GoPlaneFeatureMsg msg);
1868
1869 /**
1870 * @class GoCircleFeatureMsg
1871 * @extends GoDataMsg
1872 * @ingroup GoSdk-DataChannel
1873 * @brief Represents a message containing circular feature data.
1874 */
1875 typedef GoDataMsg GoCircleFeatureMsg;
1876
1877 /**
1878 * Gets the circular feature identifier.
1879 *
1880 * @public @memberof GoCircleFeatureMsg
1881 * @version Introduced in firmware 4.6.3.43
1882 * @param msg Message object.
1883 * @return Circle Feature identifier.
1884 */
1885 GoFx(k16u) GoCircleFeatureMsg_Id(GoCircleFeatureMsg msg);
1886
1887 /**
1888 * Gets the position of the center of the circular feature.
1889 *
1890 * @public @memberof GoCircleFeatureMsg
1891 * @version Introduced in firmware 4.6.3.43
1892 * @param msg Message object.
1893 * @return Position of the circular feature in nanometers
1894 */
1895 GoFx(kPoint3d64f) GoCircleFeatureMsg_Position(GoCircleFeatureMsg msg);
1896
1897 /**
1898 * Gets the normal vector of the circular feature.
1899 *
1900 * @public @memberof GoCircleFeatureMsg
1901 * @version Introduced in firmware 4.6.3.43
1902 * @param msg Message object.
1903 * @return The vector normal to the plane.
1904 */
1905 GoFx(kPoint3d64f) GoCircleFeatureMsg_Normal(GoCircleFeatureMsg msg);
1906
1907 /**
1908 * Gets the radius of the circular feature.
1909 *
1910 * @public @memberof GoCircleFeatureMsg
1911 * @version Introduced in firmware 4.6.3.43
1912 * @param msg Message object.
1913 * @return Radius of the circle in nanometers.
1914 */
1915 GoFx(k64f) GoCircleFeatureMsg_Radius(GoCircleFeatureMsg msg);
1916
1917 /**
1918 * @class GoGenericMsg
1919 * @extends GoDataMsg
1920 * @ingroup GoSdk-DataChannel
1921 * @brief Represents a data message containing generic data.
1922 *
1923 * A generic message may contain either a raw byte buffer, or a kObject.
1924 * If the content is a kObject, then the buffer contains the byte stream containing
1925 * the serialized object, using the standard serialization schem (kDat6).
1926 */
1927 typedef GoDataMsg GoGenericMsg;
1928
1929 /**
1930 * Gets the user defined data type.
1931 *
1932 * @public @memberof GoGenericMsg
1933 * @version Introduced in firmware 5.2.18.3
1934 * @param msg Message object.
1935 * @return Type ID.
1936 */
1937 GoFx(k32u) GoGenericMsg_UserType(GoGenericMsg msg);
1938
1939 /**
1940 * Returns whether or not the content is an kObject. If false,
1941 * the content is a raw byte buffer.
1942 *
1943 * @public @memberof GoGenericMsg
1944 * @version Introduced in firmware 5.2.18.3
1945 * @param msg Message object.
1946 * @return kTRUE if content is kObject. kFALSE if raw buffer.
1947 */
1948 GoFx(kBool) GoGenericMsg_IsObject(GoGenericMsg msg);
1949
1950 /**
1951 * Returns the size of the raw buffer.
1952 *
1953 * @public @memberof GoGenericMsg
1954 * @version Introduced in firmware 5.2.18.3
1955 * @param msg Message object.
1956 * @return Size of the buffer in bytes.
1957 */
1958 GoFx(kSize) GoGenericMsg_BufferSize(GoGenericMsg msg);
1959
1960 /**
1961 * Returns a pointer to the raw buffer.
1962 *
1963 * @public @memberof GoGenericMsg
1964 * @version Introduced in firmware 5.2.18.3
1965 * @param msg Message object.
1966 * @return Address of the raw buffer.
1967 */
1968 GoFx(const void*) GoGenericMsg_BufferData(GoGenericMsg msg);
1969
1970 /**
1971 * Returns the kObject content, if available.
1972 *
1973 * @public @memberof GoGenericMsg
1974 * @version Introduced in firmware 5.2.18.3
1975 * @param msg Message object.
1976 * @return Content object. kNULL if the content is a raw
1977 * buffer or if the data cannot be deserialized.
1978 */
1979 GoFx(kObject) GoGenericMsg_Object(GoGenericMsg msg);
1980
1981 /**
1982 * Returns the serializer status after deserializing kObject content.
1983 *
1984 * Note that deserialization does not occur until GoGenericMsg_Object is
1985 * called for the first time.
1986 *
1987 * @public @memberof GoGenericMsg
1988 * @version Introduced in firmware 5.2.18.3
1989 * @param msg Message object.
1990 * @return Serializer status. kOK if not applicable.
1991 */
1992 GoFx(kStatus) GoGenericMsg_SerializerStatus(GoGenericMsg msg);
1993
1994 kEndHeader()
1995 #include <GoSdk/Messages/GoDataTypes.x.h>
1996
1997 #endif
GoStamp
Represents an acquisition stamp.
Definition: GoDataTypes.h:83
GoUniformProfileMsg::GoUniformProfileMsg_Source
GoDataSource GoUniformProfileMsg_Source(GoUniformProfileMsg msg)
Gets the profile source.
k32u
GoStampMsg::GoStampMsg_At
GoStamp * GoStampMsg_At(GoStampMsg msg, kSize index)
Gets the stamp at the specified index.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_CameraIndex
k8u GoProfilePointCloudMsg_CameraIndex(GoProfilePointCloudMsg msg)
Gets the source camera index.
GoGenericMsg::GoGenericMsg_BufferSize
kSize GoGenericMsg_BufferSize(GoGenericMsg msg)
Returns the size of the raw buffer.
GoTracheidEllipse::scatter
k64f scatter
Ellipse scatter.
Definition: GoDataTypes.h:1708
GoTracheidMsg::GoTracheidMsg_CameraIndex
k8u GoTracheidMsg_CameraIndex(GoTracheidMsg msg)
Gets the tracheid camera index.
GoRangeMsg::GoRangeMsg_ZOffset
k32s GoRangeMsg_ZOffset(GoRangeMsg msg)
Gets the Range z-offset, in micrometers.
GoProfileIntensityMsg::GoProfileIntensityMsg_Count
kSize GoProfileIntensityMsg_Count(GoProfileIntensityMsg msg)
Gets the count of profile intensity arrays in this message.
GoMeasurementData::decision
GoDecision decision
Measurement decision value.
Definition: GoDataTypes.h:1333
GoGenericMsg
Represents a data message containing generic data.
GoVideoMsg::GoVideoMsg_Width
kSize GoVideoMsg_Width(GoVideoMsg msg)
Gets the image width, in pixels.
GoVideoMsg::GoVideoMsg_IsFlippedX
kBool GoVideoMsg_IsFlippedX(GoVideoMsg msg)
Indicates whether the video message data requires horizontal flipping to match up with profile data.
GoVideoMsg::GoVideoMsg_Cfa
kCfa GoVideoMsg_Cfa(GoVideoMsg msg)
Gets the image color filter array.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_YOffset
k64f GoBoundingBoxMatchMsg_YOffset(GoBoundingBoxMatchMsg msg)
Gets the bounding box match Y offset.
kPoint16s
GoEllipseMatchMsg::GoEllipseMatchMsg_MajorDecision
k8u GoEllipseMatchMsg_MajorDecision(GoEllipseMatchMsg msg)
Gets the ellipse match major decision.
k64u
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_ZAngle
k64f GoBoundingBoxMatchMsg_ZAngle(GoBoundingBoxMatchMsg msg)
Gets the bounding box match Z angle.
GoProfileIntensityMsg::GoProfileIntensityMsg_XOffset
k32s GoProfileIntensityMsg_XOffset(GoProfileIntensityMsg msg)
Gets the profile x-offset, in micrometers.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_WidthDecision
k8u GoBoundingBoxMatchMsg_WidthDecision(GoBoundingBoxMatchMsg msg)
Gets the bounding box match width decision.
GoPlaneFeatureMsg::GoPlaneFeatureMsg_Normal
kPoint3d64f GoPlaneFeatureMsg_Normal(GoPlaneFeatureMsg msg)
Gets the normal vector of the planear feature.
GoLineFeatureMsg::GoLineFeatureMsg_Direction
kPoint3d64f GoLineFeatureMsg_Direction(GoLineFeatureMsg msg)
The direction vector of the linear feature.
GoVideoMsg
Represents a data message containing a video image.
GoTracheidEllipse::area
k64f area
Ellipse area.
Definition: GoDataTypes.h:1706
GoProfilePointCloudMsg::GoProfilePointCloudMsg_Count
kSize GoProfilePointCloudMsg_Count(GoProfilePointCloudMsg msg)
Gets the count of profile arrays in this message.
GoCircleFeatureMsg::GoCircleFeatureMsg_Id
k16u GoCircleFeatureMsg_Id(GoCircleFeatureMsg msg)
Gets the circular feature identifier.
GoEdgeMatchMsg
Represents a message containing edge based part matching results.
GoCircleFeatureMsg::GoCircleFeatureMsg_Normal
kPoint3d64f GoCircleFeatureMsg_Normal(GoCircleFeatureMsg msg)
Gets the normal vector of the circular feature.
GoDecisionCode
Represents the possible measurement decision codes.
GoEllipseMatchMsg::GoEllipseMatchMsg_Decision
k8u GoEllipseMatchMsg_Decision(GoEllipseMatchMsg msg)
Gets the ellipse match decision.
GoProfileIntensityMsg::GoProfileIntensityMsg_Exposure
k32u GoProfileIntensityMsg_Exposure(GoProfileIntensityMsg msg)
Gets the exposure.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_ZResolution
k32u GoProfilePointCloudMsg_ZResolution(GoProfilePointCloudMsg msg)
Gets the profile z-resolution, in nanometers.
k16u
kSize
GoEventMsg::GoEventMsg_Type
GoEventType GoEventMsg_Type(GoEventMsg msg)
Gets the event type.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_Decision
k8u GoBoundingBoxMatchMsg_Decision(GoBoundingBoxMatchMsg msg)
Gets the bounding box match major value.
GoTracheidEllipse::minor
k64f minor
Ellipse minor.
Definition: GoDataTypes.h:1709
GoDataSource
Represents a data source.
k8u
GoCircleFeatureMsg::GoCircleFeatureMsg_Position
kPoint3d64f GoCircleFeatureMsg_Position(GoCircleFeatureMsg msg)
Gets the position of the center of the circular feature.
GoUniformProfileMsg::GoUniformProfileMsg_ZOffset
k32s GoUniformProfileMsg_ZOffset(GoUniformProfileMsg msg)
Gets the profile z-offset, in micrometers.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_Exposure
k32u GoProfilePointCloudMsg_Exposure(GoProfilePointCloudMsg msg)
Gets the exposure.
GoVideoMsg::GoVideoMsg_Source
GoDataSource GoVideoMsg_Source(GoVideoMsg msg)
Gets the video source.
GoDecision
Represents the measurement output decision values. Bit 0 represents the decision value,...
GoRangeMsg
Represents a data message containing a set of range data.
GoProfileIntensityMsg::GoProfileIntensityMsg_XResolution
k32u GoProfileIntensityMsg_XResolution(GoProfileIntensityMsg msg)
Gets the x-resolution, in nanometers.
GoEllipseMatchMsg::GoEllipseMatchMsg_XOffset
k64f GoEllipseMatchMsg_XOffset(GoEllipseMatchMsg msg)
Gets the ellipse match X offset.
GoPlaneFeatureMsg
Represents a message containing Planear Feature data.
GoTracheidMsg::GoTracheidMsg_At
GoTracheidEllipse * GoTracheidMsg_At(GoTracheidMsg msg, kSize index)
Gets a pointer to a tracheid ellipse array.
GoProfileIntensityMsg::GoProfileIntensityMsg_CameraIndex
k8u GoProfileIntensityMsg_CameraIndex(GoProfileIntensityMsg msg)
Gets the source camera index.
GoVideoMsg::GoVideoMsg_CameraIndex
kSize GoVideoMsg_CameraIndex(GoVideoMsg msg)
Gets the camera index that the video data originates from.
GoUniformProfileMsg
Represents a data message containing a set of re-sampled profile arrays.
GoRangeMsg::GoRangeMsg_Count
kSize GoRangeMsg_Count(GoRangeMsg msg)
Gets the count of Range data in this message.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_Width
kSize GoProfilePointCloudMsg_Width(GoProfilePointCloudMsg msg)
Gets the count of ranges in each profile array.
GoRangeIntensityMsg::GoRangeIntensityMsg_Count
kSize GoRangeIntensityMsg_Count(GoRangeIntensityMsg msg)
Gets the count of range intensity data in this message.
GoExposureCalMsg::GoExposureCalMsg_Exposure
k64f GoExposureCalMsg_Exposure(GoExposureCalMsg msg)
Gets the calibrated exposure.
GoStamp::timestamp
k64u timestamp
Timestamp in internal units approximating microseconds where the true time in us = timestamp value / ...
Definition: GoDataTypes.h:86
GoVideoMsg::GoVideoMsg_RowAt
void * GoVideoMsg_RowAt(GoVideoMsg msg, kSize rowIndex)
Gets a pointer to a row within the image.
GoVideoMsg::GoVideoMsg_PixelSize
kSize GoVideoMsg_PixelSize(GoVideoMsg msg)
Gets the image pixel size, in bytes.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_LengthDecision
k8u GoBoundingBoxMatchMsg_LengthDecision(GoBoundingBoxMatchMsg msg)
Gets the bounding box match length decision.
GoStampMsg
Represents a message containing a set of acquisition stamps.
GoBoundingBoxMatchMsg
Represents a message containing bounding box based part matching results.
GoStampMsg::GoStampMsg_Count
kSize GoStampMsg_Count(GoStampMsg msg)
Returns the number of stamps contained in this message.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_At
kPoint16s * GoProfilePointCloudMsg_At(GoProfilePointCloudMsg msg, kSize index)
Gets a pointer to a profile array.
GoTracheidEllipse::major
k64f major
Ellipse major.
Definition: GoDataTypes.h:1710
GoVideoMsg::GoVideoMsg_Exposure
k32u GoVideoMsg_Exposure(GoVideoMsg msg)
Gets the exposure.
GoUniformProfileMsg::GoUniformProfileMsg_Width
kSize GoUniformProfileMsg_Width(GoUniformProfileMsg msg)
Gets the count of points in each re-sampled profile array.
GoVideoMsg::GoVideoMsg_Height
kSize GoVideoMsg_Height(GoVideoMsg msg)
Gets the image height, in pixels.
GoVideoMsg::GoVideoMsg_PixelFormat
kPixelFormat GoVideoMsg_PixelFormat(GoVideoMsg msg)
Gets the pixel format descriptor.
GoUniformProfileMsg::GoUniformProfileMsg_ZResolution
k32u GoUniformProfileMsg_ZResolution(GoUniformProfileMsg msg)
Gets the profile z-resolution, in nanometers.
kPixelFormat
GoEllipseMatchMsg::GoEllipseMatchMsg_MajorValue
k64f GoEllipseMatchMsg_MajorValue(GoEllipseMatchMsg msg)
Gets the ellipse match major value.
GoUniformProfileMsg::GoUniformProfileMsg_Exposure
k32u GoUniformProfileMsg_Exposure(GoUniformProfileMsg msg)
Gets the exposure.
GoStamp::encoderAtZ
k64s encoderAtZ
Encoder value latched at z-index mark (encoder ticks).
Definition: GoDataTypes.h:88
GoTracheidMsg::GoTracheidMsg_Count
kSize GoTracheidMsg_Count(GoTracheidMsg msg)
Gets the count of tracheid arrays in this message.
GoStamp::status
k64u status
Bit mask containing frame information:
Definition: GoDataTypes.h:89
GoLineFeatureMsg::GoLineFeatureMsg_Id
k16u GoLineFeatureMsg_Id(GoLineFeatureMsg msg)
Gets the linear feature identifier.
GoCircleFeatureMsg::GoCircleFeatureMsg_Radius
k64f GoCircleFeatureMsg_Radius(GoCircleFeatureMsg msg)
Gets the radius of the circular feature.
GoSdkDef.h
Essential SDK declarations.
GoProfileIntensityMsg::GoProfileIntensityMsg_Width
kSize GoProfileIntensityMsg_Width(GoProfileIntensityMsg msg)
Gets the count of intensity values in each profile intensity array.
GoUniformProfileMsg::GoUniformProfileMsg_XOffset
k32s GoUniformProfileMsg_XOffset(GoUniformProfileMsg msg)
Gets the profile x-offset, in micrometers.
GoPlaneFeatureMsg::GoPlaneFeatureMsg_DistanceToOrigin
k64f GoPlaneFeatureMsg_DistanceToOrigin(GoPlaneFeatureMsg msg)
Gets shortest distance from the origin to the plane.
GoMeasurementMsg::GoMeasurementMsg_Id
k16u GoMeasurementMsg_Id(GoMeasurementMsg msg)
Gets the measurement identifier.
GoProfileIntensityMsg::GoProfileIntensityMsg_Source
GoDataSource GoProfileIntensityMsg_Source(GoProfileIntensityMsg msg)
Gets the profile source.
GoStampMsg::GoStampMsg_Source
GoDataSource GoStampMsg_Source(GoStampMsg msg)
Gets the stamp source.
GoExposureCalMsg
Represents a message containing exposure calibration results.
GoVideoMsg::GoVideoMsg_IsFlippedY
kBool GoVideoMsg_IsFlippedY(GoVideoMsg msg)
Indicates whether the video message data requires vertical flipping to match up with profile data.
GoPixelType
Represents a video message pixel type.
GoUniformProfileMsg::GoUniformProfileMsg_XResolution
k32u GoUniformProfileMsg_XResolution(GoUniformProfileMsg msg)
Gets the x-resolution, in nanometers.
GoPointFeatureMsg::GoPointFeatureMsg_Position
kPoint3d64f GoPointFeatureMsg_Position(GoPointFeatureMsg msg)
The point data in this message.
GoRangeMsg::GoRangeMsg_Exposure
k32u GoRangeMsg_Exposure(GoRangeMsg msg)
Gets the exposure.
GoRangeMsg::GoRangeMsg_Source
GoDataSource GoRangeMsg_Source(GoRangeMsg msg)
Gets the Range source.
GoProfileIntensityMsg
Represents a data message containing a set of profile intensity arrays.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_XResolution
k32u GoProfilePointCloudMsg_XResolution(GoProfilePointCloudMsg msg)
Gets the profile x-resolution, in nanometers.
GoTracheidMsg
Represents a data message containing a set of tracheid data.
GoStamp::id
k32u id
Source device ID.
Definition: GoDataTypes.h:100
GoDataMsg::GoDataMsg_Type
GoDataMessageType GoDataMsg_Type(GoDataMsg message)
Returns the message type for a data channel message given in a GoDataSet.
k32s
GoEllipseMatchMsg::GoEllipseMatchMsg_ZAngle
k64f GoEllipseMatchMsg_ZAngle(GoEllipseMatchMsg msg)
Gets the ellipse match Z angle.
GoMeasurementMsg::GoMeasurementMsg_At
GoMeasurementData * GoMeasurementMsg_At(GoMeasurementMsg msg, kSize index)
Gets the measurement at the specified index.
GoRangeIntensityMsg
Represents a data message containing a set of range intensity data.
GoProfilePointCloudMsg
Represents a data message containing a set of profile arrays.
GoTracheidMsg::GoTracheidMsg_Width
kSize GoTracheidMsg_Width(GoTracheidMsg msg)
Gets the count of ellipses in each tracheid array.
GoEdgeMatchMsg::GoEdgeMatchMsg_QualityDecision
k8u GoEdgeMatchMsg_QualityDecision(GoEdgeMatchMsg msg)
Gets the edge match quality decision.
GoDataMessageType
Lists all data message types.
GoMeasurementMsg::GoMeasurementMsg_Count
kSize GoMeasurementMsg_Count(GoMeasurementMsg msg)
Count of measurements in this message.
GoCircleFeatureMsg
Represents a message containing circular feature data.
GoPlaneFeatureMsg::GoPlaneFeatureMsg_Id
k16u GoPlaneFeatureMsg_Id(GoPlaneFeatureMsg msg)
Gets the planear feature identifier.
GoUniformProfileMsg::GoUniformProfileMsg_Count
kSize GoUniformProfileMsg_Count(GoUniformProfileMsg msg)
Gets the count of re-sampled profile arrays in this message.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_LengthValue
k64f GoBoundingBoxMatchMsg_LengthValue(GoBoundingBoxMatchMsg msg)
Gets the bounding box match length value.
GoGenericMsg::GoGenericMsg_IsObject
kBool GoGenericMsg_IsObject(GoGenericMsg msg)
Returns whether or not the content is an kObject.
GoTracheidEllipse::angle
k64f angle
Ellipse angle.
Definition: GoDataTypes.h:1707
GoGenericMsg::GoGenericMsg_SerializerStatus
kStatus GoGenericMsg_SerializerStatus(GoGenericMsg msg)
Returns the serializer status after deserializing kObject content.
k64s
GoDataMsg::GoDataMsg_SetStreamStepId
kStatus GoDataMsg_SetStreamStepId(GoDataMsg message, k32s streamStepId)
Sets the identifier of the data stream from the source.
GoMeasurementData::decisionCode
GoDecisionCode decisionCode
Measurement decision code - relevant only when the value represents a failure.
Definition: GoDataTypes.h:1334
GoEllipseMatchMsg::GoEllipseMatchMsg_MinorValue
k64f GoEllipseMatchMsg_MinorValue(GoEllipseMatchMsg msg)
Gets the ellipse match minor value.
GoRangeIntensityMsg::GoRangeIntensityMsg_Source
GoDataSource GoRangeIntensityMsg_Source(GoRangeIntensityMsg msg)
Gets the range intensity source.
GoAlignMsg
Represents a message containing an alignment result.
GoMeasurementData::value
k64f value
Measurement value.
Definition: GoDataTypes.h:1332
GoDataMsg::GoDataMsg_SetStreamStep
kStatus GoDataMsg_SetStreamStep(GoDataMsg message, GoDataStep streamStep)
Sets the source of the data stream.
kPoint3d16s
GoStamp::reserved32u
k32u reserved32u
Reserved.
Definition: GoDataTypes.h:101
GoDataMsg::GoDataMsg_StreamStep
GoDataStep GoDataMsg_StreamStep(GoDataMsg message)
Gets the source of the data stream.
GoMeasurementMsg
Represents a message containing a set of GoMeasurementData.
GoEdgeMatchMsg::GoEdgeMatchMsg_QualityValue
k64f GoEdgeMatchMsg_QualityValue(GoEdgeMatchMsg msg)
Gets the edge match quality value.
GoGenericMsg::GoGenericMsg_BufferData
const void * GoGenericMsg_BufferData(GoGenericMsg msg)
Returns a pointer to the raw buffer.
GoDataMsg
Represents a base message sourced from the data channel.
GoLineFeatureMsg::GoLineFeatureMsg_Position
kPoint3d64f GoLineFeatureMsg_Position(GoLineFeatureMsg msg)
Gets a point on the linear feature.
GoEventMsg
Represents a message containing an event (See GoEventType).
GoPointFeatureMsg
Represents a message containing Point Feature data.
GoAlignMsg::GoAlignMsg_Status
kStatus GoAlignMsg_Status(GoAlignMsg msg)
Gets the alignment result.
GoProfileIntensityMsg::GoProfileIntensityMsg_At
k8u * GoProfileIntensityMsg_At(GoProfileIntensityMsg msg, kSize index)
Gets a pointer to a profile intensity array.
GoDataMsg::GoDataMsg_StreamStepId
k32s GoDataMsg_StreamStepId(GoDataMsg message)
Gets the identifier of the data stream from the source.
k16s
GoProfilePointCloudMsg::GoProfilePointCloudMsg_XOffset
k32s GoProfilePointCloudMsg_XOffset(GoProfilePointCloudMsg msg)
Gets the profile x-offset, in micrometers.
GoEllipseMatchMsg
Represents a message containing ellipse based part matching results.
GoEdgeMatchMsg::GoEdgeMatchMsg_ZAngle
k64f GoEdgeMatchMsg_ZAngle(GoEdgeMatchMsg msg)
Gets the edge match Z angle.
kObject
GoRangeIntensityMsg::GoRangeIntensityMsg_Exposure
k32u GoRangeIntensityMsg_Exposure(GoRangeIntensityMsg msg)
Gets the exposure.
kStatus
GoRangeMsg::GoRangeMsg_At
k16s * GoRangeMsg_At(GoRangeMsg msg, kSize index)
Gets a pointer to Range data.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_XOffset
k64f GoBoundingBoxMatchMsg_XOffset(GoBoundingBoxMatchMsg msg)
Gets the bounding box match X offset.
GoVideoMsg::GoVideoMsg_PixelType
GoPixelType GoVideoMsg_PixelType(GoVideoMsg msg)
Gets the data type used to represent an image pixel.
GoEventType
Represents the event type represented by an event message.
kCfa
GoTracheidMsg::GoTracheidMsg_Source
GoDataSource GoTracheidMsg_Source(GoTracheidMsg msg)
Gets the tracheid source.
k64f
GoStamp::encoder
k64s encoder
Position (encoder ticks).
Definition: GoDataTypes.h:87
GoEllipseMatchMsg::GoEllipseMatchMsg_YOffset
k64f GoEllipseMatchMsg_YOffset(GoEllipseMatchMsg msg)
Gets the ellipse match Y offset.
GoStamp::frameIndex
k64u frameIndex
Frame index (counts up from zero).
Definition: GoDataTypes.h:85
GoRangeMsg::GoRangeMsg_ZResolution
k32u GoRangeMsg_ZResolution(GoRangeMsg msg)
Gets the Range z-resolution, in nanometers.
GoEdgeMatchMsg::GoEdgeMatchMsg_YOffset
k64f GoEdgeMatchMsg_YOffset(GoEdgeMatchMsg msg)
Gets the edge match Y offset.
kBool
GoEdgeMatchMsg::GoEdgeMatchMsg_XOffset
k64f GoEdgeMatchMsg_XOffset(GoEdgeMatchMsg msg)
Gets the edge match X offset.
GoGenericMsg::GoGenericMsg_UserType
k32u GoGenericMsg_UserType(GoGenericMsg msg)
Gets the user defined data type.
GoVideoMsg::GoVideoMsg_ExposureIndex
kSize GoVideoMsg_ExposureIndex(GoVideoMsg msg)
Gets the exposure index.
GoDataStep
Represents possible data streams.
GoTracheidEllipse
Represents a tracheid ellipse.
Definition: GoDataTypes.h:1704
GoEdgeMatchMsg::GoEdgeMatchMsg_Decision
k8u GoEdgeMatchMsg_Decision(GoEdgeMatchMsg msg)
Gets the edge match decision.
GoUniformProfileMsg::GoUniformProfileMsg_At
k16s * GoUniformProfileMsg_At(GoUniformProfileMsg msg, kSize index)
Gets a pointer to a re-sampled profile array.
GoProfilePointCloudMsg::GoProfilePointCloudMsg_ZOffset
k32s GoProfilePointCloudMsg_ZOffset(GoProfilePointCloudMsg msg)
Gets the profile z-offset, in micrometers.
GoEllipseMatchMsg::GoEllipseMatchMsg_MinorDecision
k8u GoEllipseMatchMsg_MinorDecision(GoEllipseMatchMsg msg)
Gets the ellipse match minor decision.
GoLineFeatureMsg
Represents a message containing Linear Feature data.
kPoint3d64f
GoExposureCalMsg::GoExposureCalMsg_Status
kStatus GoExposureCalMsg_Status(GoExposureCalMsg msg)
Gets the exposure calibration result.
GoPointFeatureMsg::GoPointFeatureMsg_Id
k16u GoPointFeatureMsg_Id(GoPointFeatureMsg msg)
Gets the point feature identifier.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_WidthValue
k64f GoBoundingBoxMatchMsg_WidthValue(GoBoundingBoxMatchMsg msg)
Gets the bounding box match width value.
GoStamp::reserved64u
k64u reserved64u
Reserved.
Definition: GoDataTypes.h:102
GoGenericMsg::GoGenericMsg_Object
kObject GoGenericMsg_Object(GoGenericMsg msg)
Returns the kObject content, if available.
GoMeasurementData
Represents a measurement result.
Definition: GoDataTypes.h:1330
GoProfilePointCloudMsg::GoProfilePointCloudMsg_Source
GoDataSource GoProfilePointCloudMsg_Source(GoProfilePointCloudMsg msg)
Gets the profile source.
GoRangeIntensityMsg::GoRangeIntensityMsg_At
k8u * GoRangeIntensityMsg_At(GoRangeIntensityMsg msg, kSize index)
Gets a pointer to range intensity data.