Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSetup.h
Go to the documentation of this file.
1 /**
2 * @file GoSetup.h
3 * @brief Declares the GoSetup class.
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_SETUP_H
11 #define GO_SDK_SETUP_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoLayout.h>
15 #include <GoSdk/GoAdvanced.h>
16 #include <GoSdk/GoMaterial.h>
17 #include <GoSdk/GoProfileGeneration.h>
18 #include <GoSdk/GoSurfaceGeneration.h>
19 #include <GoSdk/GoPartDetection.h>
20 #include <GoSdk/GoPartMatching.h>
21 #include <GoSdk/GoSections.h>
22 #include <GoSdk/GoTracheid.h>
23
24 kBeginHeader()
25
26 /**
27 * @class GoSetup
28 * @extends kObject
29 * @ingroup GoSdk
30 * @brief Represents a device configuration.
31 */
32 typedef kObject GoSetup;
33
34
35 /**
36 * This API is experimental and may change in a future release
37 * Enables the trigger burst.
38 *
39 * @public @memberof GoSetup
40 * @version Introduced in firmware 4.8.2.76
41 * @param setup GoSetup object.
42 * @param enable enable state.
43 * @return Operation status.
44 */
45 GoFx(kStatus) GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable);
46
47 /**
48 * This API is experimental and may change in a future release
49 * Gets the trigger burst enabled state.
50 *
51 * @public @memberof GoSetup
52 * @version Introduced in firmware 4.8.2.76
53 * @param setup GoSetup object.
54 * @return Operation status.
55 */
56 GoFx(kBool) GoSetup_TriggerBurstEnabled(GoSetup setup);
57
58 /**
59 * This API is experimental and may change in a future release
60 * Gets the trigger burst enabled state.
61 *
62 * @public @memberof GoSetup
63 * @version Introduced in firmware 4.8.2.76
64 * @param setup GoSetup object.
65 * @return Operation status.
66 */
67 GoFx(kBool) GoSetup_TriggerBurstEnabledUsed(GoSetup setup);
68
69
70 /**
71 * This API is experimental and may change in a future release
72 * Gets the trigger burst count.
73 *
74 * @public @memberof GoSetup
75 * @version Introduced in firmware 4.8.2.76
76 * @param setup GoSetup object.
77 * @return Burst count.
78 */
79 GoFx(k32u) GoSetup_TriggerBurstCount(GoSetup setup);
80
81 /**
82 * This API is experimental and may change in a future release
83 * Sets the trigger burst count.
84 *
85 * @public @memberof GoSetup
86 * @version Introduced in firmware 4.8.2.76
87 * @param setup GoSetup object.
88 * @param count Burst count.
89 * @return Operation status.
90 */
91 GoFx(kStatus) GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count);
92
93 /**
94 * This API is experimental and may change in a future release
95 * Gets the trigger burst used value.
96 *
97 * @public @memberof GoSetup
98 * @version Introduced in firmware 4.8.2.76
99 * @param setup GoSetup object.
100 * @return Operation status.
101 */
102 GoFx(kBool) GoSetup_TriggerBurstCountUsed(GoSetup setup);
103
104 /**
105 * This API is experimental and may change in a future release
106 * Gets the laser sleep mode used value
107 *
108 * @public @memberof GoSetup
109 * @version Introduced in firmware 4.8.2.76
110 * @param setup GoSetup object.
111 * @return Operation status.
112 */
113 GoFx(kBool) GoSetup_LaserSleepUsed(GoSetup setup);
114
115 /**
116 * This API is experimental and may change in a future release
117 * Enables laser sleep mode
118 *
119 * @public @memberof GoSetup
120 * @version Introduced in firmware 4.8.2.76
121 * @param setup GoSetup object.
122 * @param enable enable state
123 * @return Operation status.
124 */
125 GoFx(kStatus) GoSetup_SetLaserSleepModeEnabled(GoSetup setup, kBool enable);
126
127 /**
128 * This API is experimental and may change in a future release
129 * Gets the laser sleep mode enabled state.
130 *
131 * @public @memberof GoSetup
132 * @version Introduced in firmware 4.8.2.76
133 * @param setup GoSetup object.
134 * @return Operation status.
135 */
136 GoFx(kBool) GoSetup_LaserSleepModeEnabled(GoSetup setup);
137
138 /**
139 * This API is experimental and may change in a future release
140 * Sets the time before the laser deactivates
141 *
142 * @public @memberof GoSetup
143 * @version Introduced in firmware 4.8.2.76
144 * @param setup GoSetup object.
145 * @param time idle time. (microseconds)
146 * @return Operation status.
147 */
148 GoFx(kStatus) GoSetup_SetLaserIdleTime(GoSetup setup, k64u time);
149
150 /**
151 * This API is experimental and may change in a future release
152 * Gets the idle time before laser deactivation
153 *
154 * @public @memberof GoSetup
155 * @version Introduced in firmware 4.8.2.76
156 * @param setup GoSetup object.
157 * @return Operation status.
158 */
159 GoFx(k64u) GoSetup_LaserIdleTime(GoSetup setup);
160
161 /**
162 * This API is experimental and may change in a future release
163 * Sets the encoder wakeup travel distance
164 *
165 * @public @memberof GoSetup
166 * @version Introduced in firmware 4.8.2.76
167 * @param setup GoSetup object.
168 * @param distance distance (mm)
169 * @return Operation status.
170 */
171 GoFx(kStatus) GoSetup_SetLaserWakeupEncoderTravel(GoSetup setup, k64u distance);
172
173 /**
174 * This API is experimental and may change in a future release
175 * Gets the encoder wakeup travel distance
176 *
177 * @public @memberof GoSetup
178 * @version Introduced in firmware 4.8.2.76
179 * @param setup GoSetup object.
180 * @return Operation status.
181 */
182 GoFx(k64u) GoSetup_LaserWakeupEncoderTravel(GoSetup setup);
183
184 /**
185 * This API is experimental and may change in a future release
186 * Returns whether or not auto encoder reversal distance can be enabled.
187 *
188 * @public @memberof GoSetup
189 * @version Introduced in firmware 4.8.2.76
190 * @param setup GoSetup object.
191 * @return Used flag.
192 */
193 GoFx(kBool) GoSetup_ReversalDistanceAutoEnabledUsed(GoSetup setup);
194
195 /**
196 * This API is experimental and may change in a future release
197 * Returns whether or not auto encoder reversal distance is enabled.
198 *
199 * @public @memberof GoSetup
200 * @version Introduced in firmware 4.8.2.76
201 * @param setup GoSetup object.
202 * @return Enabled status.
203 */
204 GoFx(kBool) GoSetup_ReversalDistanceAutoEnabled(GoSetup setup);
205
206 /**
207 * This API is experimental and may change in a future release
208 * Enables or disables auto encoder reversal distance.
209 *
210 * @public @memberof GoSetup
211 * @version Introduced in firmware 4.8.2.76
212 * @param setup GoSetup object.
213 * @param enabled Enabled flag.
214 * @return Operation status.
215 */
216 GoFx(kStatus) GoSetup_SetReversalDistanceAutoEnabled(GoSetup setup, kBool enabled);
217
218 /**
219 * This API is experimental and may change in a future release
220 * Gets the encoder reversal distance threshold used value
221 *
222 * @public @memberof GoSetup
223 * @version Introduced in firmware 4.8.2.76
224 * @param setup GoSetup object.
225 * @return Operation status.
226 */
227 GoFx(kBool) GoSetup_ReversalDistanceUsed(GoSetup setup);
228
229 /**
230 * This API is experimental and may change in a future release
231 * Sets the encoder reversal distance threshold
232 *
233 * @public @memberof GoSetup
234 * @version Introduced in firmware 4.8.2.76
235 * @param setup GoSetup object.
236 * @param threshold threshold for encoder reversal distance before switching directions (specified as multiple of the spacing interval)
237 * @return Operation status.
238 */
239 GoFx(kStatus) GoSetup_SetReversalDistance(GoSetup setup, k64f threshold);
240
241 /**
242 * This API is experimental and may change in a future release
243 * Gets the encoder reversal distance threshold.
244 *
245 * @public @memberof GoSetup
246 * @version Introduced in firmware 4.8.2.76
247 * @param setup GoSetup object.
248 * @return Operation status.
249 */
250 GoFx(k64f) GoSetup_ReversalDistance(GoSetup setup);
251
252 /**
253 * This API is experimental and may change in a future release
254 * Gets the encoder reversal distance threshold system value.
255 *
256 * @public @memberof GoSetup
257 * @version Introduced in firmware 4.8.2.76
258 * @param setup GoSetup object.
259 * @return Operation status.
260 */
261 GoFx(k64f) GoSetup_ReversalDistanceSystemValue(GoSetup setup);
262
263 /**
264 * Gets Multiplex bank used state
265 *
266 * @public @memberof GoSetup
267 * @version Introduced in firmware 4.0.10.27
268 * @param setup GoSetup object.
269 * @param role GoRole role.
270 * @return Operation status.
271 */
272 GoFx(kBool) GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role);
273
274 /**
275 * Gets Multiplex bank used state.
276 *
277 * @public @memberof GoSetup
278 * @version Introduced in firmware 4.0.10.27
279 * @param setup GoSetup object.
280 * @param role GoRole role.
281 * @return Operation status.
282 */
283 GoFx(k32s) GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role);
284
285 /**
286 * Gets layout grid used state.
287 *
288 * @public @memberof GoSetup
289 * @version Introduced in firmware 4.0.10.27
290 * @param setup GoSetup object.
291 * @param role GoRole role.
292 * @return Operation status.
293 */
294 GoFx(kBool) GoSetup_LayoutGridUsed(GoSetup setup, GoRole role);
295
296 /**
297 * Gets layout grid direction.
298 *
299 * @public @memberof GoSetup
300 * @version Introduced in firmware 4.0.10.27
301 * @param setup GoSetup object.
302 * @param role GoRole role.
303 * @return Operation status.
304 */
305 GoFx(k32s) GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role);
306
307 /**
308 * Gets layout grid column index.
309 *
310 * @public @memberof GoSetup
311 * @version Introduced in firmware 4.0.10.27
312 * @param setup GoSetup object.
313 * @param role GoRole role.
314 * @return Layout grid Column.
315 */
316 GoFx(k32s) GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role);
317
318 /**
319 * Gets layout grid row index.
320 *
321 * @public @memberof GoSetup
322 * @version Introduced in firmware 4.0.10.27
323 * @param setup GoSetup object.
324 * @param role GoRole role.
325 * @return Layout grid row.
326 */
327 GoFx(k32s) GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role);
328
329 /**
330 * Enables the temperature saftey of the sensor system.
331 *
332 * @public @memberof GoSetup
333 * @version Introduced in firmware 4.8.2.76
334 * @param setup GoSetup object.
335 * @param enable kBool.
336 * @return Operation status.
337 */
338 GoFx(kStatus) GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable);
339
340
341 /**
342 * Sets the scan mode.
343 *
344 * @public @memberof GoSetup
345 * @version Introduced in firmware 4.8.2.76
346 * @param setup GoSetup object.
347 * @param mode Operation mode.
348 * @return Operation status.
349 */
350 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
351
352 /**
353 * Gets the scan mode
354 *
355 * @public @memberof GoSetup
356 * @version Introduced in firmware 4.8.2.76
357 * @param setup GoSetup object.
358 * @return Operation mode.
359 */
360 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
361
362 /**
363 * Gets the scan mode option at the specified index.
364 *
365 * @public @memberof GoSetup
366 * @version Introduced in firmware 4.0.10.27
367 * @param setup GoSetup object.
368 * @param index The index with which to retrieve a mode option.
369 * @return Operation mode.
370 * @see GoSetup_ScanModeOptionCount
371 */
372 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, kSize index);
373
374 /**
375 * Gets the scan mode option count.
376 *
377 * @public @memberof GoSetup
378 * @version Introduced in firmware 4.0.10.27
379 * @param setup GoSetup object.
380 * @return Scan mode option count.
381 */
382 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
383
384 /// @cond Gocator_2x00
385
386 /**
387 * Gets the user specified Uniform Spacing enabled state.
388 *
389 * @public @memberof GoSetup
390 * @version Introduced in firmware 4.0.10.27
391 * @param setup GoSetup object.
392 * @return kTRUE if enabled and kFALSE otherwise.
393 * @see GoSetup_UniformSpacingAvailable
394 */
395 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
396
397 /**
398 * Sets the user specified Uniform Spacing enabled state.
399 *
400 * @public @memberof GoSetup
401 * @version Introduced in firmware 4.0.10.27
402 * @param setup GoSetup object.
403 * @param enable kTRUE to enable it and kFALSE to disable it.
404 * @return Operation status.
405 * @see GoSetup_UniformSpacingAvailable
406 */
407 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
408
409 /**
410 * Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used at the moment.
411 *
412 * @public @memberof GoSetup
413 * @version Introduced in firmware 4.0.10.27
414 * @param setup GoSetup object.
415 * @return kTRUE if the user specified Uniform Spacing setting is used and kFALSE otherwise.
416 */
417 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
418
419 /**
420 * Gets the Uniform Spacing enabled system value.
421 *
422 * @public @memberof GoSetup
423 * @version Introduced in firmware 4.0.10.27
424 * @param setup GoSetup object.
425 * @return kTRUE if enabled and kFALSE otherwise.
426 * @see GoSetup_UniformSpacingAvailable
427 */
428 GoFx(kBool) GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup);
429
430 /// @endcond
431
432 /**
433 * Sets the state of the external input triggered encoder Z-pulse feature.
434 *
435 * @public @memberof GoSetup
436 * @version Introduced in firmware 4.1.3.106
437 * @param setup GoSetup object.
438 * @param enable kTRUE to enable it and kFALSE to disable it.
439 * @return Operation status.
440 */
441 GoFx(kStatus) GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable);
442
443 /**
444 * Gets the state of the external input triggered encoder Z-pulse feature.
445 *
446 * @public @memberof GoSetup
447 * @version Introduced in firmware 4.1.3.106
448 * @param setup GoSetup object.
449 * @return kTRUE if enabled and kFALSE otherwise.
450 */
451 GoFx(kBool) GoSetup_ExternalInputZPulseEnabled(GoSetup setup);
452
453 /**
454 * Sets the external input index for triggering encoder Z-pulse.
455 *
456 * @public @memberof GoSetup
457 * @param setup GoSetup object.
458 * @param index Index of external input to use.
459 * @return Operation status.
460 */
461 GoFx(kStatus) GoSetup_SetExternalInputZPulseIndex(GoSetup setup, k32u index);
462
463 /**
464 * Gets the external input index for triggering encoder Z-pulse.
465 *
466 * @public @memberof GoSetup
467 * @param setup GoSetup object.
468 * @return Index of external input used.
469 */
470 GoFx(k32u) GoSetup_ExternalInputZPulseIndex(GoSetup setup);
471
472 /**
473 * Reports whether or not the external input index for encoder z-pulse triggering is used.
474 *
475 * @public @memberof GoSetup
476 * @param setup GoSetup object.
477 * @return Index is used or not.
478 */
479 GoFx(kBool) GoSetup_ExternalInputZPulseIndexAvailable(GoSetup setup);
480
481 /**
482 * Sets the state of the Gets the state of the Master time encoder.
483 *
484 * @public @memberof GoSetup
485 * @version Introduced in firmware 4.8.2.76
486 * @param setup GoSetup object.
487 * @param enable kBool kTrue to enable kFalse to disable.
488 * @return kStatus if enabling has been successful
489 */
490 GoFx(kStatus) GoSetup_EnablePreferMasterTimeEncoderEnabled(GoSetup setup, kBool enable);
491
492 /**
493 * Gets the state of the Master time encoder.
494 *
495 * @public @memberof GoSetup
496 * @version Introduced in firmware 4.8.2.76
497 * @param setup GoSetup object.
498 * @return kTRUE if enabled and kFALSE otherwise.
499 */
500 GoFx(kBool) GoSetup_PreferMasterTimeEncoderEnabled(GoSetup setup);
501
502 /**
503 * Gets the occlusion reduction enabled state.
504 *
505 * @public @memberof GoSetup
506 * @version Introduced in firmware 4.0.10.27
507 * @param setup GoSetup object.
508 * @return kTRUE if enabled and kFALSE otherwise.
509 */
510 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
511
512 /**
513 * Sets the occlusion reduction enabled state.
514 *
515 * @public @memberof GoSetup
516 * @version Introduced in firmware 4.0.10.27
517 * @param setup GoSetup object.
518 * @param enable kTRUE to enable it and kFALSE to disable it.
519 * @return Operation status.
520 */
521 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
522
523 /**
524 * Returns a boolean representing whether the user occlusion reduction configuration is used.
525 *
526 * @public @memberof GoSetup
527 * @version Introduced in firmware 4.3.3.124
528 * @param setup GoSetup object.
529 * @return kTRUE if used, or kFALSE if not used.
530 */
531 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
532
533 /**
534 * Gets the occlusion reduction system value.
535 *
536 * @public @memberof GoSetup
537 * @version Introduced in firmware 4.3.3.124
538 * @param setup GoSetup object.
539 * @return kTRUE if enabled, or kFALSE if not.
540 */
541 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
542
543 /**
544 * Gets the occlusion reduction algorithm.
545 *
546 * @public @memberof GoSetup
547 * @version Introduced in firmware 4.5.3.57
548 * @param setup GoSetup object.
549 * @return The occlusion reduction algorithm.
550 */
551 GoFx(GoOcclusionReductionAlg) GoSetup_OcclusionReductionAlg(GoSetup setup);
552
553 /**
554 * Sets the occlusion reduction algorithm.
555 *
556 * @public @memberof GoSetup
557 * @version Introduced in firmware 4.5.3.57
558 * @param setup GoSetup object.
559 * @param alg The algorithm to use for occlusion reduction.
560 * @return Operation status.
561 */
562 GoFx(kStatus) GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg);
563
564 /**
565 * Returns a boolean representing whether the user occlusion reduction algorithm is used.
566 *
567 * @public @memberof GoSetup
568 * @version Introduced in firmware 4.5.3.57
569 * @param setup GoSetup object.
570 * @return kTRUE if used, or kFALSE if not used.
571 */
572 GoFx(kBool) GoSetup_OcclusionReductionAlgUsed(GoSetup setup);
573
574 //class - trigger
575
576 /**
577 * Sets the system trigger units.
578 * Ignored if GoSetup_TriggerSource is time or encoder
579 *
580 * @public @memberof GoSetup
581 * @version Introduced in firmware 4.0.10.27
582 * @param setup GoSetup object.
583 * @param unit The system trigger unit.
584 * @return Operation status.
585 */
586 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
587
588 /**
589 * Gets the system trigger units.
590 * Ignored if GoSetup_TriggerSource is time or encoder
591 *
592 * @public @memberof GoSetup
593 * @version Introduced in firmware 4.0.10.27
594 * @param setup GoSetup object.
595 * @return The system domain.
596 */
597 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
598
599 /**
600 * Sets the trigger source for profile triggering.
601 *
602 * @public @memberof GoSetup
603 * @version Introduced in firmware 4.0.10.27
604 * @param setup GoSetup object.
605 * @param source Profile trigger source.
606 * @return Operation status.
607 */
608 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
609
610 /**
611 * Gets the trigger source for profile triggering.
612 *
613 * @public @memberof GoSetup
614 * @version Introduced in firmware 4.0.10.27
615 * @param setup GoSetup object.
616 * @return Profile trigger source.
617 */
618 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
619
620 /**
621 * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
622 *
623 * @public @memberof GoSetup
624 * @version Introduced in firmware 4.0.10.27
625 * @param setup GoSetup object.
626 * @param delay Trigger delay (uS or mm).
627 * @return Operation status.
628 */
629 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
630
631 /**
632 * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
633 *
634 * @public @memberof GoSetup
635 * @version Introduced in firmware 4.0.10.27
636 * @param setup GoSetup object.
637 * @return Trigger delay (uS or mm).
638 */
639 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
640
641 /**
642 * Reports the minimum trigger delay, based on current settings.
643 * Depending on GoDomain, units are uS or mm.
644 *
645 * @public @memberof GoSetup
646 * @version Introduced in firmware 4.0.10.27
647 * @param setup GoSetup object.
648 * @return Minimum trigger delay (uS or mm).
649 */
650 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
651
652 /**
653 * Reports the maximum trigger delay, based on current settings.
654 * Depending on GoDomain, units are uS or mm.
655 *
656 * @public @memberof GoSetup
657 * @version Introduced in firmware 4.0.10.27
658 * @param setup GoSetup object.
659 * @return Maximum trigger delay (uS or mm).
660 */
661 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
662
663 /**
664 * Sets the trigger gate feature.
665 *
666 * @public @memberof GoSetup
667 * @version Introduced in firmware 4.0.10.27
668 * @param setup GoSetup object.
669 * @param enable Enables trigger gate operation.
670 * @return Operation status.
671 */
672 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
673
674 /**
675 * Reports whether the trigger gate feature is currently enabled.
676 *
677 * @public @memberof GoSetup
678 * @version Introduced in firmware 4.0.10.27
679 * @param setup GoSetup object.
680 * @return kTRUE if enabled, or kFALSE if disabled.
681 */
682 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
683
684 /**
685 * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
686 *
687 * @public @memberof GoSetup
688 * @version Introduced in firmware 4.0.10.27
689 * @param setup GoSetup object.
690 * @return kTRUE if the user specified setting is used and kFALSE otherwise.
691 */
692 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
693
694 /**
695 * Reports the trigger gate enabled system value.
696 *
697 * @public @memberof GoSetup
698 * @version Introduced in firmware 4.0.10.27
699 * @param setup GoSetup object.
700 * @return kTRUE if enabled, or kFALSE if disabled.
701 */
702 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
703
704 /**
705 * Enables or disables operation at full frame rate (ignoring frame rate setting).
706 *
707 * @public @memberof GoSetup
708 * @version Introduced in firmware 4.0.10.27
709 * @param setup GoSetup object.
710 * @param enable Enables full frame rate operation.
711 * @return Operation status.
712 */
713 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
714
715 /**
716 * Reports whether or not system is configured to operate at full frame rate.
717 *
718 * @public @memberof GoSetup
719 * @version Introduced in firmware 4.0.10.27
720 * @param setup GoSetup object.
721 * @return True if system operates at full frame rate; false otherwise.
722 */
723 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
724
725 /**
726 * Sets the current frame rate for time-based triggering. The maximum frame
727 * rate option must be disabled to use the value set in this function.
728 *
729 * @public @memberof GoSetup
730 * @version Introduced in firmware 4.0.10.27
731 * @param setup GoSetup object.
732 * @param frameRate Frame Rate value (Hz).
733 * @return Operation status.
734 * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
735 */
736 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
737
738 /**
739 * Reports the currently configured frame rate.
740 *
741 * @public @memberof GoSetup
742 * @version Introduced in firmware 4.0.10.27
743 * @param setup GoSetup object.
744 * @return Maximum frame rate (Hz).
745 */
746 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
747
748 /**
749 * Reports the current frame rate of Tracheid data
750 *
751 * @public @memberof GoSetup
752 * @version Introduced in firmware 4.8.0.35
753 * @param setup GoSetup object.
754 * @return Tracheid frame rate (Hz).
755 */
756 GoFx(k64f) GoSetup_TracheidRate(GoSetup setup);
757
758 /**
759 * Reports the current frame rate of normal (range, profile, or surface) data
760 *
761 * @public @memberof GoSetup
762 * @version Introduced in firmware 4.8.0.35
763 * @param setup GoSetup object.
764 * @return Frame Data Rate (Hz).
765 */
766 GoFx(k64f) GoSetup_FrameDataRate(GoSetup setup);
767
768 /**
769 * Constraint for the minimum valid value of the Frame Rate setting.
770 *
771 * @public @memberof GoSetup
772 * @version Introduced in firmware 4.0.10.27
773 * @param setup GoSetup object.
774 * @return Minimum valid Frame Rate setting (Hz).
775 */
776 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
777
778 /**
779 * Constraint for the maximum valid value of the Frame Rate setting.
780 *
781 * @public @memberof GoSetup
782 * @version Introduced in firmware 4.0.10.27
783 * @param setup GoSetup object.
784 * @return Maximum valid Frame Rate setting (Hz).
785 */
786 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
787
788 /**
789 * Sets the encoder trigger mode.
790 *
791 * @public @memberof GoSetup
792 * @version Introduced in firmware 4.0.10.27
793 * @param setup GoSetup object.
794 * @param mode Encoder trigger mode.
795 * @return Profile trigger source.
796 */
797 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
798
799 /**
800 * Gets the encoder trigger mode.
801 *
802 * @public @memberof GoSetup
803 * @version Introduced in firmware 4.0.10.27
804 * @param setup GoSetup object.
805 * @return Encoder trigger mode.
806 */
807 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
808
809 /**
810 * Sets the current encoder period for encoder-based triggering.
811 *
812 * @public @memberof GoSetup
813 * @version Introduced in firmware 4.0.10.27
814 * @param setup GoSetup object.
815 * @param period Encoder period (mm).
816 * @return Operation status.
817 */
818 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
819
820 /**
821 * Gets the current encoder period for encoder-based triggering.
822 *
823 * @public @memberof GoSetup
824 * @version Introduced in firmware 4.0.10.27
825 * @param setup GoSetup object.
826 * @return Encoder period (mm).
827 */
828 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
829
830 /**
831 * Constraint for the minimum valid value of the Encoder Period setting.
832 *
833 * @public @memberof GoSetup
834 * @version Introduced in firmware 4.0.10.27
835 * @param setup GoSetup object.
836 * @return Minimum valid Encoder Period setting (mm).
837 */
838 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
839
840 /**
841 * Constraint for the maximum valid value of the Encoder Period setting.
842 *
843 * @public @memberof GoSetup
844 * @version Introduced in firmware 4.0.10.27
845 * @param setup GoSetup object.
846 * @return Maximum valid Encoder Period setting (mm).
847 */
848 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
849
850 /**
851 * Enables profile intensity collection.
852 *
853 * @public @memberof GoSetup
854 * @version Introduced in firmware 4.0.10.27
855 * @param setup GoSetup object.
856 * @param enable kTRUE to enable, or kFALSE to disable.
857 * @return Operation status.
858 */
859 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
860
861 /**
862 * Reports whether the profile intensity collection is enabled.
863 *
864 * @public @memberof GoSetup
865 * @version Introduced in firmware 4.0.10.27
866 * @param setup GoSetup object.
867 * @return kTRUE if enabled, or kFALSE if disabled.
868 */
869 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
870
871 /**
872 * Enables flicker reduction mode.
873 *
874 * @public @memberof GoSetup
875 * @version Introduced in firmware 4.6.2.31
876 * @param setup GoSetup object.
877 * @param enable kTRUE to enable, or kFALSE to disable.
878 * @return Operation status.
879 */
880 GoFx(kStatus) GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable);
881
882
883 /**
884 * Reports whether flicker free mode is enabled.
885 *
886 * @public @memberof GoSetup
887 * @version Introduced in firmware 4.6.2.31
888 * @param setup GoSetup object.
889 * @return kTRUE if enabled, or kFALSE if disabled.
890 */
891 GoFx(kBool) GoSetup_FlickerFreeModeEnabled(GoSetup setup);
892
893 /**
894 * Reports whether flicker free mode is available for use on this sensor.
895 *
896 * @public @memberof GoSetup
897 * @version Introduced in firmware 4.6.2.31
898 * @param setup GoSetup object.
899 * @return kTRUE if available, or kFALSE if not.
900 */
901 GoFx(kBool) GoSetup_FlickerFreeModeAvailable(GoSetup setup);
902
903 //class - alignment
904
905 /**
906 * Gets the input trigger enabled state.
907 *
908 * @public @memberof GoSetup
909 * @version Introduced in firmware 4.0.10.27
910 * @param setup GoSetup object.
911 * @return kTRUE if enabled and kFALSE otherwise.
912 */
913 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
914
915 /**
916 * Returns a boolean representing whether the user input trigger configuration is used.
917 *
918 * @public @memberof GoSetup
919 * @version Introduced in firmware 4.3.3.124
920 * @param setup GoSetup object.
921 * @return kTRUE if used, or kFALSE if not used.
922 */
923 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
924
925 /**
926 * Gets the input trigger system value.
927 *
928 * @public @memberof GoSetup
929 * @version Introduced in firmware 4.3.3.124
930 * @param setup GoSetup object.
931 * @return kTRUE if enabled, or kFALSE if not.
932 */
933 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
934
935 /**
936 * Sets the input trigger enabled state.
937 *
938 * @public @memberof GoSetup
939 * @version Introduced in firmware 4.0.10.27
940 * @param setup GoSetup object.
941 * @param enable kTRUE to enable it and kFALSE to disable it.
942 */
943 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
944
945 /**
946 * Indicates whether alignment can be used.
947 *
948 * @public @memberof GoSetup
949 * @version Introduced in firmware 4.5.3.57
950 * @param setup GoSetup object.
951 * @return True if alignment is available for use.
952 */
953 GoFx(kBool) GoSetup_AlignmentUsed(GoSetup setup);
954
955 /**
956 * Sets the type used for alignment.
957 *
958 * @public @memberof GoSetup
959 * @version Introduced in firmware 4.0.10.27
960 * @param setup GoSetup object.
961 * @param type Alignment type (stationary or moving).
962 * @return Operation status.
963 */
964 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
965
966 /**
967 * Gets the type used for alignment calibration.
968 *
969 * @public @memberof GoSetup
970 * @version Introduced in firmware 4.0.10.27
971 * @param setup GoSetup object.
972 * @return Alignment type (stationary or moving).
973 */
974 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
975
976 /**
977 * Gets the alignment type option at the given index.
978 *
979 * @public @memberof GoSetup
980 * @version Introduced in firmware 4.0.10.27
981 * @param setup GoSetup object.
982 * @param index The index with which to retrieve an alignment type option.
983 * @return Alignment type option.
984 * @see GoSetup_AlignmentTypeOptionCount
985 */
986 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
987
988 /**
989 * Gets the alignment type option count.
990 *
991 * @public @memberof GoSetup
992 * @version Introduced in firmware 4.0.10.27
993 * @param setup GoSetup object.
994 * @return Alignment type option count.
995 */
996 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
997
998 /**
999 * Enables encoder calibration after alignment.
1000 *
1001 * @public @memberof GoSetup
1002 * @version Introduced in firmware 4.0.10.27
1003 * @param setup GoSetup object.
1004 * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
1005 * @return Operation status.
1006 */
1007 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
1008
1009 /**
1010 * Gets the value of the post alignment encoder calibration setting.
1011 *
1012 * @public @memberof GoSetup
1013 * @version Introduced in firmware 4.0.10.27
1014 * @param setup GoSetup object.
1015 * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
1016 */
1017 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
1018
1019 /**
1020 * Sets the target type used for stationary alignment calibration.
1021 *
1022 * @public @memberof GoSetup
1023 * @version Introduced in firmware 4.0.10.27
1024 * @param setup GoSetup object.
1025 * @param target Alignment target type.
1026 * @return Operation status.
1027 */
1028 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
1029
1030 /**
1031 * Gets the target type used for stationary alignment calibration.
1032 *
1033 * @public @memberof GoSetup
1034 * @version Introduced in firmware 4.0.10.27
1035 * @param setup GoSetup object.
1036 * @return Alignment target type.
1037 */
1038 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
1039
1040 /**
1041 * Gets the stationary alignment target option count.
1042 *
1043 * @public @memberof GoSetup
1044 * @version Introduced in firmware 4.0.10.27
1045 * @param setup GoSetup object.
1046 * @return The alignment target count.
1047 */
1048 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
1049
1050 /**
1051 * Gets the stationary alignment target option at the given index.
1052 *
1053 * @public @memberof GoSetup
1054 * @version Introduced in firmware 4.0.10.27
1055 * @param setup GoSetup object.
1056 * @param index The index with which to retrieve an alignment target.
1057 * @return The alignment target option.
1058 * @see GoSetup_AlignmentStationaryTargetOptionCount
1059 */
1060 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
1061
1062 /// @cond (Gocator_1x00 || Gocator_2x00)
1063
1064 /**
1065 * Sets the target type used for moving alignment calibration.
1066 *
1067 * @public @memberof GoSetup
1068 * @version Introduced in firmware 4.0.10.27
1069 * @param setup GoSetup object.
1070 * @param target Alignment target type.
1071 * @return Operation status.
1072 */
1073 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
1074
1075 /**
1076 * Gets the target type used for moving alignment calibration.
1077 *
1078 * @public @memberof GoSetup
1079 * @version Introduced in firmware 4.0.10.27
1080 * @param setup GoSetup object.
1081 * @return Alignment target type.
1082 */
1083 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
1084
1085 /**
1086 * Gets the moving alignment target option count.
1087 *
1088 * @public @memberof GoSetup
1089 * @version Introduced in firmware 4.0.10.27
1090 * @param setup GoSetup object.
1091 * @return The alignment target count.
1092 */
1093 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
1094
1095 /**
1096 * Gets the moving alignment target option at the given index.
1097 *
1098 * @public @memberof GoSetup
1099 * @version Introduced in firmware 4.0.10.27
1100 * @param setup GoSetup object.
1101 * @param index The index with which to retrieve an alignment target.
1102 * @return The alignment target option.
1103 * @see GoSetup_AlignmentMovingTargetOptionCount
1104 */
1105 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
1106
1107 /**
1108 * Sets the diameter of the disk used for travel calibration.
1109 *
1110 * @public @memberof GoSetup
1111 * @version Introduced in firmware 4.0.10.27
1112 * @param setup GoSetup object.
1113 * @param diameter Disk diameter (mm).
1114 * @return Operation status.
1115 */
1116 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
1117
1118 /**
1119 * Gets the diameter of the disk used for travel calibration.
1120 *
1121 * @public @memberof GoSetup
1122 * @version Introduced in firmware 4.0.10.27
1123 * @param setup GoSetup object.
1124 * @return Disk diameter (mm).
1125 */
1126 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
1127
1128 /**
1129 * Sets the height of the disk used for travel calibration.
1130 *
1131 * @public @memberof GoSetup
1132 * @version Introduced in firmware 4.0.10.27
1133 * @param setup GoSetup object.
1134 * @param height Disk height (mm).
1135 * @return Operation status.
1136 */
1137 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
1138
1139 /**
1140 * Gets the height of the disk used for travel calibration.
1141 *
1142 * @public @memberof GoSetup
1143 * @version Introduced in firmware 4.0.10.27
1144 * @param setup GoSetup object.
1145 * @return Disk height (mm).
1146 */
1147 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
1148
1149 /// @endcond
1150
1151
1152 /**
1153 * Sets the width of the bar used for travel calibration.
1154 *
1155 * @public @memberof GoSetup
1156 * @version Introduced in firmware 4.0.10.27
1157 * @param setup GoSetup object.
1158 * @param width Bar width (mm).
1159 * @return Operation status.
1160 */
1161 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
1162
1163 /**
1164 * Gets the width of the bar used for travel calibration.
1165 *
1166 * @public @memberof GoSetup
1167 * @version Introduced in firmware 4.0.10.27
1168 * @param setup GoSetup object.
1169 * @return Bar width (mm).
1170 */
1171 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
1172
1173 /**
1174 * Sets the height of the bar used for travel calibration.
1175 *
1176 * @public @memberof GoSetup
1177 * @version Introduced in firmware 4.0.10.27
1178 * @param setup GoSetup object.
1179 * @param height Bar height (mm).
1180 * @return Operation status.
1181 */
1182 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
1183
1184 /**
1185 * Gets the height of the bar used for travel calibration.
1186 *
1187 * @public @memberof GoSetup
1188 * @version Introduced in firmware 4.0.10.27
1189 * @param setup GoSetup object.
1190 * @return Bar height (mm).
1191 */
1192 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
1193
1194 /**
1195 * Indicates if the hole count can be modified by the user.
1196 *
1197 * @public @memberof GoSetup
1198 * @version Introduced in firmware 4.6.3.51
1199 * @param setup GoSetup object.
1200 * @return kTRUE if used. kFALSE if not.
1201 */
1202 GoFx(kBool) GoSetup_BarHoleCountUsed(GoSetup setup);
1203
1204 /**
1205 * Gets the bar hole count system value.
1206 *
1207 * @public @memberof GoSetup
1208 * @version Introduced in firmware 4.6.3.51
1209 * @param setup GoSetup object.
1210 * @return Number of columns.
1211 */
1212 GoFx(kSize) GoSetup_BarHoleCountValue(GoSetup setup);
1213
1214 /**
1215 * Sets the number of holes that are defined on the calibration bar.
1216 *
1217 * @public @memberof GoSetup
1218 * @version Introduced in firmware 4.0.10.27
1219 * @param setup GoSetup object.
1220 * @param count Hole count.
1221 * @return Operation status.
1222 */
1223 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
1224
1225 /**
1226 * Gets the number of holes that are defined on the calibration bar.
1227 *
1228 * @public @memberof GoSetup
1229 * @version Introduced in firmware 4.0.10.27
1230 * @param setup GoSetup object.
1231 * @return Hole count.
1232 */
1233 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
1234
1235 /**
1236 * Indicates if the hole distance can be modified by the user.
1237 *
1238 * @public @memberof GoSetup
1239 * @version Introduced in firmware 4.6.3.51
1240 * @param setup GoSetup object.
1241 * @return kTRUE if used. kFALSE if not.
1242 */
1243 GoFx(kBool) GoSetup_BarHoleDistanceUsed(GoSetup setup);
1244
1245 /**
1246 * Sets the distance between holes that are defined on the calibration bar.
1247 *
1248 * @public @memberof GoSetup
1249 * @version Introduced in firmware 4.0.10.27
1250 * @param setup GoSetup object.
1251 * @param distance Hole distance (mm).
1252 * @return Operation status.
1253 */
1254 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
1255
1256 /**
1257 * Gets the distance between holes that are defined on the calibration bar.
1258 *
1259 * @public @memberof GoSetup
1260 * @version Introduced in firmware 4.0.10.27
1261 * @param setup GoSetup object.
1262 * @return Hole distance (mm).
1263 */
1264 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
1265
1266 /**
1267 * Indicates if the hole diameter can be modified by the user.
1268 *
1269 * @public @memberof GoSetup
1270 * @version Introduced in firmware 4.6.3.55
1271 * @param setup GoSetup object.
1272 * @return kTRUE if used. kFALSE if not.
1273 */
1274 GoFx(kBool) GoSetup_BarHoleDiameterUsed(GoSetup setup);
1275
1276 /**
1277 * Sets the diameter of holes that are defined on the calibration bar.
1278 *
1279 * @public @memberof GoSetup
1280 * @version Introduced in firmware 4.0.10.27
1281 * @param setup GoSetup object.
1282 * @param diameter Hole diameter (mm).
1283 * @return Operation status.
1284 */
1285 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
1286
1287 /**
1288 * Gets the diameter of holes that are defined on the calibration bar.
1289 *
1290 * @public @memberof GoSetup
1291 * @version Introduced in firmware 4.0.10.27
1292 * @param setup GoSetup object.
1293 * @return Hole diameter (mm).
1294 */
1295 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
1296
1297 /**
1298 * Sets the degrees of freedom used for bar alignment calibration.
1299 *
1300 * @public @memberof GoSetup
1301 * @version Introduced in firmware 4.7.3.70
1302 * @param setup GoSetup object.
1303 * @param dof Alignment degrees of freedom for the bar.
1304 * @return Operation status.
1305 */
1306 GoFx(kStatus) GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof);
1307
1308 /**
1309 * Gets the degrees of freedom used for bar alignment calibration.
1310 *
1311 * @public @memberof GoSetup
1312 * @version Introduced in firmware 4.7.3.70
1313 * @param setup GoSetup object.
1314 * @return Degrees of freedom setting for the bar alignment.
1315 */
1316 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedom( GoSetup setup );
1317
1318 /**
1319 * Indicates if the degrees of freedom for bar alignment can be modified by the user.
1320 *
1321 * @public @memberof GoSetup
1322 * @version Introduced in firmware 4.7.3.70
1323 * @param setup GoSetup object.
1324 * @return kTRUE if used. kFALSE if not.
1325 */
1326 GoFx(kBool) GoSetup_BarDegreesOfFreedomUsed(GoSetup setup);
1327
1328 /**
1329 * Gets the degrees of freedom bar alignment target option count.
1330 *
1331 * @public @memberof GoSetup
1332 * @version Introduced in firmware 4.7.3.70
1333 * @param setup GoSetup object.
1334 * @return The bar alignment degrees of freedom option count.
1335 */
1336 GoFx(kSize) GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup);
1337
1338 /**
1339 * Gets the bar alignment degrees of freedom option at the given index.
1340 *
1341 * @public @memberof GoSetup
1342 * @version Introduced in firmware 4.7.3.70
1343 * @param setup GoSetup object.
1344 * @param index The index with which to retrieve the degree of freedom.
1345 * @return The degrees of freedom option set at the index.
1346 */
1347 GoFx(GoAlignmentDegreesOfFreedom) GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index);
1348
1349 /**
1350 * Sets the height of the plate used for travel calibration.
1351 *
1352 * @public @memberof GoSetup
1353 * @version Introduced in firmware 4.0.10.27
1354 * @param setup GoSetup object.
1355 * @param height Plate height (mm).
1356 * @return Operation status.
1357 */
1358 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
1359
1360 /**
1361 * Gets the height of the plate used for travel calibration.
1362 *
1363 * @public @memberof GoSetup
1364 * @version Introduced in firmware 4.0.10.27
1365 * @param setup GoSetup object.
1366 * @return Plate height (mm).
1367 */
1368 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
1369
1370 /**
1371 * Sets the number of holes that are defined on the calibration plate.
1372 *
1373 * @public @memberof GoSetup
1374 * @version Introduced in firmware 4.0.10.27
1375 * @param setup GoSetup object.
1376 * @param count Hole count.
1377 * @return Operation status.
1378 */
1379 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
1380
1381 /**
1382 * Gets the number of holes that are defined on the calibration plate.
1383 *
1384 * @public @memberof GoSetup
1385 * @version Introduced in firmware 4.0.10.27
1386 * @param setup GoSetup object.
1387 * @return Hole count.
1388 */
1389 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
1390
1391 /**
1392 * Sets the diameter of the reference hole defined on the calibration plate.
1393 *
1394 * @public @memberof GoSetup
1395 * @version Introduced in firmware 4.0.10.27
1396 * @param setup GoSetup object.
1397 * @param diameter Hole diameter (mm).
1398 * @return Operation status.
1399 */
1400 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
1401
1402 /**
1403 * Gets the diameter of the reference hole defined on the calibration plate.
1404 *
1405 * @public @memberof GoSetup
1406 * @version Introduced in firmware 4.0.10.27
1407 * @param setup GoSetup object.
1408 * @return Hole diameter (mm).
1409 */
1410 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
1411
1412 /**
1413 * Sets the diameter of the secondary hole defined on the calibration plate.
1414 *
1415 * @public @memberof GoSetup
1416 * @version Introduced in firmware 4.0.10.27
1417 * @param setup GoSetup object.
1418 * @param diameter Hole diameter (mm).
1419 * @return Operation status.
1420 */
1421 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
1422
1423 /**
1424 * Gets the diameter of the secondary hole defined on the calibration plate.
1425 *
1426 * @public @memberof GoSetup
1427 * @version Introduced in firmware 4.0.10.27
1428 * @param setup GoSetup object.
1429 * @return Hole diameter (mm).
1430 */
1431 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
1432
1433 /**
1434 * Adds a corner parameters object to the collection of polygon corners for alignment.
1435 *
1436 * @public @memberof GoSetup
1437 * @version Introduced in firmware 4.8.0.72
1438 * @param setup GoSetup object.
1439 * @param corner Reference to GoPolygonCornerParameters object.
1440 * @return Operation status.
1441 */
1442 GoFx(kStatus) GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters* corner);
1443
1444 /* Adds corner parameters to the collection of polygon corners for alignment.
1445 *
1446 * @public @memberof GoSetup
1447 * @version Introduced in firmware 4.8.0.86
1448 * @param pointx X coordinate of corner.
1449 * @param pointz Z coordinate of corner.
1450 * @param devices Array list of devices assigned to corner.
1451 * @return Operation status.
1452 */
1453 GoFx(kStatus) GoSetup_AddPolygonCornerParams(GoSetup setup, k64f pointx, k64f pointz, const kChar *devices);
1454
1455 /**
1456 * Clears all corner parameter objects from the collection of polygon corners for alignment.
1457 *
1458 * @public @memberof GoSetup
1459 * @version Introduced in firmware 4.8.0.72
1460 * @param setup GoSetup object.
1461 * @return Operation status.
1462 */
1463 GoFx(kStatus) GoSetup_ClearPolygonCorners(GoSetup setup);
1464
1465 /**
1466 * Retrieves the reference to the corner parameters object from the collection of polygon corners.
1467 *
1468 * @public @memberof GoSetup
1469 * @version Introduced in firmware 4.8.0.72
1470 * @param setup GoSetup object.
1471 * @param index Index in the collection of polygon corners.
1472 * @return Reference to corresponding corner parameters.
1473 */
1474 GoFx(GoPolygonCornerParameters*) GoSetup_PolygonCornerAt(GoSetup setup, kSize index);
1475
1476 /**
1477 * Gets the number of corner parameters defined in the collection of polygon corners.
1478 *
1479 * @public @memberof GoSetup
1480 * @version Introduced in firmware 4.8.0.72
1481 * @param setup GoSetup object.
1482 * @return Number of corner parameters in polygon.
1483 */
1484 GoFx(kSize) GoSetup_PolygonCornerCount(GoSetup setup);
1485
1486
1487 /// @cond (Gocator_1x00 || Gocator_2x00)
1488
1489 /**
1490 * Indicates whether X smoothing can be used for the current scan mode and device family.
1491 *
1492 * @public @memberof GoSetup
1493 * @version Introduced in firmware 4.5.3.57
1494 * @param setup GoSetup object.
1495 * @return True if x-smoothing is available for use.
1496 */
1497 GoFx(kBool) GoSetup_XSmoothingUsed(GoSetup setup);
1498
1499 /**
1500 * Sets the status of x-direction smoothing.
1501 *
1502 * @public @memberof GoSetup
1503 * @version Introduced in firmware 4.0.10.27
1504 * @param setup GoSetup object.
1505 * @param enabled Enable or disable x-smoothing
1506 * @return Operation status.
1507 */
1508 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
1509
1510 /**
1511 * Gets the status of x-direction smoothing.
1512 *
1513 * @public @memberof GoSetup
1514 * @version Introduced in firmware 4.0.10.27
1515 * @param setup GoSetup object.
1516 * @return True if x-smoothing is enabled.
1517 */
1518 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
1519
1520 /**
1521 * Sets the x-direction smoothing window.
1522 *
1523 * @public @memberof GoSetup
1524 * @version Introduced in firmware 4.0.10.27
1525 * @param setup GoSetup object.
1526 * @param window The x-smoothing window (mm).
1527 * @return Operation status.
1528 */
1529 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
1530
1531 /**
1532 * Gets the x-direction smoothing window.
1533 *
1534 * @public @memberof GoSetup
1535 * @version Introduced in firmware 4.0.10.27
1536 * @param setup GoSetup object.
1537 * @return The x-smoothing window (mm).
1538 */
1539 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
1540
1541 /**
1542 * Gets the x-direction smoothing window minimum.
1543 *
1544 * @public @memberof GoSetup
1545 * @version Introduced in firmware 4.0.10.27
1546 * @param setup GoSetup object.
1547 * @return The x-smoothing window min (mm).
1548 */
1549 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
1550
1551 /**
1552 * Gets the x-direction smoothing window maximum.
1553 *
1554 * @public @memberof GoSetup
1555 * @version Introduced in firmware 4.0.10.27
1556 * @param setup GoSetup object.
1557 * @return The x-smoothing window max (mm).
1558 */
1559 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
1560
1561 /**
1562 * Indicates whether X median can be used for the current scan mode and device family.
1563 *
1564 * @public @memberof GoSetup
1565 * @version Introduced in firmware 4.5.3.57
1566 * @param setup GoSetup object.
1567 * @return True if x-median is available for use.
1568 */
1569 GoFx(kBool) GoSetup_XMedianUsed(GoSetup setup);
1570
1571 /**
1572 * Sets the status of x-direction median.
1573 *
1574 * @public @memberof GoSetup
1575 * @version Introduced in firmware 4.1.3.106
1576 * @param setup GoSetup object.
1577 * @param enabled Enable or disable x-median
1578 * @return Operation status.
1579 */
1580 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1581
1582 /**
1583 * Gets the status of x-direction median.
1584 *
1585 * @public @memberof GoSetup
1586 * @version Introduced in firmware 4.1.3.106
1587 * @param setup GoSetup object.
1588 * @return True if x-median is enabled.
1589 */
1590 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1591
1592 /**
1593 * Sets the x-direction median window.
1594 *
1595 * @public @memberof GoSetup
1596 * @version Introduced in firmware 4.1.3.106
1597 * @param setup GoSetup object.
1598 * @param window The x-median window (mm).
1599 * @return Operation status.
1600 */
1601 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1602
1603 /**
1604 * Gets the x-direction median window.
1605 *
1606 * @public @memberof GoSetup
1607 * @version Introduced in firmware 4.1.3.106
1608 * @param setup GoSetup object.
1609 * @return The x-median window (mm).
1610 */
1611 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1612
1613 /**
1614 * Gets the x-direction median window minimum.
1615 *
1616 * @public @memberof GoSetup
1617 * @version Introduced in firmware 4.1.3.106
1618 * @param setup GoSetup object.
1619 * @return The x-median window min (mm).
1620 */
1621 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1622
1623 /**
1624 * Gets the x-direction median window maximum.
1625 *
1626 * @public @memberof GoSetup
1627 * @version Introduced in firmware 4.1.3.106
1628 * @param setup GoSetup object.
1629 * @return The x-median window max (mm).
1630 */
1631 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1632
1633 /**
1634 * Indicates whether X decimation can be used for the current scan mode and device family.
1635 *
1636 * @public @memberof GoSetup
1637 * @version Introduced in firmware 4.5.3.57
1638 * @param setup GoSetup object.
1639 * @return True if x-decimation is available for use.
1640 */
1641 GoFx(kBool) GoSetup_XDecimationUsed(GoSetup setup);
1642
1643 /**
1644 * Sets the status of x-direction decimation.
1645 *
1646 * @public @memberof GoSetup
1647 * @version Introduced in firmware 4.1.3.106
1648 * @param setup GoSetup object.
1649 * @param enabled Enable or disable x-decimation
1650 * @return Operation status.
1651 */
1652 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1653
1654 /**
1655 * Gets the status of x-direction decimation.
1656 *
1657 * @public @memberof GoSetup
1658 * @version Introduced in firmware 4.1.3.106
1659 * @param setup GoSetup object.
1660 * @return True if x-decimation is enabled.
1661 */
1662 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1663
1664 /**
1665 * Sets the x-direction decimation window.
1666 *
1667 * @public @memberof GoSetup
1668 * @version Introduced in firmware 4.1.3.106
1669 * @param setup GoSetup object.
1670 * @param window The x-decimation window (mm).
1671 * @return Operation status.
1672 */
1673 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1674
1675 /**
1676 * Gets the x-direction decimation window.
1677 *
1678 * @public @memberof GoSetup
1679 * @version Introduced in firmware 4.1.3.106
1680 * @param setup GoSetup object.
1681 * @return The x-decimation window (mm).
1682 */
1683 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1684
1685 /**
1686 * Gets the x-direction decimation window minimum.
1687 *
1688 * @public @memberof GoSetup
1689 * @version Introduced in firmware 4.1.3.106
1690 * @param setup GoSetup object.
1691 * @return The x-decimation window min (mm).
1692 */
1693 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1694
1695 /**
1696 * Gets the x-direction decimation window maximum.
1697 *
1698 * @public @memberof GoSetup
1699 * @version Introduced in firmware 4.1.3.106
1700 * @param setup GoSetup object.
1701 * @return The x-decimation window max (mm).
1702 */
1703 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1704
1705 /**
1706 * Indicates whether X gap filling can be used for the current scan mode and device family.
1707 *
1708 * @public @memberof GoSetup
1709 * @version Introduced in firmware 4.5.3.57
1710 * @param setup GoSetup object.
1711 * @return True if x-gap filling is available for use.
1712 */
1713 GoFx(kBool) GoSetup_XGapFillingUsed(GoSetup setup);
1714
1715 /**
1716 * Sets the status of x-direction gap-filling.
1717 *
1718 * @public @memberof GoSetup
1719 * @version Introduced in firmware 4.0.10.27
1720 * @param setup GoSetup object.
1721 * @param enable Enable or disable x-gap-filling
1722 * @return Operation status.
1723 */
1724 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1725
1726 /**
1727 * Gets the status of x-direction gap-filling.
1728 *
1729 * @public @memberof GoSetup
1730 * @version Introduced in firmware 4.0.10.27
1731 * @param setup GoSetup object.
1732 * @return True if x-gap-filling is enabled.
1733 */
1734 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1735
1736 /**
1737 * Sets the status of x-direction gap-filling.
1738 *
1739 * @public @memberof GoSetup
1740 * @version Introduced in firmware 4.0.10.27
1741 * @param setup GoSetup object.
1742 * @param window Enable or disable x-gap-filling
1743 * @return Operation status.
1744 */
1745 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1746
1747 /**
1748 * Gets the x-direction gap-filling window.
1749 *
1750 * @public @memberof GoSetup
1751 * @version Introduced in firmware 4.0.10.27
1752 * @param setup GoSetup object.
1753 * @return The x-gap-filling window (mm).
1754 */
1755 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1756
1757 /**
1758 * Gets the x-direction gap-filling window minimum.
1759 *
1760 * @public @memberof GoSetup
1761 * @version Introduced in firmware 4.0.10.27
1762 * @param setup GoSetup object.
1763 * @return The x-gap-filling window min (mm).
1764 */
1765 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1766
1767 /**
1768 * Gets the x-direction gap-filling window maximum.
1769 *
1770 * @public @memberof GoSetup
1771 * @version Introduced in firmware 4.0.10.27
1772 * @param setup GoSetup object.
1773 * @return The x-gap-filling window max (mm).
1774 */
1775 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1776
1777 /**
1778 * Indicates whether X slope can be used for the current scan mode and device family.
1779 *
1780 * @public @memberof GoSetup
1781 * @version Introduced in firmware 4.5.3.57
1782 * @param setup GoSetup object.
1783 * @return True if x-slope is available for use.
1784 */
1785 GoFx(kBool) GoSetup_XSlopeUsed(GoSetup setup);
1786
1787 /**
1788 * Sets the status of x-direction slope.
1789 *
1790 * @public @memberof GoSetup
1791 * @version Introduced in firmware 4.5.2.0
1792 * @param setup GoSetup object.
1793 * @param enable Enable or disable x-slope
1794 * @return Operation status.
1795 */
1796 GoFx(kStatus) GoSetup_EnableXSlope(GoSetup setup, kBool enable);
1797
1798 /**
1799 * Gets the status of x-direction slope.
1800 *
1801 * @public @memberof GoSetup
1802 * @version Introduced in firmware 4.5.2.0
1803 * @param setup GoSetup object.
1804 * @return True if x-slope is enabled.
1805 */
1806 GoFx(kBool) GoSetup_XSlopeEnabled(GoSetup setup);
1807
1808 /**
1809 * Sets the status of x-direction slope.
1810 *
1811 * @public @memberof GoSetup
1812 * @version Introduced in firmware 4.5.2.0
1813 * @param setup GoSetup object.
1814 * @param window Enable or disable x-slope
1815 * @return Operation status.
1816 */
1817 GoFx(kStatus) GoSetup_SetXSlopeWindow(GoSetup setup, k64f window);
1818
1819 /**
1820 * Gets the x-direction slope window.
1821 *
1822 * @public @memberof GoSetup
1823 * @version Introduced in firmware 4.5.2.0
1824 * @param setup GoSetup object.
1825 * @return The x-slope window (mm).
1826 */
1827 GoFx(k64f) GoSetup_XSlopeWindow(GoSetup setup);
1828
1829 /**
1830 * Gets the x-direction slope window minimum.
1831 *
1832 * @public @memberof GoSetup
1833 * @version Introduced in firmware 4.5.2.0
1834 * @param setup GoSetup object.
1835 * @return The x-slope window min (mm).
1836 */
1837 GoFx(k64f) GoSetup_XSlopeWindowLimitMin(GoSetup setup);
1838
1839 /**
1840 * Gets the x-direction slope window maximum.
1841 *
1842 * @public @memberof GoSetup
1843 * @version Introduced in firmware 4.5.2.0
1844 * @param setup GoSetup object.
1845 * @return The x-slope window max (mm).
1846 */
1847 GoFx(k64f) GoSetup_XSlopeWindowLimitMax(GoSetup setup);
1848
1849 /**
1850 * Indicates whether Y smoothing can be used for the current scan mode and device family.
1851 *
1852 * @public @memberof GoSetup
1853 * @version Introduced in firmware 4.5.3.57
1854 * @param setup GoSetup object.
1855 * @return True if y-smoothing is available for use.
1856 */
1857 GoFx(kBool) GoSetup_YSmoothingUsed(GoSetup setup);
1858
1859 /**
1860 * Sets the status of y-direction smoothing.
1861 *
1862 * @public @memberof GoSetup
1863 * @version Introduced in firmware 4.0.10.27
1864 * @param setup GoSetup object.
1865 * @param enable Enable or disable y-smoothing
1866 * @return Operation status.
1867 */
1868 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
1869
1870 /**
1871 * Gets the status of y-direction smoothing.
1872 *
1873 * @public @memberof GoSetup
1874 * @version Introduced in firmware 4.0.10.27
1875 * @param setup GoSetup object.
1876 * @return True if y-smoothing is enabled.
1877 */
1878 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
1879
1880 /**
1881 * Sets the y-direction smoothing window.
1882 *
1883 * @public @memberof GoSetup
1884 * @version Introduced in firmware 4.0.10.27
1885 * @param setup GoSetup object.
1886 * @param window The y-smoothing window (mm).
1887 * @return Operation status.
1888 */
1889 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
1890
1891 /**
1892 * Gets the y-direction smoothing window.
1893 *
1894 * @public @memberof GoSetup
1895 * @version Introduced in firmware 4.0.10.27
1896 * @param setup GoSetup object.
1897 * @return The y-smoothing window (mm).
1898 */
1899 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
1900
1901 /**
1902 * Gets the y-direction smoothing window minimum.
1903 *
1904 * @public @memberof GoSetup
1905 * @version Introduced in firmware 4.0.10.27
1906 * @param setup GoSetup object.
1907 * @return The y-smoothing window min (mm).
1908 */
1909 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
1910
1911 /**
1912 * Gets the y-direction smoothing window maximum.
1913 *
1914 * @public @memberof GoSetup
1915 * @version Introduced in firmware 4.0.10.27
1916 * @param setup GoSetup object.
1917 * @return The y-smoothing window max (mm).
1918 */
1919 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
1920
1921 /**
1922 * Indicates whether Y median can be used for the current scan mode and device family.
1923 *
1924 * @public @memberof GoSetup
1925 * @version Introduced in firmware 4.5.3.57
1926 * @param setup GoSetup object.
1927 * @return True if y-median is available for use.
1928 */
1929 GoFx(kBool) GoSetup_YMedianUsed(GoSetup setup);
1930
1931 /**
1932 * Sets the status of y-direction median.
1933 *
1934 * @public @memberof GoSetup
1935 * @version Introduced in firmware 4.1.3.106
1936 * @param setup GoSetup object.
1937 * @param enable Enable or disable y-median
1938 * @return Operation status.
1939 */
1940 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
1941
1942 /**
1943 * Gets the status of y-direction median.
1944 *
1945 * @public @memberof GoSetup
1946 * @version Introduced in firmware 4.1.3.106
1947 * @param setup GoSetup object.
1948 * @return True if y-median is enabled.
1949 */
1950 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
1951
1952 /**
1953 * Sets the y-direction median window.
1954 *
1955 * @public @memberof GoSetup
1956 * @version Introduced in firmware 4.1.3.106
1957 * @param setup GoSetup object.
1958 * @param window The y-median window (mm).
1959 * @return Operation status.
1960 */
1961 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
1962
1963 /**
1964 * Gets the y-direction median window.
1965 *
1966 * @public @memberof GoSetup
1967 * @version Introduced in firmware 4.1.3.106
1968 * @param setup GoSetup object.
1969 * @return The y-median window (mm).
1970 */
1971 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
1972
1973 /**
1974 * Gets the y-direction median window minimum.
1975 *
1976 * @public @memberof GoSetup
1977 * @version Introduced in firmware 4.1.3.106
1978 * @param setup GoSetup object.
1979 * @return The y-median window min (mm).
1980 */
1981 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
1982
1983 /**
1984 * Gets the y-direction median window maximum.
1985 *
1986 * @public @memberof GoSetup
1987 * @version Introduced in firmware 4.1.3.106
1988 * @param setup GoSetup object.
1989 * @return The y-median window max (mm).
1990 */
1991 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
1992
1993 /**
1994 * Indicates whether y decimation can be used for the current scan mode and device family.
1995 *
1996 * @public @memberof GoSetup
1997 * @version Introduced in firmware 4.5.3.57
1998 * @param setup GoSetup object.
1999 * @return True if y-decimation is available for use.
2000 */
2001 GoFx(kBool) GoSetup_YDecimationUsed(GoSetup setup);
2002
2003 /**
2004 * Sets the status of y-direction decimation.
2005 *
2006 * @public @memberof GoSetup
2007 * @version Introduced in firmware 4.1.3.106
2008 * @param setup GoSetup object.
2009 * @param enable Enable or disable y-decimation
2010 * @return Operation status.
2011 */
2012 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
2013
2014 /**
2015 * Gets the status of y-direction decimation.
2016 *
2017 * @public @memberof GoSetup
2018 * @version Introduced in firmware 4.1.3.106
2019 * @param setup GoSetup object.
2020 * @return True if y-decimation is enabled.
2021 */
2022 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
2023
2024 /**
2025 * Sets the y-direction decimation window.
2026 *
2027 * @public @memberof GoSetup
2028 * @version Introduced in firmware 4.1.3.106
2029 * @param setup GoSetup object.
2030 * @param window The y-decimation window (mm).
2031 * @return Operation status.
2032 */
2033 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
2034
2035 /**
2036 * Gets the y-direction decimation window.
2037 *
2038 * @public @memberof GoSetup
2039 * @version Introduced in firmware 4.1.3.106
2040 * @param setup GoSetup object.
2041 * @return The y-decimation window (mm).
2042 */
2043 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
2044
2045 /**
2046 * Gets the y-direction decimation window minimum.
2047 *
2048 * @public @memberof GoSetup
2049 * @version Introduced in firmware 4.1.3.106
2050 * @param setup GoSetup object.
2051 * @return The y-decimation window min (mm).
2052 */
2053 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
2054
2055 /**
2056 * Gets the y-direction decimation window maximum.
2057 *
2058 * @public @memberof GoSetup
2059 * @version Introduced in firmware 4.1.3.106
2060 * @param setup GoSetup object.
2061 * @return The y-decimation window max (mm).
2062 */
2063 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
2064
2065 /**
2066 * Indicates whether Y slope can be used for the current scan mode and device family.
2067 *
2068 * @public @memberof GoSetup
2069 * @version Introduced in firmware 4.5.3.57
2070 * @param setup GoSetup object.
2071 * @return True if y-slope is available for use.
2072 */
2073 GoFx(kBool) GoSetup_YSlopeUsed(GoSetup setup);
2074
2075 /**
2076 * Sets the status of y-direction slope.
2077 *
2078 * @public @memberof GoSetup
2079 * @version Introduced in firmware 4.5.2.0
2080 * @param setup GoSetup object.
2081 * @param enable Enable or disable y-slope
2082 * @return Operation status.
2083 */
2084 GoFx(kStatus) GoSetup_EnableYSlope(GoSetup setup, kBool enable);
2085
2086 /**
2087 * Gets the status of y-direction slope.
2088 *
2089 * @public @memberof GoSetup
2090 * @version Introduced in firmware 4.5.2.0
2091 * @param setup GoSetup object.
2092 * @return True if y-slope is enabled.
2093 */
2094 GoFx(kBool) GoSetup_YSlopeEnabled(GoSetup setup);
2095
2096 /**
2097 * Sets the status of y-direction slope.
2098 *
2099 * @public @memberof GoSetup
2100 * @version Introduced in firmware 4.5.2.0
2101 * @param setup GoSetup object.
2102 * @param window Enable or disable y-slope
2103 * @return Operation status.
2104 */
2105 GoFx(kStatus) GoSetup_SetYSlopeWindow(GoSetup setup, k64f window);
2106
2107 /**
2108 * Gets the y-direction slope window.
2109 *
2110 * @public @memberof GoSetup
2111 * @version Introduced in firmware 4.5.2.0
2112 * @param setup GoSetup object.
2113 * @return The y-slope window (mm).
2114 */
2115 GoFx(k64f) GoSetup_YSlopeWindow(GoSetup setup);
2116
2117 /**
2118 * Gets the y-direction slope window minimum.
2119 *
2120 * @public @memberof GoSetup
2121 * @version Introduced in firmware 4.5.2.0
2122 * @param setup GoSetup object.
2123 * @return The y-slope window min (mm).
2124 */
2125 GoFx(k64f) GoSetup_YSlopeWindowLimitMin(GoSetup setup);
2126
2127 /**
2128 * Gets the y-direction slope window maximum.
2129 *
2130 * @public @memberof GoSetup
2131 * @version Introduced in firmware 4.5.2.0
2132 * @param setup GoSetup object.
2133 * @return The y-slope window max (mm).
2134 */
2135 GoFx(k64f) GoSetup_YSlopeWindowLimitMax(GoSetup setup);
2136
2137 /// @endcond
2138
2139 /// @cond (Gocator_2x00)
2140
2141 /**
2142 * Indicates whether Y gap filling can be used for the current scan mode and device family.
2143 *
2144 * @public @memberof GoSetup
2145 * @version Introduced in firmware 4.5.3.57
2146 * @param setup GoSetup object.
2147 * @return True if y-gap filling is available for use.
2148 */
2149 GoFx(kBool) GoSetup_YGapFillingUsed(GoSetup setup);
2150
2151 /**
2152 * Sets the status of y-direction gap-filling.
2153 *
2154 * @public @memberof GoSetup
2155 * @version Introduced in firmware 4.0.10.27
2156 * @param setup GoSetup object.
2157 * @param enable Enable or disable y-gap-filling
2158 * @return Operation status.
2159 */
2160 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
2161
2162 /**
2163 * Gets the status of y-direction gap-filling.
2164 *
2165 * @public @memberof GoSetup
2166 * @version Introduced in firmware 4.0.10.27
2167 * @param setup GoSetup object.
2168 * @return True if y-gap-filling is enabled.
2169 */
2170 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
2171
2172 /**
2173 * Sets the y-direction gap-filling window.
2174 *
2175 * @public @memberof GoSetup
2176 * @version Introduced in firmware 4.0.10.27
2177 * @param setup GoSetup object.
2178 * @param window The y-gap-filling window (mm).
2179 * @return
2180 */
2181 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
2182
2183 /**
2184 * Gets the y-direction gap-filling window.
2185 *
2186 * @public @memberof GoSetup
2187 * @version Introduced in firmware 4.0.10.27
2188 * @param setup GoSetup object.
2189 * @return The y-gap-filling window (mm).
2190 */
2191 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
2192
2193 /**
2194 * Gets the y-direction gap-filling window minimum.
2195 *
2196 * @public @memberof GoSetup
2197 * @version Introduced in firmware 4.0.10.27
2198 * @param setup GoSetup object.
2199 * @return The y-gap-filling window min (mm).
2200 */
2201 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
2202
2203 /**
2204 * Gets the y-direction gap-filling window maximum.
2205 *
2206 * @public @memberof GoSetup
2207 * @version Introduced in firmware 4.0.10.27
2208 * @param setup GoSetup object.
2209 * @return The y-gap-filling window max (mm).
2210 */
2211 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
2212
2213 /// @endcond
2214
2215 /**
2216 * Gets the maximum valid value for the Exposure setting.
2217 *
2218 * @public @memberof GoSetup
2219 * @version Introduced in firmware 4.0.10.27
2220 * @param setup GoSetup object.
2221 * @param role Determines which device to retrieve the value from.
2222 * @return Maximum valid Exposure value (microseconds).
2223 */
2224 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
2225
2226 /**
2227 * Gets the minimum valid value for the Exposure setting.
2228 *
2229 * @public @memberof GoSetup
2230 * @version Introduced in firmware 4.0.10.27
2231 * @param setup GoSetup object.
2232 * @param role Determines which device to retrieve the value from.
2233 * @return Minimum valid Exposure value (microseconds).
2234 */
2235 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
2236
2237 /**
2238 * Sets the exposure value.
2239 *
2240 * @public @memberof GoSetup
2241 * @version Introduced in firmware 4.0.10.27
2242 * @param setup GoSetup object.
2243 * @param role Determines which sensor to apply changes to.
2244 * @param exposure Intended exposure value.
2245 * @return Operation status.
2246 */
2247 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
2248
2249 /**
2250 * Gets the exposure value.
2251 *
2252 * @public @memberof GoSetup
2253 * @version Introduced in firmware 4.0.10.27
2254 * @param setup GoSetup object.
2255 * @param role Determines which device to retrieve the value from.
2256 * @return Exposure value (microseconds).
2257 */
2258 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
2259
2260 /**
2261 * Gets the exposure mode.
2262 *
2263 * @public @memberof GoSetup
2264 * @version Introduced in firmware 4.0.10.27
2265 * @param setup GoSetup object.
2266 * @param role Determines which device to retrieve the value from.
2267 * @return Exposure mode.
2268 */
2269 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
2270
2271 /**
2272 * Sets the exposure mode.
2273 *
2274 * @public @memberof GoSetup
2275 * @version Introduced in firmware 4.0.10.27
2276 * @param setup GoSetup object.
2277 * @param role Determines which sensor to apply changes to.
2278 * @param mode The exposure mode to use.
2279 * @return Operation status.
2280 */
2281 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
2282
2283 /**
2284 * Gets the exposure mode option at the given index.
2285 *
2286 * @public @memberof GoSetup
2287 * @version Introduced in firmware 4.0.10.27
2288 * @param setup GoSetup object.
2289 * @param role Determines which device to retrieve the value from.
2290 * @param index The index with which to retrieve an exposure mode option.
2291 * @return Exposure mode option.
2292 * @see GoSetup_ExposureModeOptionCount
2293 */
2294 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
2295
2296 /**
2297 * Gets the exposure mode option count.
2298 *
2299 * @public @memberof GoSetup
2300 * @version Introduced in firmware 4.0.10.27
2301 * @param setup GoSetup object.
2302 * @param role Determines which device to retrieve the value from.
2303 * @return Exposure mode option count.
2304 */
2305 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
2306
2307 /**
2308 * Adds an exposure step
2309 *
2310 * @public @memberof GoSetup
2311 * @version Introduced in firmware 4.0.10.27
2312 * @param setup GoSetup object.
2313 * @param role Determines which sensor to apply changes to.
2314 * @param exposure Exposure value (microseconds).
2315 * @return Operation status.
2316 */
2317 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
2318
2319 /**
2320 * Removes all exposure steps.
2321 *
2322 * @public @memberof GoSetup
2323 * @version Introduced in firmware 4.0.10.27
2324 * @param setup GoSetup object.
2325 * @param role Determines which sensor to apply changes to.
2326 * @return Operation status.
2327 */
2328 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
2329
2330 /**
2331 * Get the exposure step value specified by index
2332 *
2333 * @public @memberof GoSetup
2334 * @version Introduced in firmware 4.0.10.27
2335 * @param setup GoSetup object.
2336 * @param role Determines which device to retrieve the value from.
2337 * @param index The index of the exposure step to get.
2338 * @return The exposure step value (microseconds).
2339 * @see GoSetup_ExposureStepCount
2340 */
2341 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
2342
2343 /**
2344 * Get the number of exposure steps defined
2345 *
2346 * @public @memberof GoSetup
2347 * @version Introduced in firmware 4.0.10.27
2348 * @param setup GoSetup object.
2349 * @param role Determines which device to retrieve the value from.
2350 * @return The count of exposure steps.
2351 */
2352 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
2353
2354 /**
2355 * Gets the maximum value for the Dynamic Exposure setting.
2356 *
2357 * @public @memberof GoSetup
2358 * @version Introduced in firmware 4.0.10.27
2359 * @param setup GoSetup object.
2360 * @param role Determines which device to retrieve the value from.
2361 * @return Maximum Dynamic Exposure value (microseconds).
2362 */
2363 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
2364
2365 /**
2366 * Sets the maximum value for the Dynamic Exposure setting.
2367 *
2368 * @public @memberof GoSetup
2369 * @version Introduced in firmware 4.0.10.27
2370 * @param setup GoSetup object.
2371 * @param role Determines which sensor to apply changes to.
2372 * @param exposure Maximum Dynamic Exposure value (microseconds).
2373 * @return Operation status.
2374 */
2375 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
2376
2377 /**
2378 * Gets the minimum value for the Dynamic Exposure setting.
2379 *
2380 * @public @memberof GoSetup
2381 * @version Introduced in firmware 4.0.10.27
2382 * @param setup GoSetup object.
2383 * @param role Determines which device to retrieve the value from.
2384 * @return Minimum Dynamic Exposure value (microseconds).
2385 */
2386 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
2387
2388 /**
2389 * Sets the minimum value for the Dynamic Exposure setting.
2390 *
2391 * @public @memberof GoSetup
2392 * @version Introduced in firmware 4.0.10.27
2393 * @param setup GoSetup object.
2394 * @param role Determines which sensor to apply changes to.
2395 * @param exposure Minumum Dynamic Exposure value (microseconds).
2396 * @return Operation status.
2397 */
2398 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
2399
2400 /**
2401 * Gets the minimum valid value for the ActiveAreaHeight setting.
2402 *
2403 * @public @memberof GoSetup
2404 * @version Introduced in firmware 4.0.10.27
2405 * @param setup GoSetup object.
2406 * @param role Determines which device to retrieve the value from.
2407 * @return Minimum valid ActiveAreaHeight value (mm).
2408 */
2409 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
2410
2411 /**
2412 * Gets the maximum valid value for the ActiveAreaHeight setting.
2413 *
2414 * @public @memberof GoSetup
2415 * @version Introduced in firmware 4.0.10.27
2416 * @param setup GoSetup object.
2417 * @param role Determines which device to retrieve the value from.
2418 * @return Maximum valid active area height value (mm).
2419 */
2420 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
2421
2422 /**
2423 * Gets the active area height.
2424 *
2425 * @public @memberof GoSetup
2426 * @version Introduced in firmware 4.0.10.27
2427 * @param setup GoSetup object.
2428 * @param role Determines which device to retrieve the value from.
2429 * @return Active area height (mm).
2430 */
2431 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
2432
2433 /**
2434 * Sets the active area height.
2435 *
2436 * @public @memberof GoSetup
2437 * @version Introduced in firmware 4.0.10.27
2438 * @param setup GoSetup object.
2439 * @param role Determines which sensor to apply changes to.
2440 * @param value Active area height (mm).
2441 * @return Operation status.
2442 */
2443 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
2444
2445 /**
2446 * Gets the minimum valid value for the ActiveAreaLength setting.
2447 *
2448 * @public @memberof GoSetup
2449 * @version Introduced in firmware 4.0.10.27
2450 * @param setup GoSetup object.
2451 * @param role Determines which device to retrieve the value from.
2452 * @return Minimum valid ActiveAreaLength value (mm).
2453 */
2454 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
2455
2456 /**
2457 * Gets the maximum valid value for the ActiveAreaLength setting.
2458 *
2459 * @public @memberof GoSetup
2460 * @version Introduced in firmware 4.0.10.27
2461 * @param setup GoSetup object.
2462 * @param role Determines which device to retrieve the value from.
2463 * @return Maximum valid ActiveAreaLength value (mm).
2464 */
2465 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
2466
2467 /**
2468 * Sets the active area Length.
2469 *
2470 * @public @memberof GoSetup
2471 * @version Introduced in firmware 4.0.10.27
2472 * @param setup GoSetup object.
2473 * @param role Determines which sensor to apply changes to.
2474 * @param value Active area Length (mm).
2475 * @return Operation status.
2476 */
2477 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
2478
2479 /**
2480 * Gets the active area Length.
2481 *
2482 * @public @memberof GoSetup
2483 * @version Introduced in firmware 4.0.10.27
2484 * @param setup GoSetup object.
2485 * @param role Determines which device to retrieve the value from.
2486 * @return Active area Length (mm).
2487 */
2488 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
2489
2490
2491 /**
2492 * Gets the minimum valid value for the ActiveAreaWidth setting.
2493 *
2494 * @public @memberof GoSetup
2495 * @version Introduced in firmware 4.0.10.27
2496 * @param setup GoSetup object.
2497 * @param role Determines which device to retrieve the value from.
2498 * @return Minimum valid ActiveAreaWidth value (mm).
2499 */
2500 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
2501
2502 /**
2503 * Gets the maximum valid value for the ActiveAreaWidth setting.
2504 *
2505 * @public @memberof GoSetup
2506 * @version Introduced in firmware 4.0.10.27
2507 * @param setup GoSetup object.
2508 * @param role Determines which device to retrieve the value from.
2509 * @return Maximum valid ActiveAreaWidth value (mm).
2510 */
2511 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
2512
2513 /**
2514 * Sets the active area width.
2515 *
2516 * @public @memberof GoSetup
2517 * @version Introduced in firmware 4.0.10.27
2518 * @param setup GoSetup object.
2519 * @param role Determines which sensor to apply changes to.
2520 * @param value Active area width (mm).
2521 * @return Operation status.
2522 */
2523 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
2524
2525 /**
2526 * Gets the active area width.
2527 *
2528 * @public @memberof GoSetup
2529 * @version Introduced in firmware 4.0.10.27
2530 * @param setup GoSetup object.
2531 * @param role Determines which device to retrieve the value from.
2532 * @return Active area width (mm).
2533 */
2534 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
2535
2536 /**
2537 * Gets the minimum valid value for the ActiveAreaX setting.
2538 *
2539 * @public @memberof GoSetup
2540 * @version Introduced in firmware 4.0.10.27
2541 * @param setup GoSetup object.
2542 * @param role Determines which device to retrieve the value from.
2543 * @return Minimum valid ActiveAreaX value (mm).
2544 */
2545 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
2546
2547 /**
2548 * Gets the maximum valid value for the ActiveAreaX setting.
2549 *
2550 * @public @memberof GoSetup
2551 * @version Introduced in firmware 4.0.10.27
2552 * @param setup GoSetup object.
2553 * @param role Determines which device to retrieve the value from.
2554 * @return Maximum valid ActiveAreaX value (mm).
2555 */
2556 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
2557
2558 /**
2559 * Sets the active area x origin.
2560 *
2561 * @public @memberof GoSetup
2562 * @version Introduced in firmware 4.0.10.27
2563 * @param setup GoSetup object.
2564 * @param role Determines which sensor to apply changes to.
2565 * @param value Active area x origin (mm).
2566 * @return Operation status.
2567 */
2568 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
2569
2570 /**
2571 * Gets the active area x origin.
2572 *
2573 * @public @memberof GoSetup
2574 * @version Introduced in firmware 4.0.10.27
2575 * @param setup GoSetup object.
2576 * @param role Determines which device to retrieve the value from.
2577 * @return Active area x origin (mm).
2578 */
2579 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
2580
2581 /**
2582 * Gets the minimum valid value for the ActiveAreaY setting.
2583 *
2584 * @public @memberof GoSetup
2585 * @version Introduced in firmware 4.0.10.27
2586 * @param setup GoSetup object.
2587 * @param role Determines which device to retrieve the value from.
2588 * @return Minimum valid ActiveAreaY value (mm).
2589 */
2590 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
2591
2592 /**
2593 * Gets the maximum valid value for the ActiveAreaY setting.
2594 *
2595 * @public @memberof GoSetup
2596 * @version Introduced in firmware 4.0.10.27
2597 * @param setup GoSetup object.
2598 * @param role Determines which device to retrieve the value from.
2599 * @return Maximum valid ActiveAreaY value (mm).
2600 */
2601 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
2602
2603 /**
2604 * Sets the active area Y.
2605 *
2606 * @public @memberof GoSetup
2607 * @version Introduced in firmware 4.0.10.27
2608 * @param setup GoSetup object.
2609 * @param role Determines which sensor to apply changes to.
2610 * @param value Active area y origin (mm).
2611 * @return Operation status.
2612 */
2613 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
2614
2615 /**
2616 * Gets the active area Y.
2617 *
2618 * @public @memberof GoSetup
2619 * @version Introduced in firmware 4.0.10.27
2620 * @param setup GoSetup object.
2621 * @param role Determines which device to retrieve the value from.
2622 * @return Active area y origin (mm).
2623 */
2624 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
2625
2626 /**
2627 * Gets the minimum valid value for the ActiveAreaZ setting.
2628 *
2629 * @public @memberof GoSetup
2630 * @version Introduced in firmware 4.0.10.27
2631 * @param setup GoSetup object.
2632 * @param role Determines which device to retrieve the value from.
2633 * @return Minimum valid ActiveAreaZ value (mm).
2634 */
2635 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
2636
2637 /**
2638 * Gets the maximum valid value for the ActiveAreaZ setting.
2639 *
2640 * @public @memberof GoSetup
2641 * @version Introduced in firmware 4.0.10.27
2642 * @param setup GoSetup object.
2643 * @param role Determines which device to retrieve the value from.
2644 * @return Maximum valid ActiveAreaZ value (mm).
2645 */
2646 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
2647
2648 /**
2649 * Sets the active area z origin.
2650 *
2651 * @public @memberof GoSetup
2652 * @version Introduced in firmware 4.0.10.27
2653 * @param setup GoSetup object.
2654 * @param role Determines which sensor to apply changes to.
2655 * @param value Active area z origin (mm).
2656 * @return Operation status.
2657 */
2658 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
2659
2660 /**
2661 * Gets the active area z origin.
2662 *
2663 * @public @memberof GoSetup
2664 * @version Introduced in firmware 4.0.10.27
2665 * @param setup GoSetup object.
2666 * @param role Determines which device to retrieve the value from.
2667 * @return Active area z origin (mm).
2668 */
2669 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);
2670
2671 /**
2672 * Gets the transformed data region X value.
2673 *
2674 * @public @memberof GoSetup
2675 * @version Introduced in firmware 4.0.10.27
2676 * @param setup GoSetup object.
2677 * @param role The device whose value to retrieve.
2678 * @return The transformed data region X value.
2679 */
2680 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
2681
2682 /**
2683 * Gets the transformed data region Y value.
2684 *
2685 * @public @memberof GoSetup
2686 * @version Introduced in firmware 4.0.10.27
2687 * @param setup GoSetup object.
2688 * @param role The device whose value to retrieve.
2689 * @return The transformed data region Y value.
2690 */
2691 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
2692
2693 /**
2694 * Gets the transformed data region Z value.
2695 *
2696 * @public @memberof GoSetup
2697 * @version Introduced in firmware 4.0.10.27
2698 * @param setup GoSetup object.
2699 * @param role The device whose value to retrieve.
2700 * @return The transformed data region Z value.
2701 */
2702 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
2703
2704 /**
2705 * Gets the transformed data region width value.
2706 *
2707 * @public @memberof GoSetup
2708 * @version Introduced in firmware 4.0.10.27
2709 * @param setup GoSetup object.
2710 * @param role The device whose value to retrieve.
2711 * @return The transformed data region width value.
2712 */
2713 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
2714
2715 /**
2716 * Gets the transformed data region length value.
2717 *
2718 * @public @memberof GoSetup
2719 * @version Introduced in firmware 4.0.10.27
2720 * @param setup GoSetup object.
2721 * @param role The device whose value to retrieve.
2722 * @return The transformed data region length value.
2723 */
2724 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
2725
2726 /**
2727 * Gets the transformed data region height value.
2728 *
2729 * @public @memberof GoSetup
2730 * @version Introduced in firmware 4.0.10.27
2731 * @param setup GoSetup object.
2732 * @param role The device whose value to retrieve.
2733 * @return The transformed data region height value.
2734 */
2735 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
2736
2737 /**
2738 * Gets the count of valid x-resolution options.
2739 *
2740 * @public @memberof GoSetup
2741 * @version Introduced in firmware 4.0.10.27
2742 * @param setup GoSetup object.
2743 * @param role Determines which device to retrieve the value from.
2744 * @return Count of x-resolution options.
2745 */
2746 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
2747
2748 /**
2749 * Gets the x-resolution option at the specified index.
2750 *
2751 * @public @memberof GoSetup
2752 * @version Introduced in firmware 4.0.10.27
2753 * @param setup GoSetup object.
2754 * @param role Determines which device to retrieve the value from.
2755 * @param index Index of the desired resolution option.
2756 * @return X resolution option.
2757 * @see GoSetup_XSubsamplingOptionCount
2758 */
2759 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2760
2761 /**
2762 * Sets the current x-resolution divider.
2763 *
2764 * @public @memberof GoSetup
2765 * @version Introduced in firmware 4.0.10.27
2766 * @param setup GoSetup object.
2767 * @param role Determines which sensor to apply changes to.
2768 * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
2769 * @return Operation status.
2770 */
2771 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
2772
2773 /**
2774 * Gets the current x-resolution divider.
2775 *
2776 * @public @memberof GoSetup
2777 * @version Introduced in firmware 4.0.10.27
2778 * @param setup GoSetup object.
2779 * @param role Determines which device to retrieve the value from.
2780 * @return X resolution divider (e.g. 1 - full res, 2 - half res).
2781 */
2782 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
2783
2784 /**
2785 * Gets the count of valid z-resolution options.
2786 *
2787 * @public @memberof GoSetup
2788 * @version Introduced in firmware 4.0.10.27
2789 * @param setup GoSetup object.
2790 * @param role Determines which device to retrieve the value from.
2791 * @return Count of z-resolution options.
2792 */
2793 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
2794
2795 /**
2796 * Gets the z-resolution option at the specified index.
2797 *
2798 * @public @memberof GoSetup
2799 * @version Introduced in firmware 4.0.10.27
2800 * @param setup GoSetup object.
2801 * @param role Determines which device to retrieve the value from.
2802 * @param index Index of the desired resolution option.
2803 * @return Z resolution option.
2804 * see GoSetup_ZSubsamplingOptionCount
2805 */
2806 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
2807
2808 /**
2809 * Sets the current z-resolution divider.
2810 *
2811 * @public @memberof GoSetup
2812 * @version Introduced in firmware 4.0.10.27
2813 * @param setup GoSetup object.
2814 * @param role Determines which sensor to apply changes to.
2815 * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
2816 * @return Operation status.
2817 */
2818 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
2819
2820 /**
2821 * Gets the current z-resolution divider.
2822 *
2823 * @public @memberof GoSetup
2824 * @version Introduced in firmware 4.0.10.27
2825 * @param setup GoSetup object.
2826 * @param role Determines which device to retrieve the value from.
2827 * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
2828 */
2829 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
2830
2831 /**
2832 * Gets the camera region-of-interest x origin.
2833 *
2834 * @public @memberof GoSetup
2835 * @version Introduced in firmware 4.0.10.27
2836 * @param setup GoSetup object.
2837 * @param role Determines which device to retrieve the value from.
2838 * @return Region of interest x origin (pixels).
2839 */
2840 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
2841
2842 /**
2843 * Gets the camera region-of-interest y origin.
2844 *
2845 * @public @memberof GoSetup
2846 * @version Introduced in firmware 4.0.10.27
2847 * @param setup GoSetup object.
2848 * @param role Determines which device to retrieve the value from.
2849 * @return Region of interest y origin (pixels).
2850 */
2851 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
2852
2853 /**
2854 * Gets the camera region-of-interest width.
2855 *
2856 * @public @memberof GoSetup
2857 * @version Introduced in firmware 4.0.10.27
2858 * @param setup GoSetup object.
2859 * @param role Determines which device to retrieve the value from.
2860 * @return Region of interest width (pixels).
2861 */
2862 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
2863
2864 /**
2865 * Gets the camera region-of-interest height.
2866 *
2867 * @public @memberof GoSetup
2868 * @version Introduced in firmware 4.0.10.27
2869 * @param setup GoSetup object.
2870 * @param role Determines which device to retrieve the value from.
2871 * @return Region of interest height (pixels).
2872 */
2873 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
2874
2875 /**
2876 * Returns a boolean representing whether the back camera element is used.
2877 *
2878 * @public @memberof GoSetup
2879 * @version Introduced in firmware 4.1.3.106
2880 * @param setup GoSetup object.
2881 * @param role Determines which device to retrieve the value from.
2882 * @return kTRUE if used, or kFALSE if not used.
2883 */
2884 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
2885
2886 /**
2887 * Gets the camera region-of-interest x origin.
2888 *
2889 * @public @memberof GoSetup
2890 * @version Introduced in firmware 4.0.10.27
2891 * @param setup GoSetup object.
2892 * @param role Determines which device to retrieve the value from.
2893 * @return Region of interest x origin (pixels).
2894 */
2895 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
2896
2897 /**
2898 * Gets the camera region-of-interest y origin.
2899 *
2900 * @public @memberof GoSetup
2901 * @version Introduced in firmware 4.0.10.27
2902 * @param setup GoSetup object.
2903 * @param role Determines which device to retrieve the value from.
2904 * @return Region of interest y origin (pixels).
2905 */
2906 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
2907
2908 /**
2909 * Gets the camera region-of-interest width.
2910 *
2911 * @public @memberof GoSetup
2912 * @version Introduced in firmware 4.0.10.27
2913 * @param setup GoSetup object.
2914 * @param role Determines which device to retrieve the value from.
2915 * @return Region of interest width (pixels).
2916 */
2917 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
2918
2919 /**
2920 * Gets the camera region-of-interest height.
2921 *
2922 * @public @memberof GoSetup
2923 * @version Introduced in firmware 4.0.10.27
2924 * @param setup GoSetup object.
2925 * @param role Determines which device to retrieve the value from.
2926 * @return Region of interest height (pixels).
2927 */
2928 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
2929
2930 /**
2931 * Enables tracking.
2932 *
2933 * @public @memberof GoSetup
2934 * @version Introduced in firmware 4.0.10.27
2935 * @param setup GoSetup object.
2936 * @param role Determines which sensor to apply changes to.
2937 * @param enable kTRUE to enable, or kFALSE to disable.
2938 * @return Operation status.
2939 */
2940 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
2941
2942 /**
2943 * Determines if tracking is enabled.
2944 *
2945 * @public @memberof GoSetup
2946 * @version Introduced in firmware 4.0.10.27
2947 * @param setup GoSetup object.
2948 * @param role Determines which device to retrieve the value from.
2949 * @return kTRUE if enabled, or kFALSE if disabled.
2950 */
2951 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
2952
2953 /**
2954 * Returns a boolean value representing whether the Tracking Enabled field is used.
2955 *
2956 * @public @memberof GoSetup
2957 * @version Introduced in firmware 4.1.3.106
2958 * @param setup GoSetup object.
2959 * @param role Determines which device to retrieve the value from.
2960 * @return kTRUE if used, or kFALSE if not used.
2961 */
2962 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
2963
2964 /**
2965 * Sets the tracking window height.
2966 *
2967 * @public @memberof GoSetup
2968 * @version Introduced in firmware 4.0.10.27
2969 * @param setup GoSetup object.
2970 * @param role Determines which sensor to apply changes to.
2971 * @param height Tracking window height (mm).
2972 * @return Operation status.
2973 */
2974 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
2975
2976 /**
2977 * Gets the tracking window height.
2978 *
2979 * @public @memberof GoSetup
2980 * @version Introduced in firmware 4.0.10.27
2981 * @param setup GoSetup object.
2982 * @param role Determines which device to retrieve the value from.
2983 * @return Tracking window height (mm).
2984 */
2985 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
2986
2987 /**
2988 * Gets the tracking window height minimum limit.
2989 *
2990 * @public @memberof GoSetup
2991 * @version Introduced in firmware 4.0.10.27
2992 * @param setup GoSetup object.
2993 * @param role Determines which device to retrieve the value from.
2994 * @return Tracking window height min(mm).
2995 */
2996 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
2997
2998 /**
2999 * Gets the tracking window height maximum limit.
3000 *
3001 * @public @memberof GoSetup
3002 * @version Introduced in firmware 4.0.10.27
3003 * @param setup GoSetup object.
3004 * @param role Determines which device to retrieve the value from.
3005 * @return Tracking window height max(mm).
3006 */
3007 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
3008
3009 /**
3010 * Sets the tracking window search threshold.
3011 *
3012 * @public @memberof GoSetup
3013 * @version Introduced in firmware 4.0.10.27
3014 * @param setup GoSetup object.
3015 * @param role Determines which sensor to apply changes to.
3016 * @param threshold Tracking window search threshold (%)
3017 * @return Operation status.
3018 */
3019 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
3020
3021 /**
3022 * Gets the tracking window search threshold.
3023 *
3024 * @public @memberof GoSetup
3025 * @version Introduced in firmware 4.0.10.27
3026 * @param setup GoSetup object.
3027 * @param role Determines which device to retrieve the value from.
3028 * @return Tracking window search threshold (%).
3029 */
3030 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
3031
3032 /**
3033 * Returns the state of whether the user specified spacing interval is used.
3034 *
3035 * @public @memberof GoSetup
3036 * @version Introduced in firmware 4.0.10.27
3037 * @param setup GoSetup object.
3038 * @param role Determines which device to retrieve the value from.
3039 * @return kTRUE if the user value is used and kFALSE otherwise.
3040 */
3041 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
3042
3043 /**
3044 * Gets the spacing interval system value.
3045 *
3046 * @public @memberof GoSetup
3047 * @version Introduced in firmware 4.0.10.27
3048 * @param setup GoSetup object.
3049 * @param role Determines which device to retrieve the value from.
3050 * @return Spacing interval.
3051 */
3052 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
3053
3054 /**
3055 * Gets the spacing interval.
3056 *
3057 * @public @memberof GoSetup
3058 * @version Introduced in firmware 4.0.10.27
3059 * @param setup GoSetup object.
3060 * @param role Determines which device to retrieve the value from.
3061 * @return Spacing interval.
3062 */
3063 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
3064
3065 /// @cond (Gocator_3x00)
3066 /**
3067 * Sets the spacing interval.
3068 *
3069 * @public @memberof GoSetup
3070 * @version Introduced in firmware 4.0.10.27
3071 * @param setup GoSetup object.
3072 * @param role Determines which sensor to apply changes to.
3073 * @param value The spacing interval.
3074 * @return Operation status.
3075 */
3076 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
3077 /// @endcond
3078
3079 /**
3080 * Gets the spacing interval value limit minimum.
3081 *
3082 * @public @memberof GoSetup
3083 * @version Introduced in firmware 4.0.10.27
3084 * @param setup GoSetup object.
3085 * @param role Determines which device to retrieve the value from.
3086 * @return Spacing interval value limit minimum.
3087 */
3088 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
3089
3090 /**
3091 * Gets the spacing interval value limit maximum
3092 *
3093 * @public @memberof GoSetup
3094 * @version Introduced in firmware 4.0.10.27
3095 * @param setup GoSetup object.
3096 * @param role Determines which device to retrieve the value from.
3097 * @return Spacing interval value limit maximum.
3098 */
3099 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
3100
3101 /**
3102 * Gets the spacing interval type.
3103 *
3104 * @public @memberof GoSetup
3105 * @version Introduced in firmware 4.0.10.27
3106 * @param setup GoSetup object.
3107 * @param role Determines which device to retrieve the value from.
3108 * @return The spacing interval type.
3109 */
3110 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
3111
3112 /**
3113 * Sets the spacing interval type.
3114 *
3115 * @public @memberof GoSetup
3116 * @version Introduced in firmware 4.0.10.27
3117 * @param setup GoSetup object.
3118 * @param role Determines which sensor to apply changes to.
3119 * @param type The spacing interval type.
3120 * @return Operation status.
3121 */
3122 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
3123
3124 /**
3125 * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
3126 *
3127 * @public @memberof GoSetup
3128 * @version Introduced in firmware 4.0.10.27
3129 * @param setup GoSetup object.
3130 * @param role The device role from which to retrieve the setting.
3131 * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
3132 */
3133 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
3134
3135 /**
3136 * Gets the X spacing count.
3137 *
3138 * @public @memberof GoSetup
3139 * @version Introduced in firmware 4.0.10.27
3140 * @param setup GoSetup object.
3141 * @param role Determines which device to retrieve the value from.
3142 * @return X spacing count.
3143 */
3144 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
3145
3146 /**
3147 * Gets the Y spacing count.
3148 *
3149 * @public @memberof GoSetup
3150 * @version Introduced in firmware 4.0.10.27
3151 * @param setup GoSetup object.
3152 * @param role Determines which device to retrieve the value from.
3153 * @return Y spacing count.
3154 */
3155 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
3156
3157 /**
3158 * Gets the intensity step index.
3159 *
3160 * @public @memberof GoSetup
3161 * @version Introduced in firmware 4.0.10.27
3162 * @param setup GoSetup object.
3163 * @param role Determines which device to retrieve the value from.
3164 * @return The intensity step index.
3165 */
3166 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
3167
3168 /**
3169 * Sets the intensity step index.
3170 *
3171 * @public @memberof GoSetup
3172 * @version Introduced in firmware 4.0.10.27
3173 * @param setup GoSetup object.
3174 * @param role Determines which sensor to apply changes to.
3175 * @param index The exposure step index to use for intensity acquisition.
3176 * @return Operation status.
3177 * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
3178 */
3179 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
3180
3181 /**
3182 * Gets the pattern sequence type option count.
3183 *
3184 * @public @memberof GoSetup
3185 * @version Introduced in firmware 4.2.4.7
3186 * @param setup GoSetup object.
3187 * @param role Determines which device to retrieve the value from.
3188 * @return Pattern sequence type option count.
3189 */
3190 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
3191
3192 /**
3193 * Gets the pattern sequence type option at the given index.
3194 *
3195 * @public @memberof GoSetup
3196 * @version Introduced in firmware 4.2.4.7
3197 * @param setup GoSetup object.
3198 * @param role Determines which device to retrieve the value from.
3199 * @param index The index with which to retrieve a sequence type option.
3200 * @return A sequence type option value.
3201 * @see GoSetup_PatternSequenceOptionCount
3202 */
3203 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
3204
3205 /**
3206 * Gets the pattern sequence type.
3207 *
3208 * @public @memberof GoSetup
3209 * @version Introduced in firmware 4.2.4.7
3210 * @param setup GoSetup object.
3211 * @param role Determines which device to retrieve the value from.
3212 * @return The pattern sequence type.
3213 */
3214 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
3215
3216 /**
3217 * Sets the pattern sequence type.
3218 *
3219 * @public @memberof GoSetup
3220 * @version Introduced in firmware 4.2.4.7
3221 * @param setup GoSetup object.
3222 * @param role Determines which sensor to apply changes to.
3223 * @param type The pattern sequence type to set.
3224 * @return Operation status.
3225 */
3226 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
3227
3228 /**
3229 * Returns a boolean value representing whether the pattern sequence type is used.
3230 *
3231 * @public @memberof GoSetup
3232 * @version Introduced in firmware 4.2.4.7
3233 * @param setup GoSetup object.
3234 * @param role Determines which device to retrieve the value from.
3235 * @return kTRUE if used and kFALSE otherwise.
3236 */
3237 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
3238
3239 /**
3240 * Gets the current pattern sequence count.
3241 *
3242 * @public @memberof GoSetup
3243 * @version Introduced in firmware 4.2.4.7
3244 * @param setup GoSetup object.
3245 * @param role Determines which device to retrieve the value from.
3246 * @return The current pattern sequence count.
3247 */
3248 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
3249
3250
3251 /**
3252 * Gets the layout configuration module.
3253 *
3254 * @public @memberof GoSetup
3255 * @version Introduced in firmware 4.0.10.27
3256 * @param setup GoSetup object.
3257 * @return Layout configuration module.
3258 */
3259 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
3260
3261 /**
3262 * Gets the profile generation module, used for profile generation configuration.
3263 *
3264 * @public @memberof GoSetup
3265 * @version Introduced in firmware 4.2.4.7
3266 * @param setup GoSetup object.
3267 * @return Profile generation configuration module.
3268 */
3269 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
3270
3271 /**
3272 * Gets the surface generation module, used for surface generation configuration.
3273 *
3274 * @public @memberof GoSetup
3275 * @version Introduced in firmware 4.0.10.27
3276 * @param setup GoSetup object.
3277 * @return Surface generation configuration module.
3278 */
3279 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
3280
3281 /**
3282 * Gets the part detection module, used for part detection configuration.
3283 *
3284 * @public @memberof GoSetup
3285 * @version Introduced in firmware 4.0.10.27
3286 * @param setup GoSetup object.
3287 * @return Part detection configuration module.
3288 */
3289 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
3290
3291 /**
3292 * Gets the part matching module, used for part matching configuration.
3293 *
3294 * @public @memberof GoSetup
3295 * @version Introduced in firmware 4.2.4.7
3296 * @param setup GoSetup object.
3297 * @return Part matching configuration module.
3298 */
3299 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
3300
3301 /**
3302 * Gets the advanced acquisition module, used for advanced acquisition configuration.
3303 *
3304 * @public @memberof GoSetup
3305 * @version Introduced in firmware 4.6
3306 * @param setup GoSetup object.
3307 * @param role The device role whose advanced settings object to return.
3308 * @return Advanced acquisition configuration module.
3309 */
3310 GoFx(GoAdvanced) GoSetup_Advanced(GoSetup setup, GoRole role);
3311
3312 /**
3313 * @deprecated Gets the material acquisition module, used for material acquisition configuration.
3314 *
3315 * @public @memberof GoSetup
3316 * @version Introduced in firmware 4.1.3.106
3317 * @param setup GoSetup object.
3318 * @param role The device role whose material settings object to return.
3319 * @return Material acquisition configuration module.
3320 */
3321 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
3322
3323 /**
3324 * Gets the Section configuration module, used for surface sections.
3325 *
3326 * @public @memberof GoSetup
3327 * @version Introduced in firmware 4.4.4.14
3328 * @param setup GoSetup object.
3329 * @return Section configuration module.
3330 */
3331 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
3332
3333 /**
3334 * Gets the tracheid configuration module.
3335 *
3336 * @public @memberof GoSetup
3337 * @version Introduced in firmware 4.5.3.57
3338 * @param setup GoSetup object.
3339 * @param role Determines which device to retrieve the value from.
3340 * @return Tracheid configuration module.
3341 */
3342 GoFx(GoTracheid) GoSetup_Tracheid(GoSetup setup, GoRole role);
3343
3344 /**
3345 * Returns a boolean value representing the state of the independent exposures used field.
3346 * If this feature is available, it will use the exposure values and limits assigned to
3347 * both the front and back cameras.
3348 *
3349 * @public @memberof GoSetup
3350 * @version Introduced in firmware 4.6.0.140
3351 * @param setup GoSetup object.
3352 * @param role Determines which device to retrieve the value from.
3353 * @return kTRUE if used, or kFALSE if not used.
3354 */
3355 GoFx(kBool) GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role);
3356
3357 /**
3358 * Enables independent exposures feature, i.e. separate exposures
3359 * for separate cameras.
3360 *
3361 * @public @memberof GoSetup
3362 * @version Introduced in firmware 4.6.0.140
3363 * @param setup GoSetup object.
3364 * @param role Determines which sensor to apply changes to.
3365 * @param enable kTRUE to enable, or kFALSE to disable.
3366 * @return Operation status.
3367 */
3368 GoFx(kStatus) GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable);
3369
3370 /**
3371 * Determines if independent exposures feature is enabled.
3372 *
3373 * @public @memberof GoSetup
3374 * @version Introduced in firmware 4.6.0.140
3375 * @param setup GoSetup object.
3376 * @param role Determines which device to retrieve the value from.
3377 * @return kTRUE if enabled, or kFALSE if disabled.
3378 */
3379 GoFx(kBool) GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role);
3380
3381 /**
3382 * Gets the maximum valid value for the front camera exposure setting.
3383 *
3384 * @public @memberof GoSetup
3385 * @version Introduced in firmware 4.6.0.140
3386 * @param setup GoSetup object.
3387 * @param role Determines which device to retrieve the value from.
3388 * @return Maximum valid auxiliary exposure value (microseconds).
3389 */
3390 GoFx(k64f) GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role);
3391
3392 /**
3393 * Gets the minimum valid value for the front camara exposure setting.
3394 *
3395 * @public @memberof GoSetup
3396 * @version Introduced in firmware 4.6.0.140
3397 * @param setup GoSetup object.
3398 * @param role Determines which device to retrieve the value from.
3399 * @return Minimum valid auxiliary exposure value (microseconds).
3400 */
3401 GoFx(k64f) GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role);
3402
3403 /**
3404 * Sets the front camera exposure value.
3405 *
3406 * @public @memberof GoSetup
3407 * @version Introduced in firmware 4.6.0.140
3408 * @param setup GoSetup object.
3409 * @param role Determines which sensor to apply changes to.
3410 * @param exposure Intended auxiliary exposure value.
3411 * @return Operation status.
3412 */
3413 GoFx(kStatus) GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3414
3415 /**
3416 * Gets the front camera exposure value.
3417 *
3418 * @public @memberof GoSetup
3419 * @version Introduced in firmware 4.6.0.140
3420 * @param setup GoSetup object.
3421 * @param role Determines which device to retrieve the value from.
3422 * @return Auxiliary exposure value (microseconds).
3423 */
3424 GoFx(k64f) GoSetup_FrontCameraExposure(GoSetup setup, GoRole role);
3425
3426 /**
3427 * Gets the maximum valid value for the back camera exposure setting.
3428 *
3429 * @public @memberof GoSetup
3430 * @version Introduced in firmware 4.6.0.140
3431 * @param setup GoSetup object.
3432 * @param role Determines which device to retrieve the value from.
3433 * @return Maximum valid auxiliary exposure value (microseconds).
3434 */
3435 GoFx(k64f) GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role);
3436
3437 /**
3438 * Gets the minimum valid value for the back camara exposure setting.
3439 *
3440 * @public @memberof GoSetup
3441 * @version Introduced in firmware 4.6.0.140
3442 * @param setup GoSetup object.
3443 * @param role Determines which device to retrieve the value from.
3444 * @return Minimum valid auxiliary exposure value (microseconds).
3445 */
3446 GoFx(k64f) GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role);
3447
3448 /**
3449 * Sets the back camera exposure value.
3450 *
3451 * @public @memberof GoSetup
3452 * @version Introduced in firmware 4.6.0.140
3453 * @param setup GoSetup object.
3454 * @param role Determines which sensor to apply changes to.
3455 * @param exposure Intended auxiliary exposure value.
3456 * @return Operation status.
3457 */
3458 GoFx(kStatus) GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure);
3459
3460 /**
3461 * Gets the back camera exposure value.
3462 *
3463 * @public @memberof GoSetup
3464 * @version Introduced in firmware 4.6.0.140
3465 * @param setup GoSetup object.
3466 * @param role Determines which device to retrieve the value from.
3467 * @return Auxiliary exposure value (microseconds).
3468 */
3469 GoFx(k64f) GoSetup_BackCameraExposure(GoSetup setup, GoRole role);
3470
3471 /**
3472 * Gets the source used for generating intensity data.
3473 *
3474 * @public @memberof GoSetup
3475 * @version Introduced in firmware 4.6.0.152
3476 * @param setup GoSetup object.
3477 * @param role Determines which device to retrieve the value from.
3478 * @return Source of intensity data.
3479 */
3480 GoFx(GoIntensitySource) GoSetup_IntensitySource(GoSetup setup, GoRole role);
3481
3482 /**
3483 * Sets the source to be used for generating intensity data.
3484 *
3485 * @public @memberof GoSetup
3486 * @version Introduced in firmware 4.6.0.152
3487 * @param setup GoSetup object.
3488 * @param role Determines which sensor to apply changes to.
3489 * @param source The source to be used.
3490 * @return Operation status.
3491 */
3492 GoFx(kStatus) GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source);
3493
3494 /**
3495 * Gets the intensity data generation mode.
3496 *
3497 * @public @memberof GoSetup
3498 * @version Introduced in firmware 4.7.10.10
3499 * @param setup GoSetup object.
3500 * @param role Determines which device to retrieve the value from.
3501 * @return Intensity generation mode.
3502 */
3503 GoFx(GoIntensityMode) GoSetup_IntensityMode(GoSetup setup, GoRole role);
3504
3505 /**
3506 * Sets the intensity data generation mode.
3507 *
3508 * @public @memberof GoSetup
3509 * @version Introduced in firmware 4.7.10.10
3510 * @param setup GoSetup object.
3511 * @param role Determines which sensor to apply changes to.
3512 * @param mode Intensity generation mode.
3513 * @return Operation status.
3514 */
3515 GoFx(kStatus) GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode);
3516
3517 /**
3518 * Gets the availability of the intensity mode property.
3519 *
3520 * @public @memberof GoSetup
3521 * @version Introduced in firmware 4.7.10.10
3522 * @param setup GoSetup object.
3523 * @param role Determines which device to retrieve the value from.
3524 * @return kTRUE if available and kFALSE otherwise.
3525 */
3526 GoFx(kBool) GoSetup_IntensityModeUsed(GoSetup setup, GoRole role);
3527
3528 /**
3529 * Gets the intensity source option at the given index.
3530 *
3531 * @public @memberof GoSetup
3532 * @version Introduced in firmware 4.6.0.152
3533 * @param setup GoSetup object.
3534 * @param role Determines which device to retrieve the value from.
3535 * @param index The index with which to retrieve an exposure mode option.
3536 * @return Intensity source set.
3537 * @see GoSetup_IntensitySourceOptionCount
3538 */
3539 GoFx(GoIntensitySource) GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index);
3540
3541 /**
3542 * Gets the intensity source option count.
3543 *
3544 * @public @memberof GoSetup
3545 * @version Introduced in firmware 4.6.0.152
3546 * @param setup GoSetup object.
3547 * @param role Determines which device to retrieve the value from.
3548 * @return Intensity source option count.
3549 */
3550 GoFx(kSize) GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role);
3551
3552
3553 kEndHeader()
3554 #include <GoSdk/GoSetup.x.h>
3555
3556 #endif
GoSetup::GoSetup_InputTriggerEnabledSystemValue
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger system value.
GoSetup::GoSetup_BarHoleCountValue
kSize GoSetup_BarHoleCountValue(GoSetup setup)
Gets the bar hole count system value.
GoSetup::GoSetup_EnableAlignmentEncoderCalibrate
kStatus GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled)
Enables encoder calibration after alignment.
GoSetup::GoSetup_OcclusionReductionEnabledUsed
kBool GoSetup_OcclusionReductionEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction configuration is used...
GoSetup::GoSetup_ActiveAreaHeightLimitMin
k64f GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_ExternalInputZPulseIndex
k32u GoSetup_ExternalInputZPulseIndex(GoSetup setup)
Gets the external input index for triggering encoder Z-pulse.
GoSetup::GoSetup_ActiveAreaZLimitMin
k64f GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_ActiveAreaWidth
k64f GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role)
Gets the active area width.
GoSetup::GoSetup_TriggerGateEnabled
kBool GoSetup_TriggerGateEnabled(GoSetup setup)
Reports whether the trigger gate feature is currently enabled.
k32u
GoSetup::GoSetup_ActiveAreaXLimitMax
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_LayoutGridColumnSystemValue
k32s GoSetup_LayoutGridColumnSystemValue(GoSetup setup, GoRole role)
Gets layout grid column index.
GoSetup::GoSetup_ActiveAreaHeightLimitMax
k64f GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaHeight setting.
GoSetup::GoSetup_SetActiveAreaLength
kStatus GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value)
Sets the active area Length.
GoSetup::GoSetup_TriggerUnit
GoTriggerUnits GoSetup_TriggerUnit(GoSetup setup)
Gets the system trigger units.
GoSetup::GoSetup_SetPlateHoleCount
kStatus GoSetup_SetPlateHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_SetAlignmentType
kStatus GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type)
Sets the type used for alignment.
GoSetup::GoSetup_ActiveAreaWidthLimitMax
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
GoIntensitySource
Represents all possible sources of intensity data.
GoSetup::GoSetup_LayoutGridRowSystemValue
k32s GoSetup_LayoutGridRowSystemValue(GoSetup setup, GoRole role)
Gets layout grid row index.
GoSetup::GoSetup_Exposure
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
GoSetup::GoSetup_ActiveAreaY
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
GoSetup::GoSetup_SetReversalDistanceAutoEnabled
kStatus GoSetup_SetReversalDistanceAutoEnabled(GoSetup setup, kBool enabled)
This API is experimental and may change in a future release Enables or disables auto encoder reversal...
GoSetup::GoSetup_ZSubsamplingOptionAt
k32u GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the z-resolution option at the specified index.
GoPartDetection.h
Declares the GoPartDetection class.
GoSetup::GoSetup_EnableMaxFrameRate
kStatus GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable)
Enables or disables operation at full frame rate (ignoring frame rate setting).
GoSetup::GoSetup_TrackingAreaHeight
k64f GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role)
Gets the tracking window height.
GoSetup::GoSetup_ActiveAreaYLimitMin
k64f GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_ReversalDistanceAutoEnabled
kBool GoSetup_ReversalDistanceAutoEnabled(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
GoSetup::GoSetup_PatternSequenceTypeOptionCount
kSize GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role)
Gets the pattern sequence type option count.
GoSetup::GoSetup_AddExposureStep
kStatus GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure)
Adds an exposure step.
GoSetup::GoSetup_TriggerDelay
k64f GoSetup_TriggerDelay(GoSetup setup)
Gets the trigger delay.
GoSetup::GoSetup_EnablePreferMasterTimeEncoderEnabled
kStatus GoSetup_EnablePreferMasterTimeEncoderEnabled(GoSetup setup, kBool enable)
Sets the state of the Gets the state of the Master time encoder.
GoSetup::GoSetup_SetActiveAreaWidth
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
GoSetup::GoSetup_BarDegreesOfFreedomUsed
kBool GoSetup_BarDegreesOfFreedomUsed(GoSetup setup)
Indicates if the degrees of freedom for bar alignment can be modified by the user.
GoSections.h
Declares the GoSections class.
k64u
GoSetup::GoSetup_BackCameraX
k32u GoSetup_BackCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_XSubsamplingOptionCount
kSize GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid x-resolution options.
GoSetup::GoSetup_BackCameraExposure
k64f GoSetup_BackCameraExposure(GoSetup setup, GoRole role)
Gets the back camera exposure value.
GoSetup::GoSetup_TransformedDataRegionX
k64f GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role)
Gets the transformed data region X value.
GoTracheid
Represents tracheid data.
GoSetup::GoSetup_TransformedDataRegionLength
k64f GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role)
Gets the transformed data region length value.
GoSetup::GoSetup_IntensityEnabled
kBool GoSetup_IntensityEnabled(GoSetup setup)
Reports whether the profile intensity collection is enabled.
GoSetup::GoSetup_SetZSubsampling
kStatus GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling)
Sets the current z-resolution divider.
GoSetup::GoSetup_AlignmentTypeOptionCount
kSize GoSetup_AlignmentTypeOptionCount(GoSetup setup)
Gets the alignment type option count.
GoSetup::GoSetup_EnableTriggerGate
kStatus GoSetup_EnableTriggerGate(GoSetup setup, kBool enable)
Sets the trigger gate feature.
GoSetup::GoSetup_BarHoleCount
kSize GoSetup_BarHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration bar.
GoSetup::GoSetup_SetBarHoleDistance
kStatus GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance)
Sets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_TrackingUsed
kBool GoSetup_TrackingUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the Tracking Enabled field is used.
GoSetup::GoSetup_EncoderTriggerMode
GoEncoderTriggerMode GoSetup_EncoderTriggerMode(GoSetup setup)
Gets the encoder trigger mode.
GoSetup::GoSetup_TriggerBurstEnabled
kBool GoSetup_TriggerBurstEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
GoSetup::GoSetup_IntensitySourceOptionCount
kSize GoSetup_IntensitySourceOptionCount(GoSetup setup, GoRole role)
Gets the intensity source option count.
GoSetup::GoSetup_EncoderSpacingLimitMin
k64f GoSetup_EncoderSpacingLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Encoder Period setting.
GoSetup::GoSetup_SetDynamicExposureMax
kStatus GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure)
Sets the maximum value for the Dynamic Exposure setting.
GoSetup::GoSetup_FlickerFreeModeEnabled
kBool GoSetup_FlickerFreeModeEnabled(GoSetup setup)
Reports whether flicker free mode is enabled.
GoSetup::GoSetup_SetExposureMode
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
GoSetup::GoSetup_SetFrameRate
kStatus GoSetup_SetFrameRate(GoSetup setup, k64f frameRate)
Sets the current frame rate for time-based triggering.
GoSetup::GoSetup_TrackingSearchThreshold
k64f GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role)
Gets the tracking window search threshold.
GoSetup::GoSetup_ZSubsampling
k32u GoSetup_ZSubsampling(GoSetup setup, GoRole role)
Gets the current z-resolution divider.
GoSetup::GoSetup_SetActiveAreaX
kStatus GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value)
Sets the active area x origin.
GoSetup::GoSetup_IndependentExposuresUsed
kBool GoSetup_IndependentExposuresUsed(GoSetup setup, GoRole role)
Returns a boolean value representing the state of the independent exposures used field.
GoSetup::GoSetup_ZSubsamplingOptionCount
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
GoRole
Represents a user role.
GoSetup::GoSetup_AlignmentUsed
kBool GoSetup_AlignmentUsed(GoSetup setup)
Indicates whether alignment can be used.
kSize
GoSetup::GoSetup_SetSpacingIntervalType
kStatus GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type)
Sets the spacing interval type.
GoSetup::GoSetup_OcclusionReductionAlg
GoOcclusionReductionAlg GoSetup_OcclusionReductionAlg(GoSetup setup)
Gets the occlusion reduction algorithm.
GoSetup::GoSetup_FrameRateLimitMax
k64f GoSetup_FrameRateLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Frame Rate setting.
GoSetup::GoSetup_ScanModeOptionAt
GoMode GoSetup_ScanModeOptionAt(GoSetup setup, kSize index)
Gets the scan mode option at the specified index.
GoSetup::GoSetup_PatternSequenceCount
kSize GoSetup_PatternSequenceCount(GoSetup setup, GoRole role)
Gets the current pattern sequence count.
GoAlignmentDegreesOfFreedom
Represents an alignment degree of freedom setting.
GoSetup::GoSetup_SetPlateRefHoleDiameter
kStatus GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_BackCameraHeight
k32u GoSetup_BackCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
GoSetup::GoSetup_FrameRate
k64f GoSetup_FrameRate(GoSetup setup)
Reports the currently configured frame rate.
GoSetup::GoSetup_BackCameraUsed
k32u GoSetup_BackCameraUsed(GoSetup setup, GoRole role)
Returns a boolean representing whether the back camera element is used.
GoSetup::GoSetup_LaserIdleTime
k64u GoSetup_LaserIdleTime(GoSetup setup)
This API is experimental and may change in a future release Gets the idle time before laser deactivat...
GoSetup::GoSetup_SetLaserWakeupEncoderTravel
kStatus GoSetup_SetLaserWakeupEncoderTravel(GoSetup setup, k64u distance)
This API is experimental and may change in a future release Sets the encoder wakeup travel distance...
GoSetup::GoSetup_XSpacingCount
k32u GoSetup_XSpacingCount(GoSetup setup, GoRole role)
Gets the X spacing count.
GoSetup::GoSetup_ActiveAreaZ
k64f GoSetup_ActiveAreaZ(GoSetup setup, GoRole role)
Gets the active area z origin.
GoTrigger
Represents a trigger.
GoSetup::GoSetup_ReversalDistanceSystemValue
k64f GoSetup_ReversalDistanceSystemValue(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_IntensityMode
GoIntensityMode GoSetup_IntensityMode(GoSetup setup, GoRole role)
Gets the intensity data generation mode.
GoSetup::GoSetup_YSpacingCount
k32u GoSetup_YSpacingCount(GoSetup setup, GoRole role)
Gets the Y spacing count.
GoSetup::GoSetup_FrontCameraWidth
k32u GoSetup_FrontCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_SpacingIntervalType
GoSpacingIntervalType GoSetup_SpacingIntervalType(GoSetup setup, GoRole role)
Gets the spacing interval type.
kChar
GoSetup::GoSetup_IntensitySourceOptionAt
GoIntensitySource GoSetup_IntensitySourceOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the intensity source option at the given index.
GoSetup::GoSetup_PlateSecHoleDiameter
k64f GoSetup_PlateSecHoleDiameter(GoSetup setup)
Gets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_FrontCameraX
k32u GoSetup_FrontCameraX(GoSetup setup, GoRole role)
Gets the camera region-of-interest x origin.
GoSetup::GoSetup_SetTrackingSearchThreshold
kStatus GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold)
Sets the tracking window search threshold.
GoSetup::GoSetup_FrameDataRate
k64f GoSetup_FrameDataRate(GoSetup setup)
Reports the current frame rate of normal (range, profile, or surface) data.
GoSetup::GoSetup_PlateHoleCount
kSize GoSetup_PlateHoleCount(GoSetup setup)
Gets the number of holes that are defined on the calibration plate.
GoSetup::GoSetup_AlignmentType
GoAlignmentType GoSetup_AlignmentType(GoSetup setup)
Gets the type used for alignment calibration.
GoSetup::GoSetup_TriggerBurstCount
k32u GoSetup_TriggerBurstCount(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst count...
GoSetup::GoSetup_AlignmentStationaryTargetOptionAt
GoAlignmentTarget GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index)
Gets the stationary alignment target option at the given index.
GoSetup::GoSetup_EnableTracking
kStatus GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable)
Enables tracking.
GoSetup::GoSetup_OcclusionReductionAlgUsed
kBool GoSetup_OcclusionReductionAlgUsed(GoSetup setup)
Returns a boolean representing whether the user occlusion reduction algorithm is used.
GoSetup::GoSetup_ActiveAreaLengthLimitMax
k64f GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_OcclusionReductionEnabled
kBool GoSetup_OcclusionReductionEnabled(GoSetup setup)
Gets the occlusion reduction enabled state.
GoSetup::GoSetup_Sections
GoSections GoSetup_Sections(GoSetup setup)
Gets the Section configuration module, used for surface sections.
GoSetup::GoSetup_Material
GoMaterial GoSetup_Material(GoSetup setup, GoRole role)
GoSetup::GoSetup_IntensitySource
GoIntensitySource GoSetup_IntensitySource(GoSetup setup, GoRole role)
Gets the source used for generating intensity data.
GoSetup::GoSetup_EnableTemperatureSafety
kStatus GoSetup_EnableTemperatureSafety(GoSetup setup, kBool enable)
Enables the temperature saftey of the sensor system.
GoLayout
Represents a layout related sensor configuration.
GoTracheid.h
Declares the GoTransform class.
GoSetup::GoSetup_Tracheid
GoTracheid GoSetup_Tracheid(GoSetup setup, GoRole role)
Gets the tracheid configuration module.
GoSetup::GoSetup_SetBarHeight
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
GoSetup::GoSetup_SetActiveAreaY
kStatus GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value)
Sets the active area Y.
GoSetup::GoSetup_ClearPolygonCorners
kStatus GoSetup_ClearPolygonCorners(GoSetup setup)
Clears all corner parameter objects from the collection of polygon corners for alignment.
GoSetup::GoSetup_SetLaserIdleTime
kStatus GoSetup_SetLaserIdleTime(GoSetup setup, k64u time)
This API is experimental and may change in a future release Sets the time before the laser deactivate...
GoSetup::GoSetup_TracheidRate
k64f GoSetup_TracheidRate(GoSetup setup)
Reports the current frame rate of Tracheid data.
GoSetup::GoSetup_PolygonCornerCount
kSize GoSetup_PolygonCornerCount(GoSetup setup)
Gets the number of corner parameters defined in the collection of polygon corners.
GoSetup::GoSetup_SetBackCameraExposure
kStatus GoSetup_SetBackCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the back camera exposure value.
GoSetup::GoSetup_SpacingInterval
k64f GoSetup_SpacingInterval(GoSetup setup, GoRole role)
Gets the spacing interval.
GoSetup::GoSetup_TransformedDataRegionZ
k64f GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role)
Gets the transformed data region Z value.
GoSetup::GoSetup_ActiveAreaXLimitMin
k64f GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaX setting.
GoSetup::GoSetup_SetTriggerBurstEnabled
kStatus GoSetup_SetTriggerBurstEnabled(GoSetup setup, kBool enable)
This API is experimental and may change in a future release Enables the trigger burst.
GoSetup::GoSetup_ScanModeOptionCount
kSize GoSetup_ScanModeOptionCount(GoSetup setup)
Gets the scan mode option count.
GoSetup::GoSetup_TriggerGateEnabledSystemValue
kBool GoSetup_TriggerGateEnabledSystemValue(GoSetup setup)
Reports the trigger gate enabled system value.
GoSurfaceGeneration
Represents a surface generation configuration.
GoSetup::GoSetup_FrontCameraExposureLimitMax
k64f GoSetup_FrontCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the front camera exposure setting.
GoSetup::GoSetup_SetBarHoleCount
kStatus GoSetup_SetBarHoleCount(GoSetup setup, kSize count)
Sets the number of holes that are defined on the calibration bar.
GoSdkDef.h
Essential SDK declarations.
GoSetup::GoSetup_EnableExternalInputZPulse
kStatus GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable)
Sets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_FrontCameraY
k32u GoSetup_FrontCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_SetEncoderSpacing
kStatus GoSetup_SetEncoderSpacing(GoSetup setup, k64f period)
Sets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_SetBarDegreesOfFreedom
kStatus GoSetup_SetBarDegreesOfFreedom(GoSetup setup, GoAlignmentDegreesOfFreedom dof)
Sets the degrees of freedom used for bar alignment calibration.
GoSetup::GoSetup_Advanced
GoAdvanced GoSetup_Advanced(GoSetup setup, GoRole role)
Gets the advanced acquisition module, used for advanced acquisition configuration.
GoSetup::GoSetup_BarHoleDistance
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_InputTriggerEnabledUsed
kBool GoSetup_InputTriggerEnabledUsed(GoSetup setup)
Returns a boolean representing whether the user input trigger configuration is used.
GoSetup::GoSetup_BarWidth
k64f GoSetup_BarWidth(GoSetup setup)
Gets the width of the bar used for travel calibration.
GoSetup::GoSetup_InputTriggerEnabled
kBool GoSetup_InputTriggerEnabled(GoSetup setup)
Gets the input trigger enabled state.
GoSetup::GoSetup_IndependentExposuresEnabled
kBool GoSetup_IndependentExposuresEnabled(GoSetup setup, GoRole role)
Determines if independent exposures feature is enabled.
GoSetup::GoSetup_ReversalDistance
k64f GoSetup_ReversalDistance(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_IntensityModeUsed
kBool GoSetup_IntensityModeUsed(GoSetup setup, GoRole role)
Gets the availability of the intensity mode property.
GoSetup::GoSetup_SpacingIntervalLimitMin
k64f GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role)
Gets the spacing interval value limit minimum.
GoSetup::GoSetup_EnableIntensity
kStatus GoSetup_EnableIntensity(GoSetup setup, kBool enable)
Enables profile intensity collection.
GoPartDetection
Represents the part detection parameters of the surface mode configuration.
GoSetup::GoSetup_SetTriggerSource
kStatus GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source)
Sets the trigger source for profile triggering.
GoIntensityMode
Represents all possible intensity generation modes for multiple exposures.
GoSetup::GoSetup_SetScanMode
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the scan mode.
GoSetup::GoSetup_SurfaceGeneration
GoSurfaceGeneration GoSetup_SurfaceGeneration(GoSetup setup)
Gets the surface generation module, used for surface generation configuration.
GoSetup::GoSetup_PartMatching
GoPartMatching GoSetup_PartMatching(GoSetup setup)
Gets the part matching module, used for part matching configuration.
GoSetup::GoSetup_SetAlignmentStationaryTarget
kStatus GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target)
Sets the target type used for stationary alignment calibration.
GoSetup::GoSetup_SetTrackingAreaHeight
kStatus GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height)
Sets the tracking window height.
GoSetup::GoSetup_AlignmentStationaryTargetOptionCount
kSize GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup)
Gets the stationary alignment target option count.
GoSetup::GoSetup_BarHeight
k64f GoSetup_BarHeight(GoSetup setup)
Gets the height of the bar used for travel calibration.
GoSetup::GoSetup_BackCameraY
k32u GoSetup_BackCameraY(GoSetup setup, GoRole role)
Gets the camera region-of-interest y origin.
GoSetup::GoSetup_TriggerGateEnabledUsed
kBool GoSetup_TriggerGateEnabledUsed(GoSetup setup)
Gets the system value representing whether or not the user specified trigger gate enabled setting is ...
GoSetup::GoSetup_ActiveAreaLengthLimitMin
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
GoSetup::GoSetup_LaserSleepModeEnabled
kBool GoSetup_LaserSleepModeEnabled(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode enabled state...
GoSetup::GoSetup_SpacingIntervalSystemValue
k64f GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role)
Gets the spacing interval system value.
GoSetup::GoSetup_AlignmentStationaryTarget
GoAlignmentTarget GoSetup_AlignmentStationaryTarget(GoSetup setup)
Gets the target type used for stationary alignment calibration.
GoSetup::GoSetup_PatternSequenceTypeOptionAt
GoPatternSequenceType GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the pattern sequence type option at the given index.
GoSetup::GoSetup_FrameRateLimitMin
k64f GoSetup_FrameRateLimitMin(GoSetup setup)
Constraint for the minimum valid value of the Frame Rate setting.
GoSetup::GoSetup_ReversalDistanceAutoEnabledUsed
kBool GoSetup_ReversalDistanceAutoEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Returns whether or not auto encoder rever...
GoSetup::GoSetup_LaserSleepUsed
kBool GoSetup_LaserSleepUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the laser sleep mode used value...
GoSetup::GoSetup_TransformedDataRegionWidth
k64f GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role)
Gets the transformed data region width value.
GoSetup::GoSetup_SetExposure
kStatus GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the exposure value.
GoSetup::GoSetup_LayoutMultiplexingBank
k32s GoSetup_LayoutMultiplexingBank(GoSetup setup, GoRole role)
Gets Multiplex bank used state.
GoSetup::GoSetup_BarHoleCountUsed
kBool GoSetup_BarHoleCountUsed(GoSetup setup)
Indicates if the hole count can be modified by the user.
GoSetup::GoSetup_TriggerBurstCountUsed
kBool GoSetup_TriggerBurstCountUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst used value...
GoSetup::GoSetup_EnableFlickerFreeMode
kStatus GoSetup_EnableFlickerFreeMode(GoSetup setup, kBool enable)
Enables flicker reduction mode.
GoSetup::GoSetup_TrackingAreaHeightLimitMin
k64f GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role)
Gets the tracking window height minimum limit.
GoSetup::GoSetup_ExternalInputZPulseEnabled
kBool GoSetup_ExternalInputZPulseEnabled(GoSetup setup)
Gets the state of the external input triggered encoder Z-pulse feature.
GoSetup::GoSetup_BarHoleDiameterUsed
kBool GoSetup_BarHoleDiameterUsed(GoSetup setup)
Indicates if the hole diameter can be modified by the user.
k32s
GoSetup::GoSetup_Layout
GoLayout GoSetup_Layout(GoSetup setup)
Gets the layout configuration module.
GoSetup::GoSetup_IntensityStepIndex
kSize GoSetup_IntensityStepIndex(GoSetup setup, GoRole role)
Gets the intensity step index.
GoTriggerUnits
Represents the system's primary synchronization domain.
GoSetup::GoSetup_SpacingIntervalTypeUsed
kBool GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role)
Gets the system value representing whether or not the user specified spacing interval type setting is...
GoSetup::GoSetup_ExposureStepAt
k64f GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index)
Get the exposure step value specified by index.
GoEncoderTriggerMode
Represents an encoder's triggering behavior.
GoSetup::GoSetup_TriggerDelayLimitMin
k64f GoSetup_TriggerDelayLimitMin(GoSetup setup)
Reports the minimum trigger delay, based on current settings.
GoPolygonCornerParameters
Corner parameters for polygon corner alignment.
Definition: GoSdkDef.h:557
GoSetup::GoSetup_BackCameraExposureLimitMax
k64f GoSetup_BackCameraExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the back camera exposure setting.
GoSetup::GoSetup_SetReversalDistance
kStatus GoSetup_SetReversalDistance(GoSetup setup, k64f threshold)
This API is experimental and may change in a future release Sets the encoder reversal distance thresh...
GoSetup::GoSetup_SetActiveAreaZ
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
GoSetup::GoSetup_SetTriggerBurstCount
kStatus GoSetup_SetTriggerBurstCount(GoSetup setup, k32u count)
This API is experimental and may change in a future release Sets the trigger burst count...
GoAlignmentTarget
Represents an alignment target type.
GoSetup::GoSetup_FrontCameraExposure
k64f GoSetup_FrontCameraExposure(GoSetup setup, GoRole role)
Gets the front camera exposure value.
GoSetup::GoSetup_BarDegreesOfFreedom
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedom(GoSetup setup)
Gets the degrees of freedom used for bar alignment calibration.
GoSetup::GoSetup_LayoutMultiplexingBankUsed
kBool GoSetup_LayoutMultiplexingBankUsed(GoSetup setup, GoRole role)
Gets Multiplex bank used state.
GoExposureMode
Represents all possible exposure modes.
GoSetup::GoSetup_TriggerSource
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
GoSetup::GoSetup_SetPatternSequenceType
kStatus GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type)
Sets the pattern sequence type.
GoSetup::GoSetup_ClearExposureSteps
kStatus GoSetup_ClearExposureSteps(GoSetup setup, GoRole role)
Removes all exposure steps.
GoSetup::GoSetup_SetTriggerDelay
kStatus GoSetup_SetTriggerDelay(GoSetup setup, k64f delay)
Sets the trigger delay.
GoSurfaceGeneration.h
Declares the GoSurfaceGeneration class.
GoPatternSequenceType
Represents a pattern sequence type.
GoSetup::GoSetup_PlateHeight
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
GoSetup::GoSetup_ExposureLimitMin
k64f GoSetup_ExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the Exposure setting.
GoSetup::GoSetup_SetSpacingInterval
kStatus GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value)
Sets the spacing interval.
GoSetup::GoSetup_SetPlateHeight
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
GoSetup::GoSetup_SetLaserSleepModeEnabled
kStatus GoSetup_SetLaserSleepModeEnabled(GoSetup setup, kBool enable)
This API is experimental and may change in a future release Enables laser sleep mode.
GoSetup::GoSetup_TriggerDelayLimitMax
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
GoSetup::GoSetup_PatternSequenceTypeUsed
kBool GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role)
Returns a boolean value representing whether the pattern sequence type is used.
GoSetup::GoSetup_ExposureModeOptionAt
GoExposureMode GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the exposure mode option at the given index.
GoSetup::GoSetup_LayoutGridDirectionSystemValue
k32s GoSetup_LayoutGridDirectionSystemValue(GoSetup setup, GoRole role)
Gets layout grid direction.
GoSetup::GoSetup_SetBarWidth
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
GoSetup::GoSetup_SetOcclusionReductionAlg
kStatus GoSetup_SetOcclusionReductionAlg(GoSetup setup, GoOcclusionReductionAlg alg)
Sets the occlusion reduction algorithm.
GoSetup::GoSetup_BackCameraWidth
k32u GoSetup_BackCameraWidth(GoSetup setup, GoRole role)
Gets the camera region-of-interest width.
GoSetup::GoSetup_PlateRefHoleDiameter
k64f GoSetup_PlateRefHoleDiameter(GoSetup setup)
Gets the diameter of the reference hole defined on the calibration plate.
GoSetup::GoSetup_DynamicExposureMax
k64f GoSetup_DynamicExposureMax(GoSetup setup, GoRole role)
Gets the maximum value for the Dynamic Exposure setting.
GoSpacingIntervalType
Represents spacing interval types.
GoSetup::GoSetup_ExposureStepCount
kSize GoSetup_ExposureStepCount(GoSetup setup, GoRole role)
Get the number of exposure steps defined.
GoSetup::GoSetup_EnableInputTrigger
kStatus GoSetup_EnableInputTrigger(GoSetup setup, kBool enable)
Sets the input trigger enabled state.
GoSetup::GoSetup_ReversalDistanceUsed
kBool GoSetup_ReversalDistanceUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder reversal distance thresh...
GoSetup::GoSetup_DynamicExposureMin
k64f GoSetup_DynamicExposureMin(GoSetup setup, GoRole role)
Gets the minimum value for the Dynamic Exposure setting.
GoAlignmentType
Represents an alignment type.
GoSetup::GoSetup_MaxFrameRateEnabled
kBool GoSetup_MaxFrameRateEnabled(GoSetup setup)
Reports whether or not system is configured to operate at full frame rate.
GoSetup::GoSetup_PatternSequenceType
GoPatternSequenceType GoSetup_PatternSequenceType(GoSetup setup, GoRole role)
Gets the pattern sequence type.
GoSetup::GoSetup_BarDegreesOfFreedomOptionAt
GoAlignmentDegreesOfFreedom GoSetup_BarDegreesOfFreedomOptionAt(GoSetup setup, kSize index)
Gets the bar alignment degrees of freedom option at the given index.
GoSetup::GoSetup_EncoderSpacing
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.
GoSetup::GoSetup_SetExternalInputZPulseIndex
kStatus GoSetup_SetExternalInputZPulseIndex(GoSetup setup, k32u index)
Sets the external input index for triggering encoder Z-pulse.
GoSetup::GoSetup_SetIntensitySource
kStatus GoSetup_SetIntensitySource(GoSetup setup, GoRole role, GoIntensitySource source)
Sets the source to be used for generating intensity data.
GoSetup::GoSetup_ExposureModeOptionCount
kSize GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role)
Gets the exposure mode option count.
GoSetup::GoSetup_ActiveAreaHeight
k64f GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role)
Gets the active area height.
GoSetup::GoSetup_EnableOcclusionReduction
kStatus GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable)
Sets the occlusion reduction enabled state.
GoSetup::GoSetup_TransformedDataRegionY
k64f GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role)
Gets the transformed data region Y value.
GoOcclusionReductionAlg
Represents an occlusion reduction algorithm.
GoSetup::GoSetup_ExposureMode
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoPartMatching
Represents the part matching parameters of the surface mode configuration.
GoSetup::GoSetup_TransformedDataRegionHeight
k64f GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role)
Gets the transformed data region height value.
GoSetup::GoSetup_TriggerBurstEnabledUsed
kBool GoSetup_TriggerBurstEnabledUsed(GoSetup setup)
This API is experimental and may change in a future release Gets the trigger burst enabled state...
kObject
GoMode
Represents a scan mode.
kStatus
GoSetup::GoSetup_LaserWakeupEncoderTravel
k64u GoSetup_LaserWakeupEncoderTravel(GoSetup setup)
This API is experimental and may change in a future release Gets the encoder wakeup travel distance...
GoSetup::GoSetup_FrontCameraExposureLimitMin
k64f GoSetup_FrontCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the front camara exposure setting.
GoSetup::GoSetup_XSubsamplingOptionAt
k32u GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index)
Gets the x-resolution option at the specified index.
GoSetup::GoSetup_SetIntensityStepIndex
kStatus GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index)
Sets the intensity step index.
GoSetup::GoSetup_ActiveAreaZLimitMax
k64f GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaZ setting.
GoSetup::GoSetup_SpacingIntervalLimitMax
k64f GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role)
Gets the spacing interval value limit maximum.
GoSetup::GoSetup_ActiveAreaWidthLimitMin
k64f GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaWidth setting.
GoSetup::GoSetup_AddPolygonCorner
kStatus GoSetup_AddPolygonCorner(GoSetup setup, GoPolygonCornerParameters *corner)
Adds a corner parameters object to the collection of polygon corners for alignment.
GoSetup::GoSetup_ActiveAreaYLimitMax
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_SetDynamicExposureMin
kStatus GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure)
Sets the minimum value for the Dynamic Exposure setting.
GoSetup::GoSetup_SetActiveAreaHeight
kStatus GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value)
Sets the active area height.
GoSetup::GoSetup_ProfileGeneration
GoProfileGeneration GoSetup_ProfileGeneration(GoSetup setup)
Gets the profile generation module, used for profile generation configuration.
GoSetup::GoSetup_SetFrontCameraExposure
kStatus GoSetup_SetFrontCameraExposure(GoSetup setup, GoRole role, k64f exposure)
Sets the front camera exposure value.
k64f
GoSetup::GoSetup_SetEncoderTriggerMode
kStatus GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode)
Sets the encoder trigger mode.
GoSetup::GoSetup_SpacingIntervalUsed
kBool GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role)
Returns the state of whether the user specified spacing interval is used.
GoSetup::GoSetup_OcclusionReductionEnabledSystemValue
kBool GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup)
Gets the occlusion reduction system value.
GoSetup::GoSetup_ExternalInputZPulseIndexAvailable
kBool GoSetup_ExternalInputZPulseIndexAvailable(GoSetup setup)
Reports whether or not the external input index for encoder z-pulse triggering is used...
GoSetup::GoSetup_ScanMode
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the scan mode.
GoSetup::GoSetup_LayoutGridUsed
kBool GoSetup_LayoutGridUsed(GoSetup setup, GoRole role)
Gets layout grid used state.
GoSetup::GoSetup_FlickerFreeModeAvailable
kBool GoSetup_FlickerFreeModeAvailable(GoSetup setup)
Reports whether flicker free mode is available for use on this sensor.
GoSetup::GoSetup_ExposureLimitMax
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
GoSetup::GoSetup_SetBarHoleDiameter
kStatus GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of holes that are defined on the calibration bar.
GoSetup::GoSetup_TrackingAreaHeightLimitMax
k64f GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role)
Gets the tracking window height maximum limit.
GoSetup::GoSetup_FrontCameraHeight
k32u GoSetup_FrontCameraHeight(GoSetup setup, GoRole role)
Gets the camera region-of-interest height.
kBool
GoSetup::GoSetup_XSubsampling
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
GoSetup::GoSetup_EnableIndependentExposures
kStatus GoSetup_EnableIndependentExposures(GoSetup setup, GoRole role, kBool enable)
Enables independent exposures feature, i.e.
GoSetup::GoSetup_SetTriggerUnit
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
GoSetup::GoSetup_PreferMasterTimeEncoderEnabled
kBool GoSetup_PreferMasterTimeEncoderEnabled(GoSetup setup)
Gets the state of the Master time encoder.
GoSetup::GoSetup_BarHoleDiameter
k64f GoSetup_BarHoleDiameter(GoSetup setup)
Gets the diameter of holes that are defined on the calibration bar.
GoSetup
Represents a device configuration.
GoSetup::GoSetup_PolygonCornerAt
GoPolygonCornerParameters * GoSetup_PolygonCornerAt(GoSetup setup, kSize index)
Retrieves the reference to the corner parameters object from the collection of polygon corners...
GoPartMatching.h
Declares the GoPartMatching class.
GoSetup::GoSetup_BackCameraExposureLimitMin
k64f GoSetup_BackCameraExposureLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the back camara exposure setting.
GoSetup::GoSetup_AlignmentTypeOptionAt
GoAlignmentType GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index)
Gets the alignment type option at the given index.
GoSetup::GoSetup_SetIntensityMode
kStatus GoSetup_SetIntensityMode(GoSetup setup, GoRole role, GoIntensityMode mode)
Sets the intensity data generation mode.
GoSetup::GoSetup_BarHoleDistanceUsed
kBool GoSetup_BarHoleDistanceUsed(GoSetup setup)
Indicates if the hole distance can be modified by the user.
GoSetup::GoSetup_TrackingEnabled
kBool GoSetup_TrackingEnabled(GoSetup setup, GoRole role)
Determines if tracking is enabled.
GoSetup::GoSetup_AlignmentEncoderCalibrateEnabled
kBool GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup)
Gets the value of the post alignment encoder calibration setting.
GoSections
Represents the collection of sections and limits for defining them.
GoSetup::GoSetup_SetXSubsampling
kStatus GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling)
Sets the current x-resolution divider.
GoLayout.h
Declares the GoLayout class.
GoSetup::GoSetup_ActiveAreaLength
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
GoSetup::GoSetup_SetPlateSecHoleDiameter
kStatus GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter)
Sets the diameter of the secondary hole defined on the calibration plate.
GoSetup::GoSetup_EncoderSpacingLimitMax
k64f GoSetup_EncoderSpacingLimitMax(GoSetup setup)
Constraint for the maximum valid value of the Encoder Period setting.
GoSetup::GoSetup_BarDegreesOfFreedomOptionCount
kSize GoSetup_BarDegreesOfFreedomOptionCount(GoSetup setup)
Gets the degrees of freedom bar alignment target option count.
GoSetup::GoSetup_PartDetection
GoPartDetection GoSetup_PartDetection(GoSetup setup)
Gets the part detection module, used for part detection configuration.
GoSetup::GoSetup_ActiveAreaX
k64f GoSetup_ActiveAreaX(GoSetup setup, GoRole role)
Gets the active area x origin.