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) 2015 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 nanoseconds where the true time in ns = 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 /// @cond (Gocator_1x00)
223 /**
224 * @class GoRangeMsg
225 * @extends GoDataMsg
226 * @ingroup GoSdk-DataChannel
227 * @brief Represents a data message containing a set of range data.
228 */
229 typedef GoDataMsg GoRangeMsg;
230
231 /**
232 * Gets the Range source.
233 *
234 * @public @memberof GoRangeMsg
235 * @version Introduced in firmware 4.0.10.27
236 * @param msg Message object.
237 * @return Range source.
238 */
239 GoFx(GoDataSource) GoRangeMsg_Source(GoRangeMsg msg);
240
241 /**
242 * Gets the count of Range data in this message.
243 *
244 * @public @memberof GoRangeMsg
245 * @version Introduced in firmware 4.0.10.27
246 * @param msg Message object.
247 * @return Count of Range data.
248 */
249 GoFx(kSize) GoRangeMsg_Count(GoRangeMsg msg);
250
251
252 /**
253 * Gets the Range z-resolution, in nanometers.
254 *
255 * @public @memberof GoRangeMsg
256 * @version Introduced in firmware 4.0.10.27
257 * @param msg Message object.
258 * @return Z resolution (nm).
259 */
260 GoFx(k32u) GoRangeMsg_ZResolution(GoRangeMsg msg);
261
262 /**
263 * Gets the Range z-offset, in micrometers.
264 *
265 * @public @memberof GoRangeMsg
266 * @version Introduced in firmware 4.0.10.27
267 * @param msg Message object.
268 * @return Z offset (um).
269 */
270 GoFx(k32s) GoRangeMsg_ZOffset(GoRangeMsg msg);
271
272 /**
273 * Gets a pointer to Range data.
274 *
275 * @public @memberof GoRangeMsg
276 * @version Introduced in firmware 4.0.10.27
277 * @param msg Message object.
278 * @param index Range array index.
279 * @return Range pointer.
280 */
281 GoFx(k16s*) GoRangeMsg_At(GoRangeMsg msg, kSize index);
282
283 /**
284 * Gets the exposure.
285 *
286 * @public @memberof GoRangeMsg
287 * @version Introduced in firmware 4.0.10.27
288 * @param msg Message object.
289 * @return Exposure in uS.
290 */
291 GoFx(k32u) GoRangeMsg_Exposure(GoRangeMsg msg);
292
293
294 /**
295 * @class GoRangeIntensityMsg
296 * @extends GoDataMsg
297 * @ingroup GoSdk-DataChannel
298 * @brief Represents a data message containing a set of range intensity data.
299 */
300 typedef GoDataMsg GoRangeIntensityMsg;
301
302 /**
303 * Gets the range intensity source.
304 *
305 * @public @memberof GoRangeIntensityMsg
306 * @version Introduced in firmware 4.0.10.27
307 * @param msg Message object.
308 * @return Range intensity source.
309 */
310 GoFx(GoDataSource) GoRangeIntensityMsg_Source(GoRangeIntensityMsg msg);
311
312 /**
313 * Gets the count of range intensity data in this message.
314 *
315 * @public @memberof GoRangeIntensityMsg
316 * @version Introduced in firmware 4.0.10.27
317 * @param msg Message object.
318 * @return Count of range intensity data.
319 */
320 GoFx(kSize) GoRangeIntensityMsg_Count(GoRangeIntensityMsg msg);
321
322 /**
323 * Gets a pointer to range intensity data.
324 *
325 * @public @memberof GoRangeIntensityMsg
326 * @version Introduced in firmware 4.0.10.27
327 * @param msg Message object.
328 * @param index Range intensity array index.
329 * @return Range intensity data pointer.
330 */
331 GoFx(k8u*) GoRangeIntensityMsg_At(GoRangeIntensityMsg msg, kSize index);
332
333 /**
334 * Gets the exposure.
335 *
336 * @public @memberof GoRangeIntensityMsg
337 * @version Introduced in firmware 4.0.10.27
338 * @param msg Message object.
339 * @return Exposure in uS.
340 */
341 GoFx(k32u) GoRangeIntensityMsg_Exposure(GoRangeIntensityMsg msg);
342
343 /// @endcond
344
345 /// @cond (Gocator_1x00 || Gocator_2x00)
346 /**
347 * @class GoProfileMsg
348 * @extends GoDataMsg
349 * @ingroup GoSdk-DataChannel
350 * @brief Represents a data message containing a set of profile arrays.
351 */
352 typedef GoDataMsg GoProfileMsg;
353
354 /**
355 * Gets the profile source.
356 *
357 * @public @memberof GoProfileMsg
358 * @version Introduced in firmware 4.0.10.27
359 * @param msg Message object.
360 * @return Profile source.
361 */
362 GoFx(GoDataSource) GoProfileMsg_Source(GoProfileMsg msg);
363
364 /**
365 * Gets the count of profile arrays in this message.
366 *
367 * @public @memberof GoProfileMsg
368 * @version Introduced in firmware 4.0.10.27
369 * @param msg Message object.
370 * @return Count of profile arrays.
371 */
372 GoFx(kSize) GoProfileMsg_Count(GoProfileMsg msg);
373
374 /**
375 * Gets the count of ranges in each profile array.
376 *
377 * @public @memberof GoProfileMsg
378 * @version Introduced in firmware 4.0.10.27
379 * @param msg Message object.
380 * @return Range count.
381 */
382 GoFx(kSize) GoProfileMsg_Width(GoProfileMsg msg);
383
384 /**
385 * Gets the profile x-resolution, in nanometers.
386 *
387 * @public @memberof GoProfileMsg
388 * @version Introduced in firmware 4.0.10.27
389 * @param msg Message object.
390 * @return X resolution (nm).
391 */
392 GoFx(k32u) GoProfileMsg_XResolution(GoProfileMsg msg);
393
394 /**
395 * Gets the profile z-resolution, in nanometers.
396 *
397 * @public @memberof GoProfileMsg
398 * @version Introduced in firmware 4.0.10.27
399 * @param msg Message object.
400 * @return Z resolution (nm).
401 */
402 GoFx(k32u) GoProfileMsg_ZResolution(GoProfileMsg msg);
403
404 /**
405 * Gets the profile x-offset, in micrometers.
406 *
407 * @public @memberof GoProfileMsg
408 * @version Introduced in firmware 4.0.10.27
409 * @param msg Message object.
410 * @return X offset (um).
411 */
412 GoFx(k32s) GoProfileMsg_XOffset(GoProfileMsg msg);
413
414 /**
415 * Gets the profile z-offset, in micrometers.
416 *
417 * @public @memberof GoProfileMsg
418 * @version Introduced in firmware 4.0.10.27
419 * @param msg Message object.
420 * @return Z offset (um).
421 */
422 GoFx(k32s) GoProfileMsg_ZOffset(GoProfileMsg msg);
423
424 /**
425 * Gets a pointer to a profile array.
426 *
427 * @public @memberof GoProfileMsg
428 * @version Introduced in firmware 4.0.10.27
429 * @param msg Message object.
430 * @param index Profile array index.
431 * @return Profile pointer.
432 */
433 GoFx(kPoint16s*) GoProfileMsg_At(GoProfileMsg msg, kSize index);
434
435 /**
436 * Gets the exposure.
437 *
438 * @public @memberof GoProfileMsg
439 * @version Introduced in firmware 4.0.10.27
440 * @param msg Message object.
441 * @return Exposure in uS.
442 */
443 GoFx(k32u) GoProfileMsg_Exposure(GoProfileMsg msg);
444
445
446 /**
447 * Gets the source camera index.
448 *
449 * @public @memberof GoProfileMsg
450 * @version Introduced in firmware 4.1.3.106
451 * @param msg Message object.
452 * @return Camera index (0 - Front camera, 1 - Back camera).
453 */
454 GoFx(k8u) GoProfileMsg_CameraIndex(GoProfileMsg msg);
455
456
457 /**
458 * @class GoResampledProfileMsg
459 * @extends GoDataMsg
460 * @ingroup GoSdk-DataChannel
461 * @brief Represents a data message containing a set of re-sampled profile arrays.
462 */
463 typedef GoDataMsg GoResampledProfileMsg;
464
465 /**
466 * Gets the profile source.
467 *
468 * @public @memberof GoResampledProfileMsg
469 * @version Introduced in firmware 4.0.10.27
470 * @param msg Message object.
471 * @return Profile source.
472 */
473 GoFx(GoDataSource) GoResampledProfileMsg_Source(GoResampledProfileMsg msg);
474
475 /**
476 * Gets the count of re-sampled profile arrays in this message.
477 *
478 * @public @memberof GoResampledProfileMsg
479 * @version Introduced in firmware 4.0.10.27
480 * @param msg Message object.
481 * @return Count of profile arrays.
482 */
483 GoFx(kSize) GoResampledProfileMsg_Count(GoResampledProfileMsg msg);
484
485 /**
486 * Gets the count of points in each re-sampled profile array.
487 *
488 * @public @memberof GoResampledProfileMsg
489 * @version Introduced in firmware 4.0.10.27
490 * @param msg Message object.
491 * @return Point count.
492 */
493 GoFx(kSize) GoResampledProfileMsg_Width(GoResampledProfileMsg msg);
494
495 /**
496 * Gets the x-resolution, in nanometers.
497 *
498 * @public @memberof GoResampledProfileMsg
499 * @version Introduced in firmware 4.0.10.27
500 * @param msg Message object.
501 * @return X resolution (nm).
502 */
503 GoFx(k32u) GoResampledProfileMsg_XResolution(GoResampledProfileMsg msg);
504
505 /**
506 * Gets the profile z-resolution, in nanometers.
507 *
508 * @public @memberof GoResampledProfileMsg
509 * @version Introduced in firmware 4.0.10.27
510 * @param msg Message object.
511 * @return Z resolution (nm).
512 */
513 GoFx(k32u) GoResampledProfileMsg_ZResolution(GoResampledProfileMsg msg);
514
515 /**
516 * Gets the profile x-offset, in micrometers.
517 *
518 * @public @memberof GoResampledProfileMsg
519 * @version Introduced in firmware 4.0.10.27
520 * @param msg Message object.
521 * @return X offset (um).
522 */
523 GoFx(k32s) GoResampledProfileMsg_XOffset(GoResampledProfileMsg msg);
524
525 /**
526 * Gets the profile z-offset, in micrometers.
527 *
528 * @public @memberof GoResampledProfileMsg
529 * @version Introduced in firmware 4.0.10.27
530 * @param msg Message object.
531 * @return Z offset (um).
532 */
533 GoFx(k32s) GoResampledProfileMsg_ZOffset(GoResampledProfileMsg msg);
534
535 /**
536 * Gets a pointer to a re-sampled profile array.
537 *
538 * @public @memberof GoResampledProfileMsg
539 * @version Introduced in firmware 4.0.10.27
540 * @param msg Message object.
541 * @param index Profile array index.
542 * @return Data pointer.
543 */
544 GoFx(k16s*) GoResampledProfileMsg_At(GoResampledProfileMsg msg, kSize index);
545
546 /**
547 * Gets the exposure.
548 *
549 * @public @memberof GoResampledProfileMsg
550 * @version Introduced in firmware 4.0.10.27
551 * @param msg Message object.
552 * @return Exposure in uS.
553 */
554 GoFx(k32u) GoResampledProfileMsg_Exposure(GoResampledProfileMsg msg);
555
556
557 /**
558 * @class GoProfileIntensityMsg
559 * @extends GoDataMsg
560 * @ingroup GoSdk-DataChannel
561 * @brief Represents a data message containing a set of profile intensity arrays.
562 */
563 typedef GoDataMsg GoProfileIntensityMsg;
564
565 /**
566 * Gets the profile source.
567 *
568 * @public @memberof GoProfileIntensityMsg
569 * @version Introduced in firmware 4.0.10.27
570 * @param msg Message object.
571 * @return Profile source.
572 */
573 GoFx(GoDataSource) GoProfileIntensityMsg_Source(GoProfileIntensityMsg msg);
574
575 /**
576 * Gets the count of profile intensity arrays in this message.
577 *
578 * @public @memberof GoProfileIntensityMsg
579 * @version Introduced in firmware 4.0.10.27
580 * @param msg Message object.
581 * @return Count of profile arrays.
582 */
583 GoFx(kSize) GoProfileIntensityMsg_Count(GoProfileIntensityMsg msg);
584
585 /**
586 * Gets the count of intensity values in each profile intensity array.
587 *
588 * @public @memberof GoProfileIntensityMsg
589 * @version Introduced in firmware 4.0.10.27
590 * @param msg Message object.
591 * @return Intensity count.
592 */
593 GoFx(kSize) GoProfileIntensityMsg_Width(GoProfileIntensityMsg msg);
594
595 /**
596 * Gets the x-resolution, in nanometers.
597 *
598 * @public @memberof GoProfileIntensityMsg
599 * @version Introduced in firmware 4.0.10.27
600 * @param msg Message object.
601 * @return X resolution (nm).
602 */
603 GoFx(k32u) GoProfileIntensityMsg_XResolution(GoProfileIntensityMsg msg);
604
605 /**
606 * Gets the profile x-offset, in micrometers.
607 *
608 * @public @memberof GoProfileIntensityMsg
609 * @version Introduced in firmware 4.0.10.27
610 * @param msg Message object.
611 * @return X offset (um).
612 */
613 GoFx(k32s) GoProfileIntensityMsg_XOffset(GoProfileIntensityMsg msg);
614
615 /**
616 * Gets the associated profile type (points or ranges).
617 *
618 * @public @memberof GoProfileIntensityMsg
619 * @version Introduced in firmware 4.0.10.27
620 * @param msg Message object.
621 * @return kTRUE for ranges; kFALSE for points.
622 */
623 GoFx(kBool) GoProfileIntensityMsg_IsResampled(GoProfileIntensityMsg msg);
624
625 /**
626 * Gets a pointer to a profile intensity array.
627 *
628 * @public @memberof GoProfileIntensityMsg
629 * @version Introduced in firmware 4.0.10.27
630 * @param msg Message object.
631 * @param index Profile intensity array index.
632 * @return Data pointer.
633 */
634 GoFx(k8u*) GoProfileIntensityMsg_At(GoProfileIntensityMsg msg, kSize index);
635
636 /**
637 * Gets the exposure.
638 *
639 * @public @memberof GoProfileIntensityMsg
640 * @version Introduced in firmware 4.0.10.27
641 * @param msg Message object.
642 * @return Exposure in uS.
643 */
644 GoFx(k32u) GoProfileIntensityMsg_Exposure(GoProfileIntensityMsg msg);
645
646 /**
647 * Gets the source camera index.
648 *
649 * @public @memberof GoProfileMsg
650 * @version Introduced in firmware 4.1.3.106
651 * @param msg Message object.
652 * @return Camera index (0 - Front camera, 1 - Back camera).
653 */
654 GoFx(k8u) GoProfileIntensityMsg_CameraIndex(GoProfileMsg msg);
655
656 /// @endcond
657
658 /// @cond (Gocator_2x00 || Gocator_3x00)
659 /**
660 * @class GoSurfaceMsg
661 * @extends GoDataMsg
662 * @ingroup GoSdk-DataChannel
663 * @brief Represents a data message containing a surface array.
664 */
665 typedef GoDataMsg GoSurfaceMsg;
666
667 /**
668 * Gets the profile source.
669 *
670 * @public @memberof GoSurfaceMsg
671 * @version Introduced in firmware 4.0.10.27
672 * @param msg Message object.
673 * @return Profile source.
674 */
675 GoFx(GoDataSource) GoSurfaceMsg_Source(GoSurfaceMsg msg);
676
677 /**
678 * Gets the length of the surface (row count).
679 *
680 * @public @memberof GoSurfaceMsg
681 * @version Introduced in firmware 4.0.10.27
682 * @param msg Message object.
683 * @return Surface length.
684 */
685 GoFx(kSize) GoSurfaceMsg_Length(GoSurfaceMsg msg);
686
687 /**
688 * Gets the width of the surface (column count).
689 *
690 * @public @memberof GoSurfaceMsg
691 * @version Introduced in firmware 4.0.10.27
692 * @param msg Message object.
693 * @return Surface width;
694 */
695 GoFx(kSize) GoSurfaceMsg_Width(GoSurfaceMsg msg);
696
697 /**
698 * Gets the surface x-resolution, in nanometers.
699 *
700 * @public @memberof GoSurfaceMsg
701 * @version Introduced in firmware 4.0.10.27
702 * @param msg Message object.
703 * @return X resolution (nm).
704 */
705 GoFx(k32u) GoSurfaceMsg_XResolution(GoSurfaceMsg msg);
706
707 /**
708 * Gets the surface y-resolution, in nanometers.
709 *
710 * @public @memberof GoSurfaceMsg
711 * @version Introduced in firmware 4.0.10.27
712 * @param msg Message object.
713 * @return Y resolution (nm).
714 */
715 GoFx(k32u) GoSurfaceMsg_YResolution(GoSurfaceMsg msg);
716
717 /**
718 * Gets the surface z-resolution, in nanometers.
719 *
720 * @public @memberof GoSurfaceMsg
721 * @version Introduced in firmware 4.0.10.27
722 * @param msg Message object.
723 * @return Z resolution (nm).
724 */
725 GoFx(k32u) GoSurfaceMsg_ZResolution(GoSurfaceMsg msg);
726
727 /**
728 * Gets the surface x-offset, in micrometers.
729 *
730 * @public @memberof GoSurfaceMsg
731 * @version Introduced in firmware 4.0.10.27
732 * @param msg Message object.
733 * @return X offset (um).
734 */
735 GoFx(k32s) GoSurfaceMsg_XOffset(GoSurfaceMsg msg);
736
737 /**
738 * Gets the surface y-offset, in micrometers.
739 *
740 * @public @memberof GoSurfaceMsg
741 * @version Introduced in firmware 4.0.10.27
742 * @param msg Message object.
743 * @return Y offset (um).
744 */
745 GoFx(k32s) GoSurfaceMsg_YOffset(GoSurfaceMsg msg);
746
747 /**
748 * Gets the surface z-offset, in micrometers.
749 *
750 * @public @memberof GoSurfaceMsg
751 * @version Introduced in firmware 4.0.10.27
752 * @param msg Message object.
753 * @return Z offset (um).
754 */
755 GoFx(k32s) GoSurfaceMsg_ZOffset(GoSurfaceMsg msg);
756
757 /**
758 * Gets the surface z-angle, in microdegrees.
759 *
760 * @public @memberof GoSurfaceMsg
761 * @version Introduced in firmware 4.1.3.106
762 * @param msg Message object.
763 * @return Z angle (microdegrees).
764 */
765 GoFx(k32s) GoSurfaceMsg_ZAngle(GoSurfaceMsg msg);
766
767 /**
768 * Gets the surface ID.
769 *
770 * @public @memberof GoSurfaceMsg
771 * @version Introduced in firmware 4.0.10.27
772 * @param msg Message object.
773 * @return Surface ID.
774 */
775 GoFx(k32u) GoSurfaceMsg_SurfaceId(GoSurfaceMsg msg);
776
777 /**
778 * Gets a pointer to a surface row.
779 *
780 * @public @memberof GoSurfaceMsg
781 * @version Introduced in firmware 4.0.10.27
782 * @param msg Message object.
783 * @param index Surface row index.
784 * @return Row pointer.
785 */
786 GoFx(k16s*) GoSurfaceMsg_RowAt(GoSurfaceMsg msg, kSize index);
787
788 /**
789 * Gets the exposure.
790 *
791 * @public @memberof GoSurfaceMsg
792 * @version Introduced in firmware 4.0.10.27
793 * @param msg Message object.
794 * @return Exposure in uS.
795 */
796 GoFx(k32u) GoSurfaceMsg_Exposure(GoSurfaceMsg msg);
797
798 /**
799 * @class GoSurfaceIntensityMsg
800 * @extends GoDataMsg
801 * @ingroup GoSdk-DataChannel
802 * @brief Represents a data message containing a surface intensity array.
803 */
804 typedef GoDataMsg GoSurfaceIntensityMsg;
805
806 /**
807 * Gets the profile source.
808 *
809 * @public @memberof GoSurfaceIntensityMsg
810 * @version Introduced in firmware 4.0.10.27
811 * @param msg Message object.
812 * @return Profile source.
813 */
814 GoFx(GoDataSource) GoSurfaceIntensityMsg_Source(GoSurfaceIntensityMsg msg);
815
816 /**
817 * Gets the length of the surface (row count).
818 *
819 * @public @memberof GoSurfaceIntensityMsg
820 * @version Introduced in firmware 4.0.10.27
821 * @param msg Message object.
822 * @return Surface length.
823 */
824 GoFx(kSize) GoSurfaceIntensityMsg_Length(GoSurfaceIntensityMsg msg);
825
826 /**
827 * Gets the width of the surface (column count).
828 *
829 * @public @memberof GoSurfaceIntensityMsg
830 * @version Introduced in firmware 4.0.10.27
831 * @param msg Message object.
832 * @return Surface width;
833 */
834 GoFx(kSize) GoSurfaceIntensityMsg_Width(GoSurfaceIntensityMsg msg);
835
836 /**
837 * Gets the surface x-resolution, in nanometers.
838 *
839 * @public @memberof GoSurfaceIntensityMsg
840 * @version Introduced in firmware 4.0.10.27
841 * @param msg Message object.
842 * @return X resolution (nm).
843 */
844 GoFx(k32u) GoSurfaceIntensityMsg_XResolution(GoSurfaceIntensityMsg msg);
845
846 /**
847 * Gets the surface y-resolution, in nanometers.
848 *
849 * @public @memberof GoSurfaceIntensityMsg
850 * @version Introduced in firmware 4.0.10.27
851 * @param msg Message object.
852 * @return Y resolution (nm).
853 */
854 GoFx(k32u) GoSurfaceIntensityMsg_YResolution(GoSurfaceIntensityMsg msg);
855
856 /**
857 * Gets the surface x-offset, in micrometers.
858 *
859 * @public @memberof GoSurfaceIntensityMsg
860 * @version Introduced in firmware 4.0.10.27
861 * @param msg Message object.
862 * @return X offset (um).
863 */
864 GoFx(k32s) GoSurfaceIntensityMsg_XOffset(GoSurfaceIntensityMsg msg);
865
866 /**
867 * Gets the surface y-offset, in micrometers.
868 *
869 * @public @memberof GoSurfaceIntensityMsg
870 * @version Introduced in firmware 4.0.10.27
871 * @param msg Message object.
872 * @return Y offset (um).
873 */
874 GoFx(k32s) GoSurfaceIntensityMsg_YOffset(GoSurfaceIntensityMsg msg);
875
876 /**
877 * Gets the surface ID.
878 *
879 * @public @memberof GoSurfaceIntensityMsg
880 * @version Introduced in firmware 4.0.10.27
881 * @param msg Message object.
882 * @return Surface ID.
883 */
884 GoFx(k32s) GoSurfaceIntensityMsg_SurfaceId(GoSurfaceIntensityMsg msg);
885
886 /**
887 * Gets a pointer to a surface intensity row.
888 *
889 * @public @memberof GoSurfaceIntensityMsg
890 * @version Introduced in firmware 4.0.10.27
891 * @param msg Message object.
892 * @param index Surface intensity row index.
893 * @return Data pointer.
894 */
895 GoFx(k8u*) GoSurfaceIntensityMsg_RowAt(GoSurfaceIntensityMsg msg, kSize index);
896
897 /**
898 * Gets the exposure.
899 *
900 * @public @memberof GoSurfaceIntensityMsg
901 * @version Introduced in firmware 4.0.10.27
902 * @param msg Message object.
903 * @return Exposure in uS.
904 */
905 GoFx(k32u) GoSurfaceIntensityMsg_Exposure(GoSurfaceIntensityMsg msg);
906
907 /// @endcond
908
909
910 /**
911 * @struct GoMeasurementData
912 * @extends kValue
913 * @ingroup GoSdk-DataChannel
914 * @brief Represents a measurement result.
915 */
916 typedef struct GoMeasurementData
917 {
918 k64f value; ///< Measurement value.
919 GoDecision decision; ///< Measurement decision value.
920 GoDecisionCode decisionCode; ///< Measurement decision code - relevant only when the value represents a failure.
921 } GoMeasurementData;
922
923 /**
924 * Gets the measurement data value.
925 *
926 * @public @memberof GoMeasurementData
927 * @version Introduced in firmware 4.2.4.7
928 * @param data Data object.
929 * @return Measurement value.
930 */
931 GoFx(k64f) GoMeasurementData_Value(GoMeasurementData data);
932
933 /**
934 * Gets the measurement data decision.
935 *
936 * @public @memberof GoMeasurementData
937 * @version Introduced in firmware 4.2.4.7
938 * @param data Data object.
939 * @return Measurement decision.
940 */
941 GoFx(GoDecision) GoMeasurementData_Decision(GoMeasurementData data);
942
943 /**
944 * Gets the measurement decision code.
945 *
946 * @public @memberof GoMeasurementData
947 * @version Introduced in firmware 4.2.4.7
948 * @param data Data object.
949 * @return Measurement decision code.
950 */
951 GoFx(GoDecisionCode) GoMeasurementData_DecisionCode(GoMeasurementData data);
952
953
954 /**
955 * @class GoMeasurementMsg
956 * @extends GoDataMsg
957 * @ingroup GoSdk-DataChannel
958 * @brief Represents a message containing a set of GoMeasurementData.
959 */
960 typedef GoDataMsg GoMeasurementMsg;
961
962 /**
963 * Gets the measurement identifier.
964 *
965 * @public @memberof GoMeasurementMsg
966 * @version Introduced in firmware 4.0.10.27
967 * @param msg Message object.
968 * @return Measurement identifier.
969 */
970 GoFx(k16u) GoMeasurementMsg_Id(GoMeasurementMsg msg);
971
972 /**
973 * Count of measurements in this message.
974 *
975 * @public @memberof GoMeasurementMsg
976 * @version Introduced in firmware 4.0.10.27
977 * @param msg Message object.
978 * @return Count of measurements.
979 */
980 GoFx(kSize) GoMeasurementMsg_Count(GoMeasurementMsg msg);
981
982 /**
983 * Gets the measurement at the specified index.
984 *
985 * @public @memberof GoMeasurementMsg
986 * @version Introduced in firmware 4.0.10.27
987 * @param msg Message object.
988 * @param index Measurement index.
989 * @return Measurement pointer.
990 */
991 GoFx(GoMeasurementData*) GoMeasurementMsg_At(GoMeasurementMsg msg, kSize index);
992
993
994 /**
995 * @class GoAlignMsg
996 * @extends GoDataMsg
997 * @ingroup GoSdk-DataChannel
998 * @brief Represents a message containing an alignment result.
999 */
1000 typedef GoDataMsg GoAlignMsg;
1001
1002 /**
1003 * Gets the alignment result.
1004 *
1005 * @public @memberof GoAlignMsg
1006 * @version Introduced in firmware 4.0.10.27
1007 * @param msg Message object.
1008 * @return Alignment result.
1009 */
1010 GoFx(kStatus) GoAlignMsg_Status(GoAlignMsg msg);
1011
1012 /**
1013 * @class GoExposureCalMsg
1014 * @extends GoDataMsg
1015 * @ingroup GoSdk-DataChannel
1016 * @brief Represents a message containing exposure calibration results.
1017 */
1018 typedef GoDataMsg GoExposureCalMsg;
1019
1020 /**
1021 * Gets the exposure calibration result.
1022 *
1023 * @public @memberof GoExposureCalMsg
1024 * @version Introduced in firmware 4.0.10.27
1025 * @param msg Message object.
1026 * @return Exposure calibration result.
1027 */
1028 GoFx(kStatus) GoExposureCalMsg_Status(GoExposureCalMsg msg);
1029
1030 /**
1031 * Gets the calibrated exposure.
1032 *
1033 * @public @memberof GoExposureCalMsg
1034 * @version Introduced in firmware 4.0.10.27
1035 * @param msg Message object.
1036 * @return Calibrated exposure value in uS.
1037 */
1038 GoFx(k32u) GoExposureCalMsg_Exposure(GoExposureCalMsg msg);
1039
1040
1041 /**
1042 * @class GoEdgeMatchMsg
1043 * @extends GoDataMsg
1044 * @ingroup GoSdk-DataChannel
1045 * @brief Represents a message containing edge based part matching results.
1046 */
1047 typedef GoDataMsg GoEdgeMatchMsg;
1048
1049 /**
1050 * Gets the edge match decision.
1051 *
1052 * @public @memberof GoEdgeMatchMsg
1053 * @version Introduced in firmware 4.2.4.7
1054 * @param msg Message object.
1055 * @return Edge match decision.
1056 */
1057 GoFx(k8u) GoEdgeMatchMsg_Decision(GoEdgeMatchMsg msg);
1058
1059 /**
1060 * Gets the edge match X offset.
1061 *
1062 * @public @memberof GoEdgeMatchMsg
1063 * @version Introduced in firmware 4.2.4.7
1064 * @param msg Message object.
1065 * @return Edge match X offset.
1066 */
1067 GoFx(k64f) GoEdgeMatchMsg_XOffset(GoEdgeMatchMsg msg);
1068
1069 /**
1070 * Gets the edge match Y offset.
1071 *
1072 * @public @memberof GoEdgeMatchMsg
1073 * @version Introduced in firmware 4.2.4.7
1074 * @param msg Message object.
1075 * @return Edge match Y offset.
1076 */
1077 GoFx(k64f) GoEdgeMatchMsg_YOffset(GoEdgeMatchMsg msg);
1078
1079 /**
1080 * Gets the edge match Z angle.
1081 *
1082 * @public @memberof GoEdgeMatchMsg
1083 * @version Introduced in firmware 4.2.4.7
1084 * @param msg Message object.
1085 * @return Edge match Z angle.
1086 */
1087 GoFx(k64f) GoEdgeMatchMsg_ZAngle(GoEdgeMatchMsg msg);
1088
1089 /**
1090 * Gets the edge match quality value.
1091 *
1092 * @public @memberof GoEdgeMatchMsg
1093 * @version Introduced in firmware 4.2.4.7
1094 * @param msg Message object.
1095 * @return Edge match quality value.
1096 */
1097 GoFx(k64f) GoEdgeMatchMsg_QualityValue(GoEdgeMatchMsg msg);
1098
1099 /**
1100 * Gets the edge match quality decision.
1101 *
1102 * @public @memberof GoEdgeMatchMsg
1103 * @version Introduced in firmware 4.2.4.7
1104 * @param msg Message object.
1105 * @return Edge match quality decision.
1106 */
1107 GoFx(k8u) GoEdgeMatchMsg_QualityDecision(GoEdgeMatchMsg msg);
1108
1109
1110 /**
1111 * @class GoEllipseMatchMsg
1112 * @extends GoDataMsg
1113 * @ingroup GoSdk-DataChannel
1114 * @brief Represents a message containing ellipse based part matching results.
1115 */
1116 typedef GoDataMsg GoEllipseMatchMsg;
1117
1118 /**
1119 * Gets the ellipse match decision.
1120 *
1121 * @public @memberof GoEllipseMatchMsg
1122 * @version Introduced in firmware 4.2.4.7
1123 * @param msg Message object.
1124 * @return Ellipse match quality decision.
1125 */
1126 GoFx(k8u) GoEllipseMatchMsg_Decision(GoEllipseMatchMsg msg);
1127
1128 /**
1129 * Gets the ellipse match X offset.
1130 *
1131 * @public @memberof GoEllipseMatchMsg
1132 * @version Introduced in firmware 4.2.4.7
1133 * @param msg Message object.
1134 * @return Ellipse match X offset.
1135 */
1136 GoFx(k64f) GoEllipseMatchMsg_XOffset(GoEllipseMatchMsg msg);
1137
1138 /**
1139 * Gets the ellipse match Y offset.
1140 *
1141 * @public @memberof GoEllipseMatchMsg
1142 * @version Introduced in firmware 4.2.4.7
1143 * @param msg Message object.
1144 * @return Ellipse match Y offset.
1145 */
1146 GoFx(k64f) GoEllipseMatchMsg_YOffset(GoEllipseMatchMsg msg);
1147
1148 /**
1149 * Gets the ellipse match Z angle.
1150 *
1151 * @public @memberof GoEllipseMatchMsg
1152 * @version Introduced in firmware 4.2.4.7
1153 * @param msg Message object.
1154 * @return Ellipse match Z angle.
1155 */
1156 GoFx(k64f) GoEllipseMatchMsg_ZAngle(GoEllipseMatchMsg msg);
1157
1158 /**
1159 * Gets the ellipse match minor value.
1160 *
1161 * @public @memberof GoEllipseMatchMsg
1162 * @version Introduced in firmware 4.2.4.7
1163 * @param msg Message object.
1164 * @return Ellipse match minor value.
1165 */
1166 GoFx(k64f) GoEllipseMatchMsg_MinorValue(GoEllipseMatchMsg msg);
1167
1168 /**
1169 * Gets the ellipse match minor decision.
1170 *
1171 * @public @memberof GoEllipseMatchMsg
1172 * @version Introduced in firmware 4.2.4.7
1173 * @param msg Message object.
1174 * @return Ellipse match minor decision.
1175 */
1176 GoFx(k8u) GoEllipseMatchMsg_MinorDecision(GoEllipseMatchMsg msg);
1177
1178 /**
1179 * Gets the ellipse match major value.
1180 *
1181 * @public @memberof GoEllipseMatchMsg
1182 * @version Introduced in firmware 4.2.4.7
1183 * @param msg Message object.
1184 * @return Ellipse match major value.
1185 */
1186 GoFx(k64f) GoEllipseMatchMsg_MajorValue(GoEllipseMatchMsg msg);
1187
1188 /**
1189 * Gets the ellipse match major decision.
1190 *
1191 * @public @memberof GoEllipseMatchMsg
1192 * @version Introduced in firmware 4.2.4.7
1193 * @param msg Message object.
1194 * @return Ellipse match major decision.
1195 */
1196 GoFx(k8u) GoEllipseMatchMsg_MajorDecision(GoEllipseMatchMsg msg);
1197
1198
1199 /**
1200 * @class GoBoundingBoxMatchMsg
1201 * @extends GoDataMsg
1202 * @ingroup GoSdk-DataChannel
1203 * @brief Represents a message containing bounding box based part matching results.
1204 */
1205 typedef GoDataMsg GoBoundingBoxMatchMsg;
1206
1207 /**
1208 * Gets the bounding box match major value.
1209 *
1210 * @public @memberof GoBoundingBoxMatchMsg
1211 * @version Introduced in firmware 4.2.4.7
1212 * @param msg Message object.
1213 * @return Bounding box match major value.
1214 */
1215 GoFx(k8u) GoBoundingBoxMatchMsg_Decision(GoBoundingBoxMatchMsg msg);
1216
1217 /**
1218 * Gets the bounding box match X offset.
1219 *
1220 * @public @memberof GoBoundingBoxMatchMsg
1221 * @version Introduced in firmware 4.2.4.7
1222 * @param msg Message object.
1223 * @return Bounding box match X offset.
1224 */
1225 GoFx(k64f) GoBoundingBoxMatchMsg_XOffset(GoBoundingBoxMatchMsg msg);
1226
1227 /**
1228 * Gets the bounding box match Y offset.
1229 *
1230 * @public @memberof GoBoundingBoxMatchMsg
1231 * @version Introduced in firmware 4.2.4.7
1232 * @param msg Message object.
1233 * @return Bounding box match Y offset.
1234 */
1235 GoFx(k64f) GoBoundingBoxMatchMsg_YOffset(GoBoundingBoxMatchMsg msg);
1236
1237 /**
1238 * Gets the bounding box match Z angle.
1239 *
1240 * @public @memberof GoBoundingBoxMatchMsg
1241 * @version Introduced in firmware 4.2.4.7
1242 * @param msg Message object.
1243 * @return Bounding box match Z angle.
1244 */
1245 GoFx(k64f) GoBoundingBoxMatchMsg_ZAngle(GoBoundingBoxMatchMsg msg);
1246
1247 /**
1248 * Gets the bounding box match length value.
1249 *
1250 * @public @memberof GoBoundingBoxMatchMsg
1251 * @version Introduced in firmware 4.2.4.7
1252 * @param msg Message object.
1253 * @return Bounding box match length value.
1254 */
1255 GoFx(k64f) GoBoundingBoxMatchMsg_LengthValue(GoBoundingBoxMatchMsg msg);
1256
1257 /**
1258 * Gets the bounding box match length decision.
1259 *
1260 * @public @memberof GoBoundingBoxMatchMsg
1261 * @version Introduced in firmware 4.2.4.7
1262 * @param msg Message object.
1263 * @return Bounding box match length decision.
1264 */
1265 GoFx(k8u) GoBoundingBoxMatchMsg_LengthDecision(GoBoundingBoxMatchMsg msg);
1266
1267 /**
1268 * Gets the bounding box match width value.
1269 *
1270 * @public @memberof GoBoundingBoxMatchMsg
1271 * @version Introduced in firmware 4.2.4.7
1272 * @param msg Message object.
1273 * @return Bounding box match width value.
1274 */
1275 GoFx(k64f) GoBoundingBoxMatchMsg_WidthValue(GoBoundingBoxMatchMsg msg);
1276
1277 /**
1278 * Gets the bounding box match width decision.
1279 *
1280 * @public @memberof GoBoundingBoxMatchMsg
1281 * @version Introduced in firmware 4.2.4.7
1282 * @param msg Message object.
1283 * @return Bounding box match width decision.
1284 */
1285 GoFx(k8u) GoBoundingBoxMatchMsg_WidthDecision(GoBoundingBoxMatchMsg msg);
1286
1287 kEndHeader()
1288 #include <GoSdk/Messages/GoDataTypes.x.h>
1289
1290 #endif
GoStamp
Represents an acquisition stamp.
Definition: GoDataTypes.h:40
k32u
GoStampMsg::GoStampMsg_At
GoStamp * GoStampMsg_At(GoStampMsg msg, kSize index)
Gets the stamp at the specified index.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_Exposure
k32u GoSurfaceIntensityMsg_Exposure(GoSurfaceIntensityMsg msg)
Gets the exposure.
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:919
GoVideoMsg::GoVideoMsg_Width
kSize GoVideoMsg_Width(GoVideoMsg msg)
Gets the image width, in pixels.
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.
GoProfileMsg::GoProfileIntensityMsg_CameraIndex
k8u GoProfileIntensityMsg_CameraIndex(GoProfileMsg msg)
Gets the source camera index.
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.
GoProfileMsg::GoProfileMsg_Exposure
k32u GoProfileMsg_Exposure(GoProfileMsg msg)
Gets the exposure.
GoVideoMsg
Represents a data message containing a video image.
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.
GoEdgeMatchMsg
Represents a message containing edge based part matching results.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_YOffset
k32s GoSurfaceIntensityMsg_YOffset(GoSurfaceIntensityMsg msg)
Gets the surface y-offset, in micrometers.
GoDecisionCode
Represents the possible measurement decision codes.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_SurfaceId
k32s GoSurfaceIntensityMsg_SurfaceId(GoSurfaceIntensityMsg msg)
Gets the surface ID.
GoEllipseMatchMsg::GoEllipseMatchMsg_Decision
k8u GoEllipseMatchMsg_Decision(GoEllipseMatchMsg msg)
Gets the ellipse match decision.
GoProfileIntensityMsg::GoProfileIntensityMsg_Exposure
k32u GoProfileIntensityMsg_Exposure(GoProfileIntensityMsg msg)
Gets the exposure.
k16u
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_Width
kSize GoSurfaceIntensityMsg_Width(GoSurfaceIntensityMsg msg)
Gets the width of the surface (column count).
GoResampledProfileMsg
Represents a data message containing a set of re-sampled profile arrays.
kSize
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_Length
kSize GoSurfaceIntensityMsg_Length(GoSurfaceIntensityMsg msg)
Gets the length of the surface (row count).
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.
GoProfileMsg::GoProfileMsg_Width
kSize GoProfileMsg_Width(GoProfileMsg msg)
Gets the count of ranges in each profile array.
GoDataSource
Represents a data source.
k8u
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.
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.
GoProfileMsg::GoProfileMsg_ZResolution
k32u GoProfileMsg_ZResolution(GoProfileMsg msg)
Gets the profile z-resolution, in nanometers.
GoStamp::timestamp
k64u timestamp
Timestamp in internal units approximating nanoseconds where the true time in ns = timestamp value / 1...
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.
GoSurfaceMsg
Represents a data message containing a surface array.
GoSurfaceMsg::GoSurfaceMsg_XResolution
k32u GoSurfaceMsg_XResolution(GoSurfaceMsg msg)
Gets the surface x-resolution, in nanometers.
GoVideoMsg::GoVideoMsg_Exposure
k32u GoVideoMsg_Exposure(GoVideoMsg msg)
Gets the exposure.
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.
GoSurfaceMsg::GoSurfaceMsg_SurfaceId
k32u GoSurfaceMsg_SurfaceId(GoSurfaceMsg msg)
Gets the surface ID.
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.
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.
GoStamp::status
k64u status
Bit mask containing frame information:
Definition: GoDataTypes.h:46
GoSdkDef.h
Essential SDK declarations.
GoProfileIntensityMsg::GoProfileIntensityMsg_Width
kSize GoProfileIntensityMsg_Width(GoProfileIntensityMsg msg)
Gets the count of intensity values in each profile intensity array.
GoSurfaceMsg::GoSurfaceMsg_Width
kSize GoSurfaceMsg_Width(GoSurfaceMsg msg)
Gets the width of the surface (column count).
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_RowAt
k8u * GoSurfaceIntensityMsg_RowAt(GoSurfaceIntensityMsg msg, kSize index)
Gets a pointer to a surface intensity row.
GoProfileMsg::GoProfileMsg_Count
kSize GoProfileMsg_Count(GoProfileMsg msg)
Gets the count of profile arrays in this message.
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.
GoPixelType
Represents a video message pixel type.
GoProfileIntensityMsg
Represents a data message containing a set of profile intensity arrays.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_YResolution
k32u GoSurfaceIntensityMsg_YResolution(GoSurfaceIntensityMsg msg)
Gets the surface y-resolution, in nanometers.
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.
GoEdgeMatchMsg::GoEdgeMatchMsg_QualityDecision
k8u GoEdgeMatchMsg_QualityDecision(GoEdgeMatchMsg msg)
Gets the edge match quality decision.
GoExposureCalMsg::GoExposureCalMsg_Exposure
k32u GoExposureCalMsg_Exposure(GoExposureCalMsg msg)
Gets the calibrated exposure.
GoDataMessageType
Lists all data message types.
GoMeasurementMsg::GoMeasurementMsg_Count
kSize GoMeasurementMsg_Count(GoMeasurementMsg msg)
Count of measurements in this message.
GoResampledProfileMsg::GoResampledProfileMsg_ZResolution
k32u GoResampledProfileMsg_ZResolution(GoResampledProfileMsg msg)
Gets the profile z-resolution, in nanometers.
GoSurfaceMsg::GoSurfaceMsg_Source
GoDataSource GoSurfaceMsg_Source(GoSurfaceMsg msg)
Gets the profile source.
GoBoundingBoxMatchMsg::GoBoundingBoxMatchMsg_LengthValue
k64f GoBoundingBoxMatchMsg_LengthValue(GoBoundingBoxMatchMsg msg)
Gets the bounding box match length value.
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.
GoMeasurementData::decisionCode
GoDecisionCode decisionCode
Measurement decision code - relevant only when the value represents a failure.
Definition: GoDataTypes.h:920
GoEllipseMatchMsg::GoEllipseMatchMsg_MinorValue
k64f GoEllipseMatchMsg_MinorValue(GoEllipseMatchMsg msg)
Gets the ellipse match minor value.
GoProfileMsg
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:918
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.
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
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
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.
GoResampledProfileMsg::GoResampledProfileMsg_At
k16s * GoResampledProfileMsg_At(GoResampledProfileMsg msg, kSize index)
Gets a pointer to a re-sampled profile array.
kCfa
GoProfileIntensityMsg::GoProfileIntensityMsg_IsResampled
kBool GoProfileIntensityMsg_IsResampled(GoProfileIntensityMsg msg)
Gets the associated profile type (points or ranges).
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.
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.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_Source
GoDataSource GoSurfaceIntensityMsg_Source(GoSurfaceIntensityMsg msg)
Gets the profile source.
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.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_XResolution
k32u GoSurfaceIntensityMsg_XResolution(GoSurfaceIntensityMsg msg)
Gets the surface x-resolution, in nanometers.
GoEdgeMatchMsg::GoEdgeMatchMsg_Decision
k8u GoEdgeMatchMsg_Decision(GoEdgeMatchMsg msg)
Gets the edge match decision.
GoSurfaceIntensityMsg
Represents a data message containing a surface intensity array.
GoEllipseMatchMsg::GoEllipseMatchMsg_MinorDecision
k8u GoEllipseMatchMsg_MinorDecision(GoEllipseMatchMsg msg)
Gets the ellipse match minor decision.
GoExposureCalMsg::GoExposureCalMsg_Status
kStatus GoExposureCalMsg_Status(GoExposureCalMsg msg)
Gets the exposure calibration result.
GoSurfaceIntensityMsg::GoSurfaceIntensityMsg_XOffset
k32s GoSurfaceIntensityMsg_XOffset(GoSurfaceIntensityMsg msg)
Gets the surface x-offset, in micrometers.
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
GoMeasurementData
Represents a measurement result.
Definition: GoDataTypes.h:916
GoProfileMsg::GoProfileMsg_Source
GoDataSource GoProfileMsg_Source(GoProfileMsg msg)
Gets the profile source.
GoSurfaceMsg::GoSurfaceMsg_ZAngle
k32s GoSurfaceMsg_ZAngle(GoSurfaceMsg msg)
Gets the surface z-angle, in microdegrees.