Gocator API

- Home
- Types
- Files

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