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 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/GoMaterial.h>
16 #include <GoSdk/GoProfileGeneration.h>
17 #include <GoSdk/GoSurfaceGeneration.h>
18 #include <GoSdk/GoPartDetection.h>
19 #include <GoSdk/GoPartMatching.h>
20 #include <GoSdk/GoSections.h>
21
22 kBeginHeader()
23
24 /**
25 * @class GoSetup
26 * @extends kObject
27 * @ingroup GoSdk
28 * @brief Represents a device configuration.
29 */
30 typedef kObject GoSetup;
31
32 /**
33 * Sets the default operation mode of the sensor system.
34 *
35 * @public @memberof GoSetup
36 * @version Introduced in firmware 4.0.10.27
37 * @param setup GoSetup object.
38 * @param mode Operation mode.
39 * @return Operation status.
40 */
41 GoFx(kStatus) GoSetup_SetScanMode(GoSetup setup, GoMode mode);
42
43 /**
44 * Gets the default operation mode of the sensor system.
45 *
46 * @public @memberof GoSetup
47 * @version Introduced in firmware 4.0.10.27
48 * @param setup GoSetup object.
49 * @return Operation mode.
50 */
51 GoFx(GoMode) GoSetup_ScanMode(GoSetup setup);
52
53 /**
54 * Gets the scan mode option at the specified index.
55 *
56 * @public @memberof GoSetup
57 * @version Introduced in firmware 4.0.10.27
58 * @param setup GoSetup object.
59 * @param index The index with which to retrieve a mode option.
60 * @return Operation mode.
61 * @see GoSetup_ScanModeOptionCount
62 */
63 GoFx(GoMode) GoSetup_ScanModeOptionAt(GoSetup setup, kSize index);
64
65 /**
66 * Gets the scan mode option count.
67 *
68 * @public @memberof GoSetup
69 * @version Introduced in firmware 4.0.10.27
70 * @param setup GoSetup object.
71 * @return Scan mode option count.
72 */
73 GoFx(kSize) GoSetup_ScanModeOptionCount(GoSetup setup);
74
75 /// @cond Gocator_2x00
76
77 /**
78 * Gets the user specified Uniform Spacing enabled state.
79 *
80 * @public @memberof GoSetup
81 * @version Introduced in firmware 4.0.10.27
82 * @param setup GoSetup object.
83 * @return kTRUE if enabled and kFALSE otherwise.
84 * @see GoSetup_UniformSpacingAvailable
85 */
86 GoFx(kBool) GoSetup_UniformSpacingEnabled(GoSetup setup);
87
88 /**
89 * Sets the user specified Uniform Spacing enabled state.
90 *
91 * @public @memberof GoSetup
92 * @version Introduced in firmware 4.0.10.27
93 * @param setup GoSetup object.
94 * @param enable kTRUE to enable it and kFALSE to disable it.
95 * @return Operation status.
96 * @see GoSetup_UniformSpacingAvailable
97 */
98 GoFx(kStatus) GoSetup_EnableUniformSpacing(GoSetup setup, kBool enable);
99
100 /**
101 * Gets a boolean representing whether or not the user specified Uniform Spacing setting is being used at the moment.
102 *
103 * @public @memberof GoSetup
104 * @version Introduced in firmware 4.0.10.27
105 * @param setup GoSetup object.
106 * @return kTRUE if the user specified Uniform Spacing setting is used and kFALSE otherwise.
107 */
108 GoFx(kBool) GoSetup_UniformSpacingAvailable(GoSetup setup);
109
110 /**
111 * Gets the Uniform Spacing enabled system value.
112 *
113 * @public @memberof GoSetup
114 * @version Introduced in firmware 4.0.10.27
115 * @param setup GoSetup object.
116 * @return kTRUE if enabled and kFALSE otherwise.
117 * @see GoSetup_UniformSpacingAvailable
118 */
119 GoFx(kBool) GoSetup_UniformSpacingEnabledSystemValue(GoSetup setup);
120
121 /// @endcond
122
123 /**
124 * Sets the state of the external input triggered encoder Z-pulse feature.
125 *
126 * @public @memberof GoSetup
127 * @version Introduced in firmware 4.1.3.106
128 * @param setup GoSetup object.
129 * @param enable kTRUE to enable it and kFALSE to disable it.
130 * @return Operation status.
131 */
132 GoFx(kStatus) GoSetup_EnableExternalInputZPulse(GoSetup setup, kBool enable);
133
134 /**
135 * Gets the state of the external input triggered encoder Z-pulse feature.
136 *
137 * @public @memberof GoSetup
138 * @version Introduced in firmware 4.1.3.106
139 * @param setup GoSetup object.
140 * @return kTRUE if enabled and kFALSE otherwise.
141 */
142 GoFx(kBool) GoSetup_ExternalInputZPulseEnabled(GoSetup setup);
143
144 /**
145 * Gets the occlusion reduction enabled state.
146 *
147 * @public @memberof GoSetup
148 * @version Introduced in firmware 4.0.10.27
149 * @param setup GoSetup object.
150 * @return kTRUE if enabled and kFALSE otherwise.
151 */
152 GoFx(kBool) GoSetup_OcclusionReductionEnabled(GoSetup setup);
153
154 /**
155 * Sets the occlusion reduction enabled state.
156 *
157 * @public @memberof GoSetup
158 * @version Introduced in firmware 4.0.10.27
159 * @param setup GoSetup object.
160 * @param enable kTRUE to enable it and kFALSE to disable it.
161 * @return Operation status.
162 */
163 GoFx(kStatus) GoSetup_EnableOcclusionReduction(GoSetup setup, kBool enable);
164
165 /**
166 * Returns a boolean representing whether the user occlusion reduction configuration is used.
167 *
168 * @public @memberof GoSetup
169 * @version Introduced in firmware 4.3.3.124
170 * @param setup GoSetup object.
171 * @return kTRUE if used, or kFALSE if not used.
172 */
173 GoFx(kBool) GoSetup_OcclusionReductionEnabledUsed(GoSetup setup);
174
175 /**
176 * Gets the occlusion reduction system value.
177 *
178 * @public @memberof GoSetup
179 * @version Introduced in firmware 4.3.3.124
180 * @param setup GoSetup object.
181 * @return kTRUE if enabled, or kFALSE if not.
182 */
183 GoFx(kBool) GoSetup_OcclusionReductionEnabledSystemValue(GoSetup setup);
184
185
186 //class - trigger
187
188 /**
189 * Sets the system trigger units.
190 * Ignored if GoSetup_TriggerSource is time or encoder
191 *
192 * @public @memberof GoSetup
193 * @version Introduced in firmware 4.0.10.27
194 * @param setup GoSetup object.
195 * @param unit The system trigger unit.
196 * @return Operation status.
197 */
198 GoFx(kStatus) GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit);
199
200 /**
201 * Gets the system trigger units.
202 * Ignored if GoSetup_TriggerSource is time or encoder
203 *
204 * @public @memberof GoSetup
205 * @version Introduced in firmware 4.0.10.27
206 * @param setup GoSetup object.
207 * @return The system domain.
208 */
209 GoFx(GoTriggerUnits) GoSetup_TriggerUnit(GoSetup setup);
210
211 /**
212 * Sets the trigger source for profile triggering.
213 *
214 * @public @memberof GoSetup
215 * @version Introduced in firmware 4.0.10.27
216 * @param setup GoSetup object.
217 * @param source Profile trigger source.
218 * @return Operation status.
219 */
220 GoFx(kStatus) GoSetup_SetTriggerSource(GoSetup setup, GoTrigger source);
221
222 /**
223 * Gets the trigger source for profile triggering.
224 *
225 * @public @memberof GoSetup
226 * @version Introduced in firmware 4.0.10.27
227 * @param setup GoSetup object.
228 * @return Profile trigger source.
229 */
230 GoFx(GoTrigger) GoSetup_TriggerSource(GoSetup setup);
231
232 /**
233 * Sets the trigger delay. Depending on GoDomain, units are uS or mm.
234 *
235 * @public @memberof GoSetup
236 * @version Introduced in firmware 4.0.10.27
237 * @param setup GoSetup object.
238 * @param delay Trigger delay (uS or mm).
239 * @return Operation status.
240 */
241 GoFx(kStatus) GoSetup_SetTriggerDelay(GoSetup setup, k64f delay);
242
243 /**
244 * Gets the trigger delay. Depending on GoDomain, units are uS or mm.
245 *
246 * @public @memberof GoSetup
247 * @version Introduced in firmware 4.0.10.27
248 * @param setup GoSetup object.
249 * @return Trigger delay (uS or mm).
250 */
251 GoFx(k64f) GoSetup_TriggerDelay(GoSetup setup);
252
253 /**
254 * Reports the minimum trigger delay, based on current settings.
255 * Depending on GoDomain, units are uS or mm.
256 *
257 * @public @memberof GoSetup
258 * @version Introduced in firmware 4.0.10.27
259 * @param setup GoSetup object.
260 * @return Minimum trigger delay (uS or mm).
261 */
262 GoFx(k64f) GoSetup_TriggerDelayLimitMin(GoSetup setup);
263
264 /**
265 * Reports the maximum trigger delay, based on current settings.
266 * Depending on GoDomain, units are uS or mm.
267 *
268 * @public @memberof GoSetup
269 * @version Introduced in firmware 4.0.10.27
270 * @param setup GoSetup object.
271 * @return Maximum trigger delay (uS or mm).
272 */
273 GoFx(k64f) GoSetup_TriggerDelayLimitMax(GoSetup setup);
274
275 /**
276 * Sets the trigger gate feature.
277 *
278 * @public @memberof GoSetup
279 * @version Introduced in firmware 4.0.10.27
280 * @param setup GoSetup object.
281 * @param enable Enables trigger gate operation.
282 * @return Operation status.
283 */
284 GoFx(kStatus) GoSetup_EnableTriggerGate(GoSetup setup, kBool enable);
285
286 /**
287 * Reports whether the trigger gate feature is currently enabled.
288 *
289 * @public @memberof GoSetup
290 * @version Introduced in firmware 4.0.10.27
291 * @param setup GoSetup object.
292 * @return kTRUE if enabled, or kFALSE if disabled.
293 */
294 GoFx(kBool) GoSetup_TriggerGateEnabled(GoSetup setup);
295
296 /**
297 * Gets the system value representing whether or not the user specified trigger gate enabled setting is being used at the moment.
298 *
299 * @public @memberof GoSetup
300 * @version Introduced in firmware 4.0.10.27
301 * @param setup GoSetup object.
302 * @return kTRUE if the user specified setting is used and kFALSE otherwise.
303 */
304 GoFx(kBool) GoSetup_TriggerGateEnabledUsed(GoSetup setup);
305
306 /**
307 * Reports the trigger gate enabled system value.
308 *
309 * @public @memberof GoSetup
310 * @version Introduced in firmware 4.0.10.27
311 * @param setup GoSetup object.
312 * @return kTRUE if enabled, or kFALSE if disabled.
313 */
314 GoFx(kBool) GoSetup_TriggerGateEnabledSystemValue(GoSetup setup);
315
316 /**
317 * Enables or disables operation at full frame rate (ignoring frame rate setting).
318 *
319 * @public @memberof GoSetup
320 * @version Introduced in firmware 4.0.10.27
321 * @param setup GoSetup object.
322 * @param enable Enables full frame rate operation.
323 * @return Operation status.
324 */
325 GoFx(kStatus) GoSetup_EnableMaxFrameRate(GoSetup setup, kBool enable);
326
327 /**
328 * Reports whether or not system is configured to operate at full frame rate.
329 *
330 * @public @memberof GoSetup
331 * @version Introduced in firmware 4.0.10.27
332 * @param setup GoSetup object.
333 * @return True if system operates at full frame rate; false otherwise.
334 */
335 GoFx(kBool) GoSetup_MaxFrameRateEnabled(GoSetup setup);
336
337 /**
338 * Sets the current frame rate for time-based triggering. The maximum frame
339 * rate option must be disabled to use the value set in this function.
340 *
341 * @public @memberof GoSetup
342 * @version Introduced in firmware 4.0.10.27
343 * @param setup GoSetup object.
344 * @param frameRate Frame Rate value (Hz).
345 * @return Operation status.
346 * @see GoSetup_EnableMaxFrameRate, GoSetup_MaxFrameRateEnabled
347 */
348 GoFx(kStatus) GoSetup_SetFrameRate(GoSetup setup, k64f frameRate);
349
350 /**
351 * Reports the currently configured frame rate.
352 *
353 * @public @memberof GoSetup
354 * @version Introduced in firmware 4.0.10.27
355 * @param setup GoSetup object.
356 * @return Maximum frame rate (Hz).
357 */
358 GoFx(k64f) GoSetup_FrameRate(GoSetup setup);
359
360 /**
361 * Constraint for the minimum valid value of the Frame Rate setting.
362 *
363 * @public @memberof GoSetup
364 * @version Introduced in firmware 4.0.10.27
365 * @param setup GoSetup object.
366 * @return Minimum valid Frame Rate setting (Hz).
367 */
368 GoFx(k64f) GoSetup_FrameRateLimitMin(GoSetup setup);
369
370 /**
371 * Constraint for the maximum valid value of the Frame Rate setting.
372 *
373 * @public @memberof GoSetup
374 * @version Introduced in firmware 4.0.10.27
375 * @param setup GoSetup object.
376 * @return Maximum valid Frame Rate setting (Hz).
377 */
378 GoFx(k64f) GoSetup_FrameRateLimitMax(GoSetup setup);
379
380 /**
381 * Sets the encoder trigger mode.
382 *
383 * @public @memberof GoSetup
384 * @version Introduced in firmware 4.0.10.27
385 * @param setup GoSetup object.
386 * @param mode Encoder trigger mode.
387 * @return Profile trigger source.
388 */
389 GoFx(kStatus) GoSetup_SetEncoderTriggerMode(GoSetup setup, GoEncoderTriggerMode mode);
390
391 /**
392 * Gets the encoder trigger mode.
393 *
394 * @public @memberof GoSetup
395 * @version Introduced in firmware 4.0.10.27
396 * @param setup GoSetup object.
397 * @return Encoder trigger mode.
398 */
399 GoFx(GoEncoderTriggerMode) GoSetup_EncoderTriggerMode(GoSetup setup);
400
401 /**
402 * Sets the current encoder period for encoder-based triggering.
403 *
404 * @public @memberof GoSetup
405 * @version Introduced in firmware 4.0.10.27
406 * @param setup GoSetup object.
407 * @param period Encoder period (mm).
408 * @return Operation status.
409 */
410 GoFx(kStatus) GoSetup_SetEncoderSpacing(GoSetup setup, k64f period);
411
412 /**
413 * Gets the current encoder period for encoder-based triggering.
414 *
415 * @public @memberof GoSetup
416 * @version Introduced in firmware 4.0.10.27
417 * @param setup GoSetup object.
418 * @return Encoder period (mm).
419 */
420 GoFx(k64f) GoSetup_EncoderSpacing(GoSetup setup);
421
422 /**
423 * Constraint for the minimum valid value of the Encoder Period setting.
424 *
425 * @public @memberof GoSetup
426 * @version Introduced in firmware 4.0.10.27
427 * @param setup GoSetup object.
428 * @return Minimum valid Encoder Period setting (mm).
429 */
430 GoFx(k64f) GoSetup_EncoderSpacingLimitMin(GoSetup setup);
431
432 /**
433 * Constraint for the maximum valid value of the Encoder Period setting.
434 *
435 * @public @memberof GoSetup
436 * @version Introduced in firmware 4.0.10.27
437 * @param setup GoSetup object.
438 * @return Maximum valid Encoder Period setting (mm).
439 */
440 GoFx(k64f) GoSetup_EncoderSpacingLimitMax(GoSetup setup);
441
442 /**
443 * Enables profile intensity collection.
444 *
445 * @public @memberof GoSetup
446 * @version Introduced in firmware 4.0.10.27
447 * @param setup GoSetup object.
448 * @param enable kTRUE to enable, or kFALSE to disable.
449 * @return Operation status.
450 */
451 GoFx(kStatus) GoSetup_EnableIntensity(GoSetup setup, kBool enable);
452
453 /**
454 * Reports whether the profile intensity collection is enabled.
455 *
456 * @public @memberof GoSetup
457 * @version Introduced in firmware 4.0.10.27
458 * @param setup GoSetup object.
459 * @return kTRUE if enabled, or kFALSE if disabled.
460 */
461 GoFx(kBool) GoSetup_IntensityEnabled(GoSetup setup);
462
463 //class - alignment
464
465 /**
466 * Gets the input trigger enabled state.
467 *
468 * @public @memberof GoSetup
469 * @version Introduced in firmware 4.0.10.27
470 * @param setup GoSetup object.
471 * @return kTRUE if enabled and kFALSE otherwise.
472 */
473 GoFx(kBool) GoSetup_InputTriggerEnabled(GoSetup setup);
474
475 /**
476 * Returns a boolean representing whether the user input trigger configuration is used.
477 *
478 * @public @memberof GoSetup
479 * @version Introduced in firmware 4.3.3.124
480 * @param setup GoSetup object.
481 * @return kTRUE if used, or kFALSE if not used.
482 */
483 GoFx(kBool) GoSetup_InputTriggerEnabledUsed(GoSetup setup);
484
485 /**
486 * Gets the input trigger system value.
487 *
488 * @public @memberof GoSetup
489 * @version Introduced in firmware 4.3.3.124
490 * @param setup GoSetup object.
491 * @return kTRUE if enabled, or kFALSE if not.
492 */
493 GoFx(kBool) GoSetup_InputTriggerEnabledSystemValue(GoSetup setup);
494
495 /**
496 * Sets the input trigger enabled state.
497 *
498 * @public @memberof GoSetup
499 * @version Introduced in firmware 4.0.10.27
500 * @param setup GoSetup object.
501 * @param enable kTRUE to enable it and kFALSE to disable it.
502 */
503 GoFx(kStatus) GoSetup_EnableInputTrigger(GoSetup setup, kBool enable);
504
505 /**
506 * Sets the type used for alignment.
507 *
508 * @public @memberof GoSetup
509 * @version Introduced in firmware 4.0.10.27
510 * @param setup GoSetup object.
511 * @param type Alignment type (stationary or moving).
512 * @return Operation status.
513 */
514 GoFx(kStatus) GoSetup_SetAlignmentType(GoSetup setup, GoAlignmentType type);
515
516 /**
517 * Gets the type used for alignment calibration.
518 *
519 * @public @memberof GoSetup
520 * @version Introduced in firmware 4.0.10.27
521 * @param setup GoSetup object.
522 * @return Alignment type (stationary or moving).
523 */
524 GoFx(GoAlignmentType) GoSetup_AlignmentType(GoSetup setup);
525
526 /**
527 * Gets the alignment type option at the given index.
528 *
529 * @public @memberof GoSetup
530 * @version Introduced in firmware 4.0.10.27
531 * @param setup GoSetup object.
532 * @param index The index with which to retrieve an alignment type option.
533 * @return Alignment type option.
534 * @see GoSetup_AlignmentTypeOptionCount
535 */
536 GoFx(GoAlignmentType) GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index);
537
538 /**
539 * Gets the alignment type option count.
540 *
541 * @public @memberof GoSetup
542 * @version Introduced in firmware 4.0.10.27
543 * @param setup GoSetup object.
544 * @return Alignment type option count.
545 */
546 GoFx(kSize) GoSetup_AlignmentTypeOptionCount(GoSetup setup);
547
548 /**
549 * Enables encoder calibration after alignment.
550 *
551 * @public @memberof GoSetup
552 * @version Introduced in firmware 4.0.10.27
553 * @param setup GoSetup object.
554 * @param enabled kTRUE to enable encoder calibration after alignment, kFALSE to disable it.
555 * @return Operation status.
556 */
557 GoFx(kStatus) GoSetup_EnableAlignmentEncoderCalibrate(GoSetup setup, kBool enabled);
558
559 /**
560 * Gets the value of the post alignment encoder calibration setting.
561 *
562 * @public @memberof GoSetup
563 * @version Introduced in firmware 4.0.10.27
564 * @param setup GoSetup object.
565 * @return kTRUE if post alignment encoder calibration is enabled. kFALSE otherwise.
566 */
567 GoFx(kBool) GoSetup_AlignmentEncoderCalibrateEnabled(GoSetup setup);
568
569 /**
570 * Sets the target type used for stationary alignment calibration.
571 *
572 * @public @memberof GoSetup
573 * @version Introduced in firmware 4.0.10.27
574 * @param setup GoSetup object.
575 * @param target Alignment target type.
576 * @return Operation status.
577 */
578 GoFx(kStatus) GoSetup_SetAlignmentStationaryTarget(GoSetup setup, GoAlignmentTarget target);
579
580 /**
581 * Gets the target type used for stationary alignment calibration.
582 *
583 * @public @memberof GoSetup
584 * @version Introduced in firmware 4.0.10.27
585 * @param setup GoSetup object.
586 * @return Alignment target type.
587 */
588 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTarget(GoSetup setup);
589
590 /**
591 * Gets the stationary alignment target option count.
592 *
593 * @public @memberof GoSetup
594 * @version Introduced in firmware 4.0.10.27
595 * @param setup GoSetup object.
596 * @return The alignment target count.
597 */
598 GoFx(kSize) GoSetup_AlignmentStationaryTargetOptionCount(GoSetup setup);
599
600 /**
601 * Gets the stationary alignment target option at the given index.
602 *
603 * @public @memberof GoSetup
604 * @version Introduced in firmware 4.0.10.27
605 * @param setup GoSetup object.
606 * @param index The index with which to retrieve an alignment target.
607 * @return The alignment target option.
608 * @see GoSetup_AlignmentStationaryTargetOptionCount
609 */
610 GoFx(GoAlignmentTarget) GoSetup_AlignmentStationaryTargetOptionAt(GoSetup setup, kSize index);
611
612 /// @cond (Gocator_1x00 || Gocator_2x00)
613
614 /**
615 * Sets the target type used for moving alignment calibration.
616 *
617 * @public @memberof GoSetup
618 * @version Introduced in firmware 4.0.10.27
619 * @param setup GoSetup object.
620 * @param target Alignment target type.
621 * @return Operation status.
622 */
623 GoFx(kStatus) GoSetup_SetAlignmentMovingTarget(GoSetup setup, GoAlignmentTarget target);
624
625 /**
626 * Gets the target type used for moving alignment calibration.
627 *
628 * @public @memberof GoSetup
629 * @version Introduced in firmware 4.0.10.27
630 * @param setup GoSetup object.
631 * @return Alignment target type.
632 */
633 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTarget(GoSetup setup);
634
635 /**
636 * Gets the moving alignment target option count.
637 *
638 * @public @memberof GoSetup
639 * @version Introduced in firmware 4.0.10.27
640 * @param setup GoSetup object.
641 * @return The alignment target count.
642 */
643 GoFx(kSize) GoSetup_AlignmentMovingTargetOptionCount(GoSetup setup);
644
645 /**
646 * Gets the moving alignment target option at the given index.
647 *
648 * @public @memberof GoSetup
649 * @version Introduced in firmware 4.0.10.27
650 * @param setup GoSetup object.
651 * @param index The index with which to retrieve an alignment target.
652 * @return The alignment target option.
653 * @see GoSetup_AlignmentMovingTargetOptionCount
654 */
655 GoFx(GoAlignmentTarget) GoSetup_AlignmentMovingTargetOptionAt(GoSetup setup, kSize index);
656
657 /**
658 * Sets the diameter of the disk used for travel calibration.
659 *
660 * @public @memberof GoSetup
661 * @version Introduced in firmware 4.0.10.27
662 * @param setup GoSetup object.
663 * @param diameter Disk diameter (mm).
664 * @return Operation status.
665 */
666 GoFx(kStatus) GoSetup_SetDiskDiameter(GoSetup setup, k64f diameter);
667
668 /**
669 * Gets the diameter of the disk used for travel calibration.
670 *
671 * @public @memberof GoSetup
672 * @version Introduced in firmware 4.0.10.27
673 * @param setup GoSetup object.
674 * @return Disk diameter (mm).
675 */
676 GoFx(k64f) GoSetup_DiskDiameter(GoSetup setup);
677
678 /**
679 * Sets the height of the disk used for travel calibration.
680 *
681 * @public @memberof GoSetup
682 * @version Introduced in firmware 4.0.10.27
683 * @param setup GoSetup object.
684 * @param height Disk height (mm).
685 * @return Operation status.
686 */
687 GoFx(kStatus) GoSetup_SetDiskHeight(GoSetup setup, k64f height);
688
689 /**
690 * Gets the height of the disk used for travel calibration.
691 *
692 * @public @memberof GoSetup
693 * @version Introduced in firmware 4.0.10.27
694 * @param setup GoSetup object.
695 * @return Disk height (mm).
696 */
697 GoFx(k64f) GoSetup_DiskHeight(GoSetup setup);
698
699 /// @endcond
700
701
702 /**
703 * Sets the width of the bar used for travel calibration.
704 *
705 * @public @memberof GoSetup
706 * @version Introduced in firmware 4.0.10.27
707 * @param setup GoSetup object.
708 * @param width Bar width (mm).
709 * @return Operation status.
710 */
711 GoFx(kStatus) GoSetup_SetBarWidth(GoSetup setup, k64f width);
712
713 /**
714 * Gets the width of the bar used for travel calibration.
715 *
716 * @public @memberof GoSetup
717 * @version Introduced in firmware 4.0.10.27
718 * @param setup GoSetup object.
719 * @return Bar width (mm).
720 */
721 GoFx(k64f) GoSetup_BarWidth(GoSetup setup);
722
723 /**
724 * Sets the height of the bar used for travel calibration.
725 *
726 * @public @memberof GoSetup
727 * @version Introduced in firmware 4.0.10.27
728 * @param setup GoSetup object.
729 * @param height Bar height (mm).
730 * @return Operation status.
731 */
732 GoFx(kStatus) GoSetup_SetBarHeight(GoSetup setup, k64f height);
733
734 /**
735 * Gets the height of the bar used for travel calibration.
736 *
737 * @public @memberof GoSetup
738 * @version Introduced in firmware 4.0.10.27
739 * @param setup GoSetup object.
740 * @return Bar height (mm).
741 */
742 GoFx(k64f) GoSetup_BarHeight(GoSetup setup);
743
744 /**
745 * Sets the number of holes that are defined on the calibration bar.
746 *
747 * @public @memberof GoSetup
748 * @version Introduced in firmware 4.0.10.27
749 * @param setup GoSetup object.
750 * @param count Hole count.
751 * @return Operation status.
752 */
753 GoFx(kStatus) GoSetup_SetBarHoleCount(GoSetup setup, kSize count);
754
755 /**
756 * Gets the number of holes that are defined on the calibration bar.
757 *
758 * @public @memberof GoSetup
759 * @version Introduced in firmware 4.0.10.27
760 * @param setup GoSetup object.
761 * @return Hole count.
762 */
763 GoFx(kSize) GoSetup_BarHoleCount(GoSetup setup);
764
765 /**
766 * Sets the distance between holes that are defined on the calibration bar.
767 *
768 * @public @memberof GoSetup
769 * @version Introduced in firmware 4.0.10.27
770 * @param setup GoSetup object.
771 * @param distance Hole distance (mm).
772 * @return Operation status.
773 */
774 GoFx(kStatus) GoSetup_SetBarHoleDistance(GoSetup setup, k64f distance);
775
776 /**
777 * Gets the distance between holes that are defined on the calibration bar.
778 *
779 * @public @memberof GoSetup
780 * @version Introduced in firmware 4.0.10.27
781 * @param setup GoSetup object.
782 * @return Hole distance (mm).
783 */
784 GoFx(k64f) GoSetup_BarHoleDistance(GoSetup setup);
785
786 /**
787 * Sets the diameter of holes that are defined on the calibration bar.
788 *
789 * @public @memberof GoSetup
790 * @version Introduced in firmware 4.0.10.27
791 * @param setup GoSetup object.
792 * @param diameter Hole diameter (mm).
793 * @return Operation status.
794 */
795 GoFx(kStatus) GoSetup_SetBarHoleDiameter(GoSetup setup, k64f diameter);
796
797 /**
798 * Gets the diameter of holes that are defined on the calibration bar.
799 *
800 * @public @memberof GoSetup
801 * @version Introduced in firmware 4.0.10.27
802 * @param setup GoSetup object.
803 * @return Hole diameter (mm).
804 */
805 GoFx(k64f) GoSetup_BarHoleDiameter(GoSetup setup);
806
807 /**
808 * Sets the height of the plate used for travel calibration.
809 *
810 * @public @memberof GoSetup
811 * @version Introduced in firmware 4.0.10.27
812 * @param setup GoSetup object.
813 * @param height Plate height (mm).
814 * @return Operation status.
815 */
816 GoFx(kStatus) GoSetup_SetPlateHeight(GoSetup setup, k64f height);
817
818 /**
819 * Gets the height of the plate used for travel calibration.
820 *
821 * @public @memberof GoSetup
822 * @version Introduced in firmware 4.0.10.27
823 * @param setup GoSetup object.
824 * @return Plate height (mm).
825 */
826 GoFx(k64f) GoSetup_PlateHeight(GoSetup setup);
827
828 /**
829 * Sets the number of holes that are defined on the calibration plate.
830 *
831 * @public @memberof GoSetup
832 * @version Introduced in firmware 4.0.10.27
833 * @param setup GoSetup object.
834 * @param count Hole count.
835 * @return Operation status.
836 */
837 GoFx(kStatus) GoSetup_SetPlateHoleCount(GoSetup setup, kSize count);
838
839 /**
840 * Gets the number of holes that are defined on the calibration plate.
841 *
842 * @public @memberof GoSetup
843 * @version Introduced in firmware 4.0.10.27
844 * @param setup GoSetup object.
845 * @return Hole count.
846 */
847 GoFx(kSize) GoSetup_PlateHoleCount(GoSetup setup);
848
849 /**
850 * Sets the diameter of the reference hole defined on the calibration plate.
851 *
852 * @public @memberof GoSetup
853 * @version Introduced in firmware 4.0.10.27
854 * @param setup GoSetup object.
855 * @param diameter Hole diameter (mm).
856 * @return Operation status.
857 */
858 GoFx(kStatus) GoSetup_SetPlateRefHoleDiameter(GoSetup setup, k64f diameter);
859
860 /**
861 * Gets the diameter of the reference hole defined on the calibration plate.
862 *
863 * @public @memberof GoSetup
864 * @version Introduced in firmware 4.0.10.27
865 * @param setup GoSetup object.
866 * @return Hole diameter (mm).
867 */
868 GoFx(k64f) GoSetup_PlateRefHoleDiameter(GoSetup setup);
869
870
871 /**
872 * Sets the diameter of the secondary hole defined on the calibration plate.
873 *
874 * @public @memberof GoSetup
875 * @version Introduced in firmware 4.0.10.27
876 * @param setup GoSetup object.
877 * @param diameter Hole diameter (mm).
878 * @return Operation status.
879 */
880 GoFx(kStatus) GoSetup_SetPlateSecHoleDiameter(GoSetup setup, k64f diameter);
881
882 /**
883 * Gets the diameter of the secondary hole defined on the calibration plate.
884 *
885 * @public @memberof GoSetup
886 * @version Introduced in firmware 4.0.10.27
887 * @param setup GoSetup object.
888 * @return Hole diameter (mm).
889 */
890 GoFx(k64f) GoSetup_PlateSecHoleDiameter(GoSetup setup);
891
892
893 //class - filters
894
895 /**
896 * Sets the status of x-direction smoothing.
897 *
898 * @public @memberof GoSetup
899 * @version Introduced in firmware 4.0.10.27
900 * @param setup GoSetup object.
901 * @param enabled Enable or disable x-smoothing
902 * @return Operation status.
903 */
904 GoFx(kStatus) GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled);
905
906 /**
907 * Gets the status of x-direction smoothing.
908 *
909 * @public @memberof GoSetup
910 * @version Introduced in firmware 4.0.10.27
911 * @param setup GoSetup object.
912 * @return True if x-smoothing is enabled.
913 */
914 GoFx(kBool) GoSetup_XSmoothingEnabled(GoSetup setup);
915
916 /**
917 * Sets the x-direction smoothing window.
918 *
919 * @public @memberof GoSetup
920 * @version Introduced in firmware 4.0.10.27
921 * @param setup GoSetup object.
922 * @param window The x-smoothing window (mm).
923 * @return Operation status.
924 */
925 GoFx(kStatus) GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window);
926
927 /**
928 * Gets the x-direction smoothing window.
929 *
930 * @public @memberof GoSetup
931 * @version Introduced in firmware 4.0.10.27
932 * @param setup GoSetup object.
933 * @return The x-smoothing window (mm).
934 */
935 GoFx(k64f) GoSetup_XSmoothingWindow(GoSetup setup);
936
937 /**
938 * Gets the x-direction smoothing window minimum.
939 *
940 * @public @memberof GoSetup
941 * @version Introduced in firmware 4.0.10.27
942 * @param setup GoSetup object.
943 * @return The x-smoothing window min (mm).
944 */
945 GoFx(k64f) GoSetup_XSmoothingWindowLimitMin(GoSetup setup);
946
947 /**
948 * Gets the x-direction smoothing window maximum.
949 *
950 * @public @memberof GoSetup
951 * @version Introduced in firmware 4.0.10.27
952 * @param setup GoSetup object.
953 * @return The x-smoothing window max (mm).
954 */
955 GoFx(k64f) GoSetup_XSmoothingWindowLimitMax(GoSetup setup);
956
957 /**
958 * Sets the status of y-direction smoothing.
959 *
960 * @public @memberof GoSetup
961 * @version Introduced in firmware 4.0.10.27
962 * @param setup GoSetup object.
963 * @param enable Enable or disable y-smoothing
964 * @return Operation status.
965 */
966 GoFx(kStatus) GoSetup_EnableYSmoothing(GoSetup setup, kBool enable);
967
968 /**
969 * Gets the status of y-direction smoothing.
970 *
971 * @public @memberof GoSetup
972 * @version Introduced in firmware 4.0.10.27
973 * @param setup GoSetup object.
974 * @return True if y-smoothing is enabled.
975 */
976 GoFx(kBool) GoSetup_YSmoothingEnabled(GoSetup setup);
977
978 /**
979 * Sets the y-direction smoothing window.
980 *
981 * @public @memberof GoSetup
982 * @version Introduced in firmware 4.0.10.27
983 * @param setup GoSetup object.
984 * @param window The y-smoothing window (mm).
985 * @return Operation status.
986 */
987 GoFx(kStatus) GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window);
988
989 /**
990 * Gets the y-direction smoothing window.
991 *
992 * @public @memberof GoSetup
993 * @version Introduced in firmware 4.0.10.27
994 * @param setup GoSetup object.
995 * @return The y-smoothing window (mm).
996 */
997 GoFx(k64f) GoSetup_YSmoothingWindow(GoSetup setup);
998
999 /**
1000 * Gets the y-direction smoothing window minimum.
1001 *
1002 * @public @memberof GoSetup
1003 * @version Introduced in firmware 4.0.10.27
1004 * @param setup GoSetup object.
1005 * @return The y-smoothing window min (mm).
1006 */
1007 GoFx(k64f) GoSetup_YSmoothingWindowLimitMin(GoSetup setup);
1008
1009 /**
1010 * Gets the y-direction smoothing window maximum.
1011 *
1012 * @public @memberof GoSetup
1013 * @version Introduced in firmware 4.0.10.27
1014 * @param setup GoSetup object.
1015 * @return The y-smoothing window max (mm).
1016 */
1017 GoFx(k64f) GoSetup_YSmoothingWindowLimitMax(GoSetup setup);
1018
1019
1020 /**
1021 * Sets the status of x-direction median.
1022 *
1023 * @public @memberof GoSetup
1024 * @version Introduced in firmware 4.1.3.106
1025 * @param setup GoSetup object.
1026 * @param enabled Enable or disable x-median
1027 * @return Operation status.
1028 */
1029 GoFx(kStatus) GoSetup_EnableXMedian(GoSetup setup, kBool enabled);
1030
1031 /**
1032 * Gets the status of x-direction median.
1033 *
1034 * @public @memberof GoSetup
1035 * @version Introduced in firmware 4.1.3.106
1036 * @param setup GoSetup object.
1037 * @return True if x-median is enabled.
1038 */
1039 GoFx(kBool) GoSetup_XMedianEnabled(GoSetup setup);
1040
1041 /**
1042 * Sets the x-direction median window.
1043 *
1044 * @public @memberof GoSetup
1045 * @version Introduced in firmware 4.1.3.106
1046 * @param setup GoSetup object.
1047 * @param window The x-median window (mm).
1048 * @return Operation status.
1049 */
1050 GoFx(kStatus) GoSetup_SetXMedianWindow(GoSetup setup, k64f window);
1051
1052 /**
1053 * Gets the x-direction median window.
1054 *
1055 * @public @memberof GoSetup
1056 * @version Introduced in firmware 4.1.3.106
1057 * @param setup GoSetup object.
1058 * @return The x-median window (mm).
1059 */
1060 GoFx(k64f) GoSetup_XMedianWindow(GoSetup setup);
1061
1062 /**
1063 * Gets the x-direction median window minimum.
1064 *
1065 * @public @memberof GoSetup
1066 * @version Introduced in firmware 4.1.3.106
1067 * @param setup GoSetup object.
1068 * @return The x-median window min (mm).
1069 */
1070 GoFx(k64f) GoSetup_XMedianWindowLimitMin(GoSetup setup);
1071
1072 /**
1073 * Gets the x-direction median window maximum.
1074 *
1075 * @public @memberof GoSetup
1076 * @version Introduced in firmware 4.1.3.106
1077 * @param setup GoSetup object.
1078 * @return The x-median window max (mm).
1079 */
1080 GoFx(k64f) GoSetup_XMedianWindowLimitMax(GoSetup setup);
1081
1082 /**
1083 * Sets the status of y-direction median.
1084 *
1085 * @public @memberof GoSetup
1086 * @version Introduced in firmware 4.1.3.106
1087 * @param setup GoSetup object.
1088 * @param enable Enable or disable y-median
1089 * @return Operation status.
1090 */
1091 GoFx(kStatus) GoSetup_EnableYMedian(GoSetup setup, kBool enable);
1092
1093 /**
1094 * Gets the status of y-direction median.
1095 *
1096 * @public @memberof GoSetup
1097 * @version Introduced in firmware 4.1.3.106
1098 * @param setup GoSetup object.
1099 * @return True if y-median is enabled.
1100 */
1101 GoFx(kBool) GoSetup_YMedianEnabled(GoSetup setup);
1102
1103 /**
1104 * Sets the y-direction median window.
1105 *
1106 * @public @memberof GoSetup
1107 * @version Introduced in firmware 4.1.3.106
1108 * @param setup GoSetup object.
1109 * @param window The y-median window (mm).
1110 * @return Operation status.
1111 */
1112 GoFx(kStatus) GoSetup_SetYMedianWindow(GoSetup setup, k64f window);
1113
1114 /**
1115 * Gets the y-direction median window.
1116 *
1117 * @public @memberof GoSetup
1118 * @version Introduced in firmware 4.1.3.106
1119 * @param setup GoSetup object.
1120 * @return The y-median window (mm).
1121 */
1122 GoFx(k64f) GoSetup_YMedianWindow(GoSetup setup);
1123
1124 /**
1125 * Gets the y-direction median window minimum.
1126 *
1127 * @public @memberof GoSetup
1128 * @version Introduced in firmware 4.1.3.106
1129 * @param setup GoSetup object.
1130 * @return The y-median window min (mm).
1131 */
1132 GoFx(k64f) GoSetup_YMedianWindowLimitMin(GoSetup setup);
1133
1134 /**
1135 * Gets the y-direction median window maximum.
1136 *
1137 * @public @memberof GoSetup
1138 * @version Introduced in firmware 4.1.3.106
1139 * @param setup GoSetup object.
1140 * @return The y-median window max (mm).
1141 */
1142 GoFx(k64f) GoSetup_YMedianWindowLimitMax(GoSetup setup);
1143
1144 /**
1145 * Sets the status of x-direction decimation.
1146 *
1147 * @public @memberof GoSetup
1148 * @version Introduced in firmware 4.1.3.106
1149 * @param setup GoSetup object.
1150 * @param enabled Enable or disable x-decimation
1151 * @return Operation status.
1152 */
1153 GoFx(kStatus) GoSetup_EnableXDecimation(GoSetup setup, kBool enabled);
1154
1155 /**
1156 * Gets the status of x-direction decimation.
1157 *
1158 * @public @memberof GoSetup
1159 * @version Introduced in firmware 4.1.3.106
1160 * @param setup GoSetup object.
1161 * @return True if x-decimation is enabled.
1162 */
1163 GoFx(kBool) GoSetup_XDecimationEnabled(GoSetup setup);
1164
1165 /**
1166 * Sets the x-direction decimation window.
1167 *
1168 * @public @memberof GoSetup
1169 * @version Introduced in firmware 4.1.3.106
1170 * @param setup GoSetup object.
1171 * @param window The x-decimation window (mm).
1172 * @return Operation status.
1173 */
1174 GoFx(kStatus) GoSetup_SetXDecimationWindow(GoSetup setup, k64f window);
1175
1176 /**
1177 * Gets the x-direction decimation window.
1178 *
1179 * @public @memberof GoSetup
1180 * @version Introduced in firmware 4.1.3.106
1181 * @param setup GoSetup object.
1182 * @return The x-decimation window (mm).
1183 */
1184 GoFx(k64f) GoSetup_XDecimationWindow(GoSetup setup);
1185
1186 /**
1187 * Gets the x-direction decimation window minimum.
1188 *
1189 * @public @memberof GoSetup
1190 * @version Introduced in firmware 4.1.3.106
1191 * @param setup GoSetup object.
1192 * @return The x-decimation window min (mm).
1193 */
1194 GoFx(k64f) GoSetup_XDecimationWindowLimitMin(GoSetup setup);
1195
1196 /**
1197 * Gets the x-direction decimation window maximum.
1198 *
1199 * @public @memberof GoSetup
1200 * @version Introduced in firmware 4.1.3.106
1201 * @param setup GoSetup object.
1202 * @return The x-decimation window max (mm).
1203 */
1204 GoFx(k64f) GoSetup_XDecimationWindowLimitMax(GoSetup setup);
1205
1206 /**
1207 * Sets the status of y-direction decimation.
1208 *
1209 * @public @memberof GoSetup
1210 * @version Introduced in firmware 4.1.3.106
1211 * @param setup GoSetup object.
1212 * @param enable Enable or disable y-decimation
1213 * @return Operation status.
1214 */
1215 GoFx(kStatus) GoSetup_EnableYDecimation(GoSetup setup, kBool enable);
1216
1217 /**
1218 * Gets the status of y-direction decimation.
1219 *
1220 * @public @memberof GoSetup
1221 * @version Introduced in firmware 4.1.3.106
1222 * @param setup GoSetup object.
1223 * @return True if y-decimation is enabled.
1224 */
1225 GoFx(kBool) GoSetup_YDecimationEnabled(GoSetup setup);
1226
1227 /**
1228 * Sets the y-direction decimation window.
1229 *
1230 * @public @memberof GoSetup
1231 * @version Introduced in firmware 4.1.3.106
1232 * @param setup GoSetup object.
1233 * @param window The y-decimation window (mm).
1234 * @return Operation status.
1235 */
1236 GoFx(kStatus) GoSetup_SetYDecimationWindow(GoSetup setup, k64f window);
1237
1238 /**
1239 * Gets the y-direction decimation window.
1240 *
1241 * @public @memberof GoSetup
1242 * @version Introduced in firmware 4.1.3.106
1243 * @param setup GoSetup object.
1244 * @return The y-decimation window (mm).
1245 */
1246 GoFx(k64f) GoSetup_YDecimationWindow(GoSetup setup);
1247
1248 /**
1249 * Gets the y-direction decimation window minimum.
1250 *
1251 * @public @memberof GoSetup
1252 * @version Introduced in firmware 4.1.3.106
1253 * @param setup GoSetup object.
1254 * @return The y-decimation window min (mm).
1255 */
1256 GoFx(k64f) GoSetup_YDecimationWindowLimitMin(GoSetup setup);
1257
1258 /**
1259 * Gets the y-direction decimation window maximum.
1260 *
1261 * @public @memberof GoSetup
1262 * @version Introduced in firmware 4.1.3.106
1263 * @param setup GoSetup object.
1264 * @return The y-decimation window max (mm).
1265 */
1266 GoFx(k64f) GoSetup_YDecimationWindowLimitMax(GoSetup setup);
1267
1268
1269 /**
1270 * Sets the status of x-direction gap-filling.
1271 *
1272 * @public @memberof GoSetup
1273 * @version Introduced in firmware 4.0.10.27
1274 * @param setup GoSetup object.
1275 * @param enable Enable or disable x-gap-filling
1276 * @return Operation status.
1277 */
1278 GoFx(kStatus) GoSetup_EnableXGapFilling(GoSetup setup, kBool enable);
1279
1280 /**
1281 * Gets the status of x-direction gap-filling.
1282 *
1283 * @public @memberof GoSetup
1284 * @version Introduced in firmware 4.0.10.27
1285 * @param setup GoSetup object.
1286 * @return True if x-gap-filling is enabled.
1287 */
1288 GoFx(kBool) GoSetup_XGapFillingEnabled(GoSetup setup);
1289
1290 /**
1291 * Sets the status of x-direction gap-filling.
1292 *
1293 * @public @memberof GoSetup
1294 * @version Introduced in firmware 4.0.10.27
1295 * @param setup GoSetup object.
1296 * @param window Enable or disable x-gap-filling
1297 * @return Operation status.
1298 */
1299 GoFx(kStatus) GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window);
1300
1301 /**
1302 * Gets the x-direction gap-filling window.
1303 *
1304 * @public @memberof GoSetup
1305 * @version Introduced in firmware 4.0.10.27
1306 * @param setup GoSetup object.
1307 * @return The x-gap-filling window (mm).
1308 */
1309 GoFx(k64f) GoSetup_XGapFillingWindow(GoSetup setup);
1310
1311 /**
1312 * Gets the x-direction gap-filling window minimum.
1313 *
1314 * @public @memberof GoSetup
1315 * @version Introduced in firmware 4.0.10.27
1316 * @param setup GoSetup object.
1317 * @return The x-gap-filling window min (mm).
1318 */
1319 GoFx(k64f) GoSetup_XGapFillingWindowLimitMin(GoSetup setup);
1320
1321 /**
1322 * Gets the x-direction gap-filling window maximum.
1323 *
1324 * @public @memberof GoSetup
1325 * @version Introduced in firmware 4.0.10.27
1326 * @param setup GoSetup object.
1327 * @return The x-gap-filling window max (mm).
1328 */
1329 GoFx(k64f) GoSetup_XGapFillingWindowLimitMax(GoSetup setup);
1330
1331 /**
1332 * Sets the status of y-direction gap-filling.
1333 *
1334 * @public @memberof GoSetup
1335 * @version Introduced in firmware 4.0.10.27
1336 * @param setup GoSetup object.
1337 * @param enable Enable or disable y-gap-filling
1338 * @return Operation status.
1339 */
1340 GoFx(kStatus) GoSetup_EnableYGapFilling(GoSetup setup, kBool enable);
1341
1342 /**
1343 * Gets the status of y-direction gap-filling.
1344 *
1345 * @public @memberof GoSetup
1346 * @version Introduced in firmware 4.0.10.27
1347 * @param setup GoSetup object.
1348 * @return True if y-gap-filling is enabled.
1349 */
1350 GoFx(kBool) GoSetup_YGapFillingEnabled(GoSetup setup);
1351
1352 /**
1353 * Sets the y-direction gap-filling window.
1354 *
1355 * @public @memberof GoSetup
1356 * @version Introduced in firmware 4.0.10.27
1357 * @param setup GoSetup object.
1358 * @param window The y-gap-filling window (mm).
1359 * @return
1360 */
1361 GoFx(kStatus) GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window);
1362
1363 /**
1364 * Gets the y-direction gap-filling window.
1365 *
1366 * @public @memberof GoSetup
1367 * @version Introduced in firmware 4.0.10.27
1368 * @param setup GoSetup object.
1369 * @return The y-gap-filling window (mm).
1370 */
1371 GoFx(k64f) GoSetup_YGapFillingWindow(GoSetup setup);
1372
1373 /**
1374 * Gets the y-direction gap-filling window minimum.
1375 *
1376 * @public @memberof GoSetup
1377 * @version Introduced in firmware 4.0.10.27
1378 * @param setup GoSetup object.
1379 * @return The y-gap-filling window min (mm).
1380 */
1381 GoFx(k64f) GoSetup_YGapFillingWindowLimitMin(GoSetup setup);
1382
1383 /**
1384 * Gets the y-direction gap-filling window maximum.
1385 *
1386 * @public @memberof GoSetup
1387 * @version Introduced in firmware 4.0.10.27
1388 * @param setup GoSetup object.
1389 * @return The y-gap-filling window max (mm).
1390 */
1391 GoFx(k64f) GoSetup_YGapFillingWindowLimitMax(GoSetup setup);
1392
1393 /**
1394 * Gets the maximum valid value for the Exposure setting.
1395 *
1396 * @public @memberof GoSetup
1397 * @version Introduced in firmware 4.0.10.27
1398 * @param setup GoSetup object.
1399 * @param role Determines which device to retrieve the value from.
1400 * @return Maximum valid Exposure value (microseconds).
1401 */
1402 GoFx(k64f) GoSetup_ExposureLimitMax(GoSetup setup, GoRole role);
1403
1404 /**
1405 * Gets the minimum valid value for the Exposure setting.
1406 *
1407 * @public @memberof GoSetup
1408 * @version Introduced in firmware 4.0.10.27
1409 * @param setup GoSetup object.
1410 * @param role Determines which device to retrieve the value from.
1411 * @return Maximum valid Exposure value (microseconds).
1412 */
1413 GoFx(k64f) GoSetup_ExposureLimitMin(GoSetup setup, GoRole role);
1414
1415 /**
1416 * Sets the exposure value.
1417 *
1418 * @public @memberof GoSetup
1419 * @version Introduced in firmware 4.0.10.27
1420 * @param setup GoSetup object.
1421 * @param role Determines which sensor to apply changes to.
1422 * @param exposure Intended exposure value.
1423 * @return Operation status.
1424 */
1425 GoFx(kStatus) GoSetup_SetExposure(GoSetup setup, GoRole role, k64f exposure);
1426
1427 /**
1428 * Gets the exposure value.
1429 *
1430 * @public @memberof GoSetup
1431 * @version Introduced in firmware 4.0.10.27
1432 * @param setup GoSetup object.
1433 * @param role Determines which device to retrieve the value from.
1434 * @return Exposure value (microseconds).
1435 */
1436 GoFx(k64f) GoSetup_Exposure(GoSetup setup, GoRole role);
1437
1438 /**
1439 * Gets the exposure mode.
1440 *
1441 * @public @memberof GoSetup
1442 * @version Introduced in firmware 4.0.10.27
1443 * @param setup GoSetup object.
1444 * @param role Determines which device to retrieve the value from.
1445 * @return Exposure mode.
1446 */
1447 GoFx(GoExposureMode) GoSetup_ExposureMode(GoSetup setup, GoRole role);
1448
1449 /**
1450 * Sets the exposure mode.
1451 *
1452 * @public @memberof GoSetup
1453 * @version Introduced in firmware 4.0.10.27
1454 * @param setup GoSetup object.
1455 * @param role Determines which sensor to apply changes to.
1456 * @param mode The exposure mode to use.
1457 * @return Operation status.
1458 */
1459 GoFx(kStatus) GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode);
1460
1461 /**
1462 * Gets the exposure mode option at the given index.
1463 *
1464 * @public @memberof GoSetup
1465 * @version Introduced in firmware 4.0.10.27
1466 * @param setup GoSetup object.
1467 * @param role Determines which device to retrieve the value from.
1468 * @param index The index with which to retrieve an exposure mode option.
1469 * @return Exposure mode option.
1470 * @see GoSetup_ExposureModeOptionCount
1471 */
1472 GoFx(GoExposureMode) GoSetup_ExposureModeOptionAt(GoSetup setup, GoRole role, kSize index);
1473
1474 /**
1475 * Gets the exposure mode option count.
1476 *
1477 * @public @memberof GoSetup
1478 * @version Introduced in firmware 4.0.10.27
1479 * @param setup GoSetup object.
1480 * @param role Determines which device to retrieve the value from.
1481 * @return Exposure mode option count.
1482 */
1483 GoFx(kSize) GoSetup_ExposureModeOptionCount(GoSetup setup, GoRole role);
1484
1485 /**
1486 * Adds an exposure step
1487 *
1488 * @public @memberof GoSetup
1489 * @version Introduced in firmware 4.0.10.27
1490 * @param setup GoSetup object.
1491 * @param role Determines which sensor to apply changes to.
1492 * @param exposure Expsosure value (microseconds).
1493 * @return Operation status.
1494 */
1495 GoFx(kStatus) GoSetup_AddExposureStep(GoSetup setup, GoRole role, k64f exposure);
1496
1497 /**
1498 * Removes all exposure steps.
1499 *
1500 * @public @memberof GoSetup
1501 * @version Introduced in firmware 4.0.10.27
1502 * @param setup GoSetup object.
1503 * @param role Determines which sensor to apply changes to.
1504 * @return Operation status.
1505 */
1506 GoFx(kStatus) GoSetup_ClearExposureSteps(GoSetup setup, GoRole role);
1507
1508 /**
1509 * Get the exposure step value specified by index
1510 *
1511 * @public @memberof GoSetup
1512 * @version Introduced in firmware 4.0.10.27
1513 * @param setup GoSetup object.
1514 * @param role Determines which device to retrieve the value from.
1515 * @param index The index of the exposure step to get.
1516 * @return The exposure step value (microseconds).
1517 * @see GoSetup_ExposureStepCount
1518 */
1519 GoFx(k64f) GoSetup_ExposureStepAt(GoSetup setup, GoRole role, kSize index);
1520
1521 /**
1522 * Get the number of exposure steps defined
1523 *
1524 * @public @memberof GoSetup
1525 * @version Introduced in firmware 4.0.10.27
1526 * @param setup GoSetup object.
1527 * @param role Determines which device to retrieve the value from.
1528 * @return The count of exposure steps.
1529 */
1530 GoFx(kSize) GoSetup_ExposureStepCount(GoSetup setup, GoRole role);
1531
1532 /**
1533 * Gets the maximum value for the Dynamic Exposure setting.
1534 *
1535 * @public @memberof GoSetup
1536 * @version Introduced in firmware 4.0.10.27
1537 * @param setup GoSetup object.
1538 * @param role Determines which device to retrieve the value from.
1539 * @return Maximum Dynamic Exposure value (microseconds).
1540 */
1541 GoFx(k64f) GoSetup_DynamicExposureMax(GoSetup setup, GoRole role);
1542
1543 /**
1544 * Sets the maximum value for the Dynamic Exposure setting.
1545 *
1546 * @public @memberof GoSetup
1547 * @version Introduced in firmware 4.0.10.27
1548 * @param setup GoSetup object.
1549 * @param role Determines which sensor to apply changes to.
1550 * @param exposure Maximum Dynamic Exposure value (microseconds).
1551 * @return Operation status.
1552 */
1553 GoFx(kStatus) GoSetup_SetDynamicExposureMax(GoSetup setup, GoRole role, k64f exposure);
1554
1555 /**
1556 * Gets the minimum value for the Dynamic Exposure setting.
1557 *
1558 * @public @memberof GoSetup
1559 * @version Introduced in firmware 4.0.10.27
1560 * @param setup GoSetup object.
1561 * @param role Determines which device to retrieve the value from.
1562 * @return Minimum Dynamic Exposure value (microseconds).
1563 */
1564 GoFx(k64f) GoSetup_DynamicExposureMin(GoSetup setup, GoRole role);
1565
1566 /**
1567 * Sets the minimum value for the Dynamic Exposure setting.
1568 *
1569 * @public @memberof GoSetup
1570 * @version Introduced in firmware 4.0.10.27
1571 * @param setup GoSetup object.
1572 * @param role Determines which sensor to apply changes to.
1573 * @param exposure Minumum Dynamic Exposure value (microseconds).
1574 * @return Operation status.
1575 */
1576 GoFx(kStatus) GoSetup_SetDynamicExposureMin(GoSetup setup, GoRole role, k64f exposure);
1577
1578 /**
1579 * Gets the minimum valid value for the ActiveAreaHeight setting.
1580 *
1581 * @public @memberof GoSetup
1582 * @version Introduced in firmware 4.0.10.27
1583 * @param setup GoSetup object.
1584 * @param role Determines which device to retrieve the value from.
1585 * @return Minimum valid ActiveAreaHeight value (mm).
1586 */
1587 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMin(GoSetup setup, GoRole role);
1588
1589 /**
1590 * Gets the maximum valid value for the ActiveAreaHeight setting.
1591 *
1592 * @public @memberof GoSetup
1593 * @version Introduced in firmware 4.0.10.27
1594 * @param setup GoSetup object.
1595 * @param role Determines which device to retrieve the value from.
1596 * @return Maximum valid active area height value (mm).
1597 */
1598 GoFx(k64f) GoSetup_ActiveAreaHeightLimitMax(GoSetup setup, GoRole role);
1599
1600 /**
1601 * Gets the active area height.
1602 *
1603 * @public @memberof GoSetup
1604 * @version Introduced in firmware 4.0.10.27
1605 * @param setup GoSetup object.
1606 * @param role Determines which device to retrieve the value from.
1607 * @return Active area height (mm).
1608 */
1609 GoFx(k64f) GoSetup_ActiveAreaHeight(GoSetup setup, GoRole role);
1610
1611 /**
1612 * Sets the active area height.
1613 *
1614 * @public @memberof GoSetup
1615 * @version Introduced in firmware 4.0.10.27
1616 * @param setup GoSetup object.
1617 * @param role Determines which sensor to apply changes to.
1618 * @param value Active area height (mm).
1619 * @return Operation status.
1620 */
1621 GoFx(kStatus) GoSetup_SetActiveAreaHeight(GoSetup setup, GoRole role, k64f value);
1622
1623 /**
1624 * Gets the active area Length.
1625 *
1626 * @public @memberof GoSetup
1627 * @version Introduced in firmware 4.0.10.27
1628 * @param setup GoSetup object.
1629 * @param role Determines which device to retrieve the value from.
1630 * @return Active area Length (mm).
1631 */
1632 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
1633
1634 /**
1635 * Gets the minimum valid value for the ActiveAreaLength setting.
1636 *
1637 * @public @memberof GoSetup
1638 * @version Introduced in firmware 4.0.10.27
1639 * @param setup GoSetup object.
1640 * @param role Determines which device to retrieve the value from.
1641 * @return Minimum valid ActiveAreaLength value (mm).
1642 */
1643 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role);
1644
1645 /**
1646 * Gets the maximum valid value for the ActiveAreaLength setting.
1647 *
1648 * @public @memberof GoSetup
1649 * @version Introduced in firmware 4.0.10.27
1650 * @param setup GoSetup object.
1651 * @param role Determines which device to retrieve the value from.
1652 * @return Maximum valid ActiveAreaLength value (mm).
1653 */
1654 GoFx(k64f) GoSetup_ActiveAreaLengthLimitMax(GoSetup setup, GoRole role);
1655
1656 /**
1657 * Sets the active area Length.
1658 *
1659 * @public @memberof GoSetup
1660 * @version Introduced in firmware 4.0.10.27
1661 * @param setup GoSetup object.
1662 * @param role Determines which sensor to apply changes to.
1663 * @param value Active area Length (mm).
1664 * @return Operation status.
1665 */
1666 GoFx(kStatus) GoSetup_SetActiveAreaLength(GoSetup setup, GoRole role, k64f value);
1667
1668 /**
1669 * Gets the active area Length.
1670 *
1671 * @public @memberof GoSetup
1672 * @version Introduced in firmware 4.0.10.27
1673 * @param setup GoSetup object.
1674 * @param role Determines which device to retrieve the value from.
1675 * @return Active area Length (mm).
1676 */
1677 GoFx(k64f) GoSetup_ActiveAreaLength(GoSetup setup, GoRole role);
1678
1679
1680 /**
1681 * Gets the minimum valid value for the ActiveAreaWidth setting.
1682 *
1683 * @public @memberof GoSetup
1684 * @version Introduced in firmware 4.0.10.27
1685 * @param setup GoSetup object.
1686 * @param role Determines which device to retrieve the value from.
1687 * @return Minimum valid ActiveAreaWidth value (mm).
1688 */
1689 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMin(GoSetup setup, GoRole role);
1690
1691 /**
1692 * Gets the maximum valid value for the ActiveAreaWidth setting.
1693 *
1694 * @public @memberof GoSetup
1695 * @version Introduced in firmware 4.0.10.27
1696 * @param setup GoSetup object.
1697 * @param role Determines which device to retrieve the value from.
1698 * @return Maximum valid ActiveAreaWidth value (mm).
1699 */
1700 GoFx(k64f) GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role);
1701
1702 /**
1703 * Sets the active area width.
1704 *
1705 * @public @memberof GoSetup
1706 * @version Introduced in firmware 4.0.10.27
1707 * @param setup GoSetup object.
1708 * @param role Determines which sensor to apply changes to.
1709 * @param value Active area width (mm).
1710 * @return Operation status.
1711 */
1712 GoFx(kStatus) GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value);
1713
1714 /**
1715 * Gets the active area width.
1716 *
1717 * @public @memberof GoSetup
1718 * @version Introduced in firmware 4.0.10.27
1719 * @param setup GoSetup object.
1720 * @param role Determines which device to retrieve the value from.
1721 * @return Active area width (mm).
1722 */
1723 GoFx(k64f) GoSetup_ActiveAreaWidth(GoSetup setup, GoRole role);
1724
1725 /**
1726 * Gets the minimum valid value for the ActiveAreaX setting.
1727 *
1728 * @public @memberof GoSetup
1729 * @version Introduced in firmware 4.0.10.27
1730 * @param setup GoSetup object.
1731 * @param role Determines which device to retrieve the value from.
1732 * @return Minimum valid ActiveAreaX value (mm).
1733 */
1734 GoFx(k64f) GoSetup_ActiveAreaXLimitMin(GoSetup setup, GoRole role);
1735
1736 /**
1737 * Gets the maximum valid value for the ActiveAreaX setting.
1738 *
1739 * @public @memberof GoSetup
1740 * @version Introduced in firmware 4.0.10.27
1741 * @param setup GoSetup object.
1742 * @param role Determines which device to retrieve the value from.
1743 * @return Maximum valid ActiveAreaX value (mm).
1744 */
1745 GoFx(k64f) GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role);
1746
1747 /**
1748 * Sets the active area x origin.
1749 *
1750 * @public @memberof GoSetup
1751 * @version Introduced in firmware 4.0.10.27
1752 * @param setup GoSetup object.
1753 * @param role Determines which sensor to apply changes to.
1754 * @param value Active area x origin (mm).
1755 * @return Operation status.
1756 */
1757 GoFx(kStatus) GoSetup_SetActiveAreaX(GoSetup setup, GoRole role, k64f value);
1758
1759 /**
1760 * Gets the active area x origin.
1761 *
1762 * @public @memberof GoSetup
1763 * @version Introduced in firmware 4.0.10.27
1764 * @param setup GoSetup object.
1765 * @param role Determines which device to retrieve the value from.
1766 * @return Active area x origin (mm).
1767 */
1768 GoFx(k64f) GoSetup_ActiveAreaX(GoSetup setup, GoRole role);
1769
1770 /**
1771 * Gets the minimum valid value for the ActiveAreaY setting.
1772 *
1773 * @public @memberof GoSetup
1774 * @version Introduced in firmware 4.0.10.27
1775 * @param setup GoSetup object.
1776 * @param role Determines which device to retrieve the value from.
1777 * @return Minimum valid ActiveAreaY value (mm).
1778 */
1779 GoFx(k64f) GoSetup_ActiveAreaYLimitMin(GoSetup setup, GoRole role);
1780
1781 /**
1782 * Gets the maximum valid value for the ActiveAreaY setting.
1783 *
1784 * @public @memberof GoSetup
1785 * @version Introduced in firmware 4.0.10.27
1786 * @param setup GoSetup object.
1787 * @param role Determines which device to retrieve the value from.
1788 * @return Maximum valid ActiveAreaY value (mm).
1789 */
1790 GoFx(k64f) GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role);
1791
1792 /**
1793 * Sets the active area Y.
1794 *
1795 * @public @memberof GoSetup
1796 * @version Introduced in firmware 4.0.10.27
1797 * @param setup GoSetup object.
1798 * @param role Determines which sensor to apply changes to.
1799 * @param value Active area y origin (mm).
1800 * @return Operation status.
1801 */
1802 GoFx(kStatus) GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value);
1803
1804 /**
1805 * Gets the active area Y.
1806 *
1807 * @public @memberof GoSetup
1808 * @version Introduced in firmware 4.0.10.27
1809 * @param setup GoSetup object.
1810 * @param role Determines which device to retrieve the value from.
1811 * @return Active area y origin (mm).
1812 */
1813 GoFx(k64f) GoSetup_ActiveAreaY(GoSetup setup, GoRole role);
1814
1815 /**
1816 * Gets the minimum valid value for the ActiveAreaZ setting.
1817 *
1818 * @public @memberof GoSetup
1819 * @version Introduced in firmware 4.0.10.27
1820 * @param setup GoSetup object.
1821 * @param role Determines which device to retrieve the value from.
1822 * @return Minimum valid ActiveAreaZ value (mm).
1823 */
1824 GoFx(k64f) GoSetup_ActiveAreaZLimitMin(GoSetup setup, GoRole role);
1825
1826 /**
1827 * Gets the maximum valid value for the ActiveAreaZ setting.
1828 *
1829 * @public @memberof GoSetup
1830 * @version Introduced in firmware 4.0.10.27
1831 * @param setup GoSetup object.
1832 * @param role Determines which device to retrieve the value from.
1833 * @return Maximum valid ActiveAreaZ value (mm).
1834 */
1835 GoFx(k64f) GoSetup_ActiveAreaZLimitMax(GoSetup setup, GoRole role);
1836
1837 /**
1838 * Sets the active area z origin.
1839 *
1840 * @public @memberof GoSetup
1841 * @version Introduced in firmware 4.0.10.27
1842 * @param setup GoSetup object.
1843 * @param role Determines which sensor to apply changes to.
1844 * @param value Active area z origin (mm).
1845 * @return Operation status.
1846 */
1847 GoFx(kStatus) GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value);
1848
1849 /**
1850 * Gets the active area z origin.
1851 *
1852 * @public @memberof GoSetup
1853 * @version Introduced in firmware 4.0.10.27
1854 * @param setup GoSetup object.
1855 * @param role Determines which device to retrieve the value from.
1856 * @return Active area z origin (mm).
1857 */
1858 GoFx(k64f) GoSetup_ActiveAreaZ(GoSetup setup, GoRole role);//
1859
1860 /**
1861 * Gets the transformed data region X value.
1862 *
1863 * @public @memberof GoSetup
1864 * @version Introduced in firmware 4.0.10.27
1865 * @param setup GoSetup object.
1866 * @param role The device whose value to retrieve.
1867 * @return The transformed data region X value.
1868 */
1869 GoFx(k64f) GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role);
1870
1871 /**
1872 * Gets the transformed data region Y value.
1873 *
1874 * @public @memberof GoSetup
1875 * @version Introduced in firmware 4.0.10.27
1876 * @param setup GoSetup object.
1877 * @param role The device whose value to retrieve.
1878 * @return The transformed data region Y value.
1879 */
1880 GoFx(k64f) GoSetup_TransformedDataRegionY(GoSetup setup, GoRole role);
1881
1882 /**
1883 * Gets the transformed data region Z value.
1884 *
1885 * @public @memberof GoSetup
1886 * @version Introduced in firmware 4.0.10.27
1887 * @param setup GoSetup object.
1888 * @param role The device whose value to retrieve.
1889 * @return The transformed data region Z value.
1890 */
1891 GoFx(k64f) GoSetup_TransformedDataRegionZ(GoSetup setup, GoRole role);
1892
1893 /**
1894 * Gets the transformed data region width value.
1895 *
1896 * @public @memberof GoSetup
1897 * @version Introduced in firmware 4.0.10.27
1898 * @param setup GoSetup object.
1899 * @param role The device whose value to retrieve.
1900 * @return The transformed data region width value.
1901 */
1902 GoFx(k64f) GoSetup_TransformedDataRegionWidth(GoSetup setup, GoRole role);
1903
1904 /**
1905 * Gets the transformed data region length value.
1906 *
1907 * @public @memberof GoSetup
1908 * @version Introduced in firmware 4.0.10.27
1909 * @param setup GoSetup object.
1910 * @param role The device whose value to retrieve.
1911 * @return The transformed data region length value.
1912 */
1913 GoFx(k64f) GoSetup_TransformedDataRegionLength(GoSetup setup, GoRole role);
1914
1915 /**
1916 * Gets the transformed data region height value.
1917 *
1918 * @public @memberof GoSetup
1919 * @version Introduced in firmware 4.0.10.27
1920 * @param setup GoSetup object.
1921 * @param role The device whose value to retrieve.
1922 * @return The transformed data region height value.
1923 */
1924 GoFx(k64f) GoSetup_TransformedDataRegionHeight(GoSetup setup, GoRole role);
1925
1926 /**
1927 * Gets the count of valid x-resolution options.
1928 *
1929 * @public @memberof GoSetup
1930 * @version Introduced in firmware 4.0.10.27
1931 * @param setup GoSetup object.
1932 * @param role Determines which device to retrieve the value from.
1933 * @return Count of x-resolution options.
1934 */
1935 GoFx(kSize) GoSetup_XSubsamplingOptionCount(GoSetup setup, GoRole role);
1936
1937 /**
1938 * Gets the x-resolution option at the specified index.
1939 *
1940 * @public @memberof GoSetup
1941 * @version Introduced in firmware 4.0.10.27
1942 * @param setup GoSetup object.
1943 * @param role Determines which device to retrieve the value from.
1944 * @param index Index of the desired resolution option.
1945 * @return X resolution option.
1946 * @see GoSetup_XSubsamplingOptionCount
1947 */
1948 GoFx(k32u) GoSetup_XSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
1949
1950 /**
1951 * Sets the current x-resolution divider.
1952 *
1953 * @public @memberof GoSetup
1954 * @version Introduced in firmware 4.0.10.27
1955 * @param setup GoSetup object.
1956 * @param role Determines which sensor to apply changes to.
1957 * @param xSubsampling X subsampling divider (e.g. 1 - full res, 2 - half res).
1958 * @return Operation status.
1959 */
1960 GoFx(kStatus) GoSetup_SetXSubsampling(GoSetup setup, GoRole role, k32u xSubsampling);
1961
1962 /**
1963 * Gets the current x-resolution divider.
1964 *
1965 * @public @memberof GoSetup
1966 * @version Introduced in firmware 4.0.10.27
1967 * @param setup GoSetup object.
1968 * @param role Determines which device to retrieve the value from.
1969 * @return X resolution divider (e.g. 1 - full res, 2 - half res).
1970 */
1971 GoFx(k32u) GoSetup_XSubsampling(GoSetup setup, GoRole role);
1972
1973 /**
1974 * Gets the count of valid z-resolution options.
1975 *
1976 * @public @memberof GoSetup
1977 * @version Introduced in firmware 4.0.10.27
1978 * @param setup GoSetup object.
1979 * @param role Determines which device to retrieve the value from.
1980 * @return Count of z-resolution options.
1981 */
1982 GoFx(kSize) GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role);
1983
1984 /**
1985 * Gets the z-resolution option at the specified index.
1986 *
1987 * @public @memberof GoSetup
1988 * @version Introduced in firmware 4.0.10.27
1989 * @param setup GoSetup object.
1990 * @param role Determines which device to retrieve the value from.
1991 * @param index Index of the desired resolution option.
1992 * @return Z resolution option.
1993 * see GoSetup_ZSubsamplingOptionCount
1994 */
1995 GoFx(k32u) GoSetup_ZSubsamplingOptionAt(GoSetup setup, GoRole role, kSize index);
1996
1997 /**
1998 * Sets the current z-resolution divider.
1999 *
2000 * @public @memberof GoSetup
2001 * @version Introduced in firmware 4.0.10.27
2002 * @param setup GoSetup object.
2003 * @param role Determines which sensor to apply changes to.
2004 * @param zSubsampling Z subsampling divider (e.g. 1 - full res, 2 - half res).
2005 * @return Operation status.
2006 */
2007 GoFx(kStatus) GoSetup_SetZSubsampling(GoSetup setup, GoRole role, k32u zSubsampling);
2008
2009 /**
2010 * Gets the current z-resolution divider.
2011 *
2012 * @public @memberof GoSetup
2013 * @version Introduced in firmware 4.0.10.27
2014 * @param setup GoSetup object.
2015 * @param role Determines which device to retrieve the value from.
2016 * @return Z resolution divider (e.g. 1 - full res, 2 - half res).
2017 */
2018 GoFx(k32u) GoSetup_ZSubsampling(GoSetup setup, GoRole role);
2019
2020 /**
2021 * Gets the camera region-of-interest x origin.
2022 *
2023 * @public @memberof GoSetup
2024 * @version Introduced in firmware 4.0.10.27
2025 * @param setup GoSetup object.
2026 * @param role Determines which device to retrieve the value from.
2027 * @return Region of interest x origin (pixels).
2028 */
2029 GoFx(k32u) GoSetup_FrontCameraX(GoSetup setup, GoRole role);
2030
2031 /**
2032 * Gets the camera region-of-interest y origin.
2033 *
2034 * @public @memberof GoSetup
2035 * @version Introduced in firmware 4.0.10.27
2036 * @param setup GoSetup object.
2037 * @param role Determines which device to retrieve the value from.
2038 * @return Region of interest y origin (pixels).
2039 */
2040 GoFx(k32u) GoSetup_FrontCameraY(GoSetup setup, GoRole role);
2041
2042 /**
2043 * Gets the camera region-of-interest width.
2044 *
2045 * @public @memberof GoSetup
2046 * @version Introduced in firmware 4.0.10.27
2047 * @param setup GoSetup object.
2048 * @param role Determines which device to retrieve the value from.
2049 * @return Region of interest width (pixels).
2050 */
2051 GoFx(k32u) GoSetup_FrontCameraWidth(GoSetup setup, GoRole role);
2052
2053 /**
2054 * Gets the camera region-of-interest height.
2055 *
2056 * @public @memberof GoSetup
2057 * @version Introduced in firmware 4.0.10.27
2058 * @param setup GoSetup object.
2059 * @param role Determines which device to retrieve the value from.
2060 * @return Region of interest height (pixels).
2061 */
2062 GoFx(k32u) GoSetup_FrontCameraHeight(GoSetup setup, GoRole role);
2063
2064 /**
2065 * Returns a boolean representing whether the back camera element is used.
2066 *
2067 * @public @memberof GoSetup
2068 * @version Introduced in firmware 4.1.3.106
2069 * @param setup GoSetup object.
2070 * @param role Determines which device to retrieve the value from.
2071 * @return kTRUE if used, or kFALSE if not used.
2072 */
2073 GoFx(k32u) GoSetup_BackCameraUsed(GoSetup setup, GoRole role);
2074
2075 /**
2076 * Gets the camera region-of-interest x origin.
2077 *
2078 * @public @memberof GoSetup
2079 * @version Introduced in firmware 4.0.10.27
2080 * @param setup GoSetup object.
2081 * @param role Determines which device to retrieve the value from.
2082 * @return Region of interest x origin (pixels).
2083 */
2084 GoFx(k32u) GoSetup_BackCameraX(GoSetup setup, GoRole role);
2085
2086 /**
2087 * Gets the camera region-of-interest y origin.
2088 *
2089 * @public @memberof GoSetup
2090 * @version Introduced in firmware 4.0.10.27
2091 * @param setup GoSetup object.
2092 * @param role Determines which device to retrieve the value from.
2093 * @return Region of interest y origin (pixels).
2094 */
2095 GoFx(k32u) GoSetup_BackCameraY(GoSetup setup, GoRole role);
2096
2097 /**
2098 * Gets the camera region-of-interest width.
2099 *
2100 * @public @memberof GoSetup
2101 * @version Introduced in firmware 4.0.10.27
2102 * @param setup GoSetup object.
2103 * @param role Determines which device to retrieve the value from.
2104 * @return Region of interest width (pixels).
2105 */
2106 GoFx(k32u) GoSetup_BackCameraWidth(GoSetup setup, GoRole role);
2107
2108 /**
2109 * Gets the camera region-of-interest height.
2110 *
2111 * @public @memberof GoSetup
2112 * @version Introduced in firmware 4.0.10.27
2113 * @param setup GoSetup object.
2114 * @param role Determines which device to retrieve the value from.
2115 * @return Region of interest height (pixels).
2116 */
2117 GoFx(k32u) GoSetup_BackCameraHeight(GoSetup setup, GoRole role);
2118
2119 /**
2120 * Enables tracking.
2121 *
2122 * @public @memberof GoSetup
2123 * @version Introduced in firmware 4.0.10.27
2124 * @param setup GoSetup object.
2125 * @param role Determines which sensor to apply changes to.
2126 * @param enable kTRUE to enable, or kFALSE to disable.
2127 * @return Operation status.
2128 */
2129 GoFx(kStatus) GoSetup_EnableTracking(GoSetup setup, GoRole role, kBool enable);
2130
2131 /**
2132 * Determines if tracking is enabled.
2133 *
2134 * @public @memberof GoSetup
2135 * @version Introduced in firmware 4.0.10.27
2136 * @param setup GoSetup object.
2137 * @param role Determines which device to retrieve the value from.
2138 * @return kTRUE if enabled, or kFALSE if disabled.
2139 */
2140 GoFx(kBool) GoSetup_TrackingEnabled(GoSetup setup, GoRole role);
2141
2142 /**
2143 * Returns a boolean value representing whether the Tracking Enabled field is used.
2144 *
2145 * @public @memberof GoSetup
2146 * @version Introduced in firmware 4.1.3.106
2147 * @param setup GoSetup object.
2148 * @param role Determines which device to retrieve the value from.
2149 * @return kTRUE if used, or kFALSE if not used.
2150 */
2151 GoFx(kBool) GoSetup_TrackingUsed(GoSetup setup, GoRole role);
2152
2153 /**
2154 * Sets the tracking window height.
2155 *
2156 * @public @memberof GoSetup
2157 * @version Introduced in firmware 4.0.10.27
2158 * @param setup GoSetup object.
2159 * @param role Determines which sensor to apply changes to.
2160 * @param height Tracking window height (mm).
2161 * @return Operation status.
2162 */
2163 GoFx(kStatus) GoSetup_SetTrackingAreaHeight(GoSetup setup, GoRole role, k64f height);
2164
2165 /**
2166 * Gets the tracking window height.
2167 *
2168 * @public @memberof GoSetup
2169 * @version Introduced in firmware 4.0.10.27
2170 * @param setup GoSetup object.
2171 * @param role Determines which device to retrieve the value from.
2172 * @return Tracking window height (mm).
2173 */
2174 GoFx(k64f) GoSetup_TrackingAreaHeight(GoSetup setup, GoRole role);
2175
2176 /**
2177 * Gets the tracking window height minimum limit.
2178 *
2179 * @public @memberof GoSetup
2180 * @version Introduced in firmware 4.0.10.27
2181 * @param setup GoSetup object.
2182 * @param role Determines which device to retrieve the value from.
2183 * @return Tracking window height min(mm).
2184 */
2185 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMin(GoSetup setup, GoRole role);
2186
2187 /**
2188 * Gets the tracking window height maximum limit.
2189 *
2190 * @public @memberof GoSetup
2191 * @version Introduced in firmware 4.0.10.27
2192 * @param setup GoSetup object.
2193 * @param role Determines which device to retrieve the value from.
2194 * @return Tracking window height max(mm).
2195 */
2196 GoFx(k64f) GoSetup_TrackingAreaHeightLimitMax(GoSetup setup, GoRole role);
2197
2198 /**
2199 * Sets the tracking window search threshold.
2200 *
2201 * @public @memberof GoSetup
2202 * @version Introduced in firmware 4.0.10.27
2203 * @param setup GoSetup object.
2204 * @param role Determines which sensor to apply changes to.
2205 * @param threshold Tracking window search threshold (%)
2206 * @return Operation status.
2207 */
2208 GoFx(kStatus) GoSetup_SetTrackingSearchThreshold(GoSetup setup, GoRole role, k64f threshold);
2209
2210 /**
2211 * Gets the tracking window search threshold.
2212 *
2213 * @public @memberof GoSetup
2214 * @version Introduced in firmware 4.0.10.27
2215 * @param setup GoSetup object.
2216 * @param role Determines which device to retrieve the value from.
2217 * @return Tracking window search threshold (%).
2218 */
2219 GoFx(k64f) GoSetup_TrackingSearchThreshold(GoSetup setup, GoRole role);
2220
2221 /**
2222 * Returns the state of whether the user specified spacing interval is used.
2223 *
2224 * @public @memberof GoSetup
2225 * @version Introduced in firmware 4.0.10.27
2226 * @param setup GoSetup object.
2227 * @param role Determines which device to retrieve the value from.
2228 * @return kTRUE if the user value is used and kFALSE otherwise.
2229 */
2230 GoFx(kBool) GoSetup_SpacingIntervalUsed(GoSetup setup, GoRole role);
2231
2232 /**
2233 * Gets the spacing interval system value.
2234 *
2235 * @public @memberof GoSetup
2236 * @version Introduced in firmware 4.0.10.27
2237 * @param setup GoSetup object.
2238 * @param role Determines which device to retrieve the value from.
2239 * @return Spacing interval.
2240 */
2241 GoFx(k64f) GoSetup_SpacingIntervalSystemValue(GoSetup setup, GoRole role);
2242
2243 /**
2244 * Gets the spacing interval.
2245 *
2246 * @public @memberof GoSetup
2247 * @version Introduced in firmware 4.0.10.27
2248 * @param setup GoSetup object.
2249 * @param role Determines which device to retrieve the value from.
2250 * @return Spacing interval.
2251 */
2252 GoFx(k64f) GoSetup_SpacingInterval(GoSetup setup, GoRole role);
2253
2254 /// @cond (Gocator_3x00)
2255 /**
2256 * Sets the spacing interval.
2257 *
2258 * @public @memberof GoSetup
2259 * @version Introduced in firmware 4.0.10.27
2260 * @param setup GoSetup object.
2261 * @param role Determines which sensor to apply changes to.
2262 * @param value The spacing interval.
2263 * @return Operation status.
2264 */
2265 GoFx(kStatus) GoSetup_SetSpacingInterval(GoSetup setup, GoRole role, k64f value);
2266 /// @endcond
2267
2268 /**
2269 * Gets the spacing interval value limit minimum.
2270 *
2271 * @public @memberof GoSetup
2272 * @version Introduced in firmware 4.0.10.27
2273 * @param setup GoSetup object.
2274 * @param role Determines which device to retrieve the value from.
2275 * @return Spacing interval value limit minimum.
2276 */
2277 GoFx(k64f) GoSetup_SpacingIntervalLimitMin(GoSetup setup, GoRole role);
2278
2279 /**
2280 * Gets the spacing interval value limit maximum
2281 *
2282 * @public @memberof GoSetup
2283 * @version Introduced in firmware 4.0.10.27
2284 * @param setup GoSetup object.
2285 * @param role Determines which device to retrieve the value from.
2286 * @return Spacing interval value limit maximum.
2287 */
2288 GoFx(k64f) GoSetup_SpacingIntervalLimitMax(GoSetup setup, GoRole role);
2289
2290 /**
2291 * Gets the spacing interval type.
2292 *
2293 * @public @memberof GoSetup
2294 * @version Introduced in firmware 4.0.10.27
2295 * @param setup GoSetup object.
2296 * @param role Determines which device to retrieve the value from.
2297 * @return The spacing interval type.
2298 */
2299 GoFx(GoSpacingIntervalType) GoSetup_SpacingIntervalType(GoSetup setup, GoRole role);
2300
2301 /**
2302 * Sets the spacing interval type.
2303 *
2304 * @public @memberof GoSetup
2305 * @version Introduced in firmware 4.0.10.27
2306 * @param setup GoSetup object.
2307 * @param role Determines which sensor to apply changes to.
2308 * @param type The spacing interval type.
2309 * @return Operation status.
2310 */
2311 GoFx(kStatus) GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type);
2312
2313 /**
2314 * Gets the system value representing whether or not the user specified spacing interval type setting is being used at the moment.
2315 *
2316 * @public @memberof GoSetup
2317 * @version Introduced in firmware 4.0.10.27
2318 * @param setup GoSetup object.
2319 * @param role The device role from which to retrieve the setting.
2320 * @return kTRUE if the user specified spacing interval type setting is used and kFALSE otherwise.
2321 */
2322 GoFx(kBool) GoSetup_SpacingIntervalTypeUsed(GoSetup setup, GoRole role);
2323
2324 /**
2325 * Gets the X spacing count.
2326 *
2327 * @public @memberof GoSetup
2328 * @version Introduced in firmware 4.0.10.27
2329 * @param setup GoSetup object.
2330 * @param role Determines which device to retrieve the value from.
2331 * @return X spacing count.
2332 */
2333 GoFx(k32u) GoSetup_XSpacingCount(GoSetup setup, GoRole role);
2334
2335 /**
2336 * Gets the Y spacing count.
2337 *
2338 * @public @memberof GoSetup
2339 * @version Introduced in firmware 4.0.10.27
2340 * @param setup GoSetup object.
2341 * @param role Determines which device to retrieve the value from.
2342 * @return Y spacing count.
2343 */
2344 GoFx(k32u) GoSetup_YSpacingCount(GoSetup setup, GoRole role);
2345
2346 /**
2347 * Gets the intensity step index.
2348 *
2349 * @public @memberof GoSetup
2350 * @version Introduced in firmware 4.0.10.27
2351 * @param setup GoSetup object.
2352 * @param role Determines which device to retrieve the value from.
2353 * @return The intensity step index.
2354 */
2355 GoFx(kSize) GoSetup_IntensityStepIndex(GoSetup setup, GoRole role);
2356
2357 /**
2358 * Sets the intensity step index.
2359 *
2360 * @public @memberof GoSetup
2361 * @version Introduced in firmware 4.0.10.27
2362 * @param setup GoSetup object.
2363 * @param role Determines which sensor to apply changes to.
2364 * @param index The exposure step index to use for intensity acquisition.
2365 * @return Operation status.
2366 * @see GoSetup_SetExposureMode, GoSetup_ExposureStepCount
2367 */
2368 GoFx(kStatus) GoSetup_SetIntensityStepIndex(GoSetup setup, GoRole role, kSize index);
2369
2370 /**
2371 * Gets the pattern sequence type option count.
2372 *
2373 * @public @memberof GoSetup
2374 * @version Introduced in firmware 4.2.4.7
2375 * @param setup GoSetup object.
2376 * @param role Determines which device to retrieve the value from.
2377 * @return Pattern sequence type option count.
2378 */
2379 GoFx(kSize) GoSetup_PatternSequenceTypeOptionCount(GoSetup setup, GoRole role);
2380
2381 /**
2382 * Gets the pattern sequence type option at the given index.
2383 *
2384 * @public @memberof GoSetup
2385 * @version Introduced in firmware 4.2.4.7
2386 * @param setup GoSetup object.
2387 * @param role Determines which device to retrieve the value from.
2388 * @param index The index with which to retrieve a sequence type option.
2389 * @return A sequence type option value.
2390 * @see GoSetup_PatternSequenceOptionCount
2391 */
2392 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceTypeOptionAt(GoSetup setup, GoRole role, kSize index);
2393
2394 /**
2395 * Gets the pattern sequence type.
2396 *
2397 * @public @memberof GoSetup
2398 * @version Introduced in firmware 4.2.4.7
2399 * @param setup GoSetup object.
2400 * @param role Determines which device to retrieve the value from.
2401 * @return The pattern sequence type.
2402 */
2403 GoFx(GoPatternSequenceType) GoSetup_PatternSequenceType(GoSetup setup, GoRole role);
2404
2405 /**
2406 * Sets the pattern sequence type.
2407 *
2408 * @public @memberof GoSetup
2409 * @version Introduced in firmware 4.2.4.7
2410 * @param setup GoSetup object.
2411 * @param role Determines which sensor to apply changes to.
2412 * @param type The pattern sequence type to set.
2413 * @return Operation status.
2414 */
2415 GoFx(kStatus) GoSetup_SetPatternSequenceType(GoSetup setup, GoRole role, GoPatternSequenceType type);
2416
2417 /**
2418 * Returns a boolean value representing whether the pattern sequence type is used.
2419 *
2420 * @public @memberof GoSetup
2421 * @version Introduced in firmware 4.2.4.7
2422 * @param setup GoSetup object.
2423 * @param role Determines which device to retrieve the value from.
2424 * @return kTRUE if used and kFALSE otherwise.
2425 */
2426 GoFx(kBool) GoSetup_PatternSequenceTypeUsed(GoSetup setup, GoRole role);
2427
2428 /**
2429 * Gets the current pattern sequence count.
2430 *
2431 * @public @memberof GoSetup
2432 * @version Introduced in firmware 4.2.4.7
2433 * @param setup GoSetup object.
2434 * @param role Determines which device to retrieve the value from.
2435 * @return The current pattern sequence count.
2436 */
2437 GoFx(kSize) GoSetup_PatternSequenceCount(GoSetup setup, GoRole role);
2438
2439
2440 /**
2441 * Gets the layout configuration module.
2442 *
2443 * @public @memberof GoSetup
2444 * @version Introduced in firmware 4.0.10.27
2445 * @param setup GoSetup object.
2446 * @return Layout configuration module.
2447 */
2448 GoFx(GoLayout) GoSetup_Layout(GoSetup setup);
2449
2450 /**
2451 * Gets the profile generation module, used for profile generation configuration.
2452 *
2453 * @public @memberof GoSetup
2454 * @version Introduced in firmware 4.2.4.7
2455 * @param setup GoSetup object.
2456 * @return Profile generation configuration module.
2457 */
2458 GoFx(GoProfileGeneration) GoSetup_ProfileGeneration(GoSetup setup);
2459
2460 /**
2461 * Gets the surface generation module, used for surface generation configuration.
2462 *
2463 * @public @memberof GoSetup
2464 * @version Introduced in firmware 4.0.10.27
2465 * @param setup GoSetup object.
2466 * @return Surface generation configuration module.
2467 */
2468 GoFx(GoSurfaceGeneration) GoSetup_SurfaceGeneration(GoSetup setup);
2469
2470 /**
2471 * Gets the part detection module, used for part detection configuration.
2472 *
2473 * @public @memberof GoSetup
2474 * @version Introduced in firmware 4.0.10.27
2475 * @param setup GoSetup object.
2476 * @return Part detection configuration module.
2477 */
2478 GoFx(GoPartDetection) GoSetup_PartDetection(GoSetup setup);
2479
2480 /**
2481 * Gets the part matching module, used for part matching configuration.
2482 *
2483 * @public @memberof GoSetup
2484 * @version Introduced in firmware 4.2.4.7
2485 * @param setup GoSetup object.
2486 * @return Part matching configuration module.
2487 */
2488 GoFx(GoPartMatching) GoSetup_PartMatching(GoSetup setup);
2489
2490 /**
2491 * Gets the material acquisition module, used for material acquisition configuration.
2492 *
2493 * @public @memberof GoSetup
2494 * @version Introduced in firmware 4.1.3.106
2495 * @param setup GoSetup object.
2496 * @param role The device role whose material settings object to return.
2497 * @return Material acquisition configuration module.
2498 */
2499 GoFx(GoMaterial) GoSetup_Material(GoSetup setup, GoRole role);
2500
2501 /**
2502 * Gets the Section configuration module, used for surface sections.
2503 *
2504 * @public @memberof GoSetup
2505 * @version Introduced in firmware 4.4.4.14
2506 * @param setup GoSetup object.
2507 * @return Section configuration module.
2508 */
2509 GoFx(GoSections) GoSetup_Sections(GoSetup setup);
2510
2511 kEndHeader()
2512 #include <GoSdk/GoSetup.x.h>
2513
2514 #endif
GoSetup::GoSetup_InputTriggerEnabledSystemValue
kBool GoSetup_InputTriggerEnabledSystemValue(GoSetup setup)
Gets the input trigger 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_SetXDecimationWindow
kStatus GoSetup_SetXDecimationWindow(GoSetup setup, k64f window)
Sets the x-direction decimation window.
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_XGapFillingWindowLimitMax
k64f GoSetup_XGapFillingWindowLimitMax(GoSetup setup)
Gets the x-direction gap-filling window maximum.
GoSetup::GoSetup_ActiveAreaXLimitMax
k64f GoSetup_ActiveAreaXLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaX setting.
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_YMedianWindowLimitMin
k64f GoSetup_YMedianWindowLimitMin(GoSetup setup)
Gets the y-direction median window minimum.
GoSetup::GoSetup_ActiveAreaWidthLimitMax
k64f GoSetup_ActiveAreaWidthLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaWidth setting.
GoSetup::GoSetup_Exposure
k64f GoSetup_Exposure(GoSetup setup, GoRole role)
Gets the exposure value.
GoSetup::GoSetup_XMedianWindow
k64f GoSetup_XMedianWindow(GoSetup setup)
Gets the x-direction median window.
GoSetup::GoSetup_XGapFillingWindow
k64f GoSetup_XGapFillingWindow(GoSetup setup)
Gets the x-direction gap-filling window.
GoSetup::GoSetup_YGapFillingEnabled
kBool GoSetup_YGapFillingEnabled(GoSetup setup)
Gets the status of y-direction gap-filling.
GoSetup::GoSetup_XGapFillingEnabled
kBool GoSetup_XGapFillingEnabled(GoSetup setup)
Gets the status of x-direction gap-filling.
GoSetup::GoSetup_EnableYMedian
kStatus GoSetup_EnableYMedian(GoSetup setup, kBool enable)
Sets the status of y-direction median.
GoSetup::GoSetup_ActiveAreaY
k64f GoSetup_ActiveAreaY(GoSetup setup, GoRole role)
Gets the active area Y.
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_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_SetActiveAreaWidth
kStatus GoSetup_SetActiveAreaWidth(GoSetup setup, GoRole role, k64f value)
Sets the active area width.
GoSections.h
Declares the GoSections class.
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_TransformedDataRegionX
k64f GoSetup_TransformedDataRegionX(GoSetup setup, GoRole role)
Gets the transformed data region X value.
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_XDecimationEnabled
kBool GoSetup_XDecimationEnabled(GoSetup setup)
Gets the status of x-direction decimation.
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_YSmoothingWindow
k64f GoSetup_YSmoothingWindow(GoSetup setup)
Gets the y-direction smoothing window.
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_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_SetExposureMode
kStatus GoSetup_SetExposureMode(GoSetup setup, GoRole role, GoExposureMode mode)
Sets the exposure mode.
GoSetup::GoSetup_XSmoothingWindowLimitMin
k64f GoSetup_XSmoothingWindowLimitMin(GoSetup setup)
Gets the x-direction smoothing window minimum.
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_ZSubsamplingOptionCount
kSize GoSetup_ZSubsamplingOptionCount(GoSetup setup, GoRole role)
Gets the count of valid z-resolution options.
GoRole
Represents a user role.
kSize
GoSetup::GoSetup_SetSpacingIntervalType
kStatus GoSetup_SetSpacingIntervalType(GoSetup setup, GoRole role, GoSpacingIntervalType type)
Sets the spacing interval type.
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.
GoSetup::GoSetup_SetYGapFillingWindow
kStatus GoSetup_SetYGapFillingWindow(GoSetup setup, k64f window)
Sets the y-direction gap-filling window.
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_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_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.
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_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_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_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)
Gets the material acquisition module, used for material acquisition configuration.
GoLayout
Represents a layout related sensor configuration.
GoSetup::GoSetup_EnableXSmoothing
kStatus GoSetup_EnableXSmoothing(GoSetup setup, kBool enabled)
Sets the status of x-direction smoothing.
GoSetup::GoSetup_SetBarHeight
kStatus GoSetup_SetBarHeight(GoSetup setup, k64f height)
Sets the height of the bar used for travel calibration.
GoSetup::GoSetup_YMedianWindowLimitMax
k64f GoSetup_YMedianWindowLimitMax(GoSetup setup)
Gets the y-direction median window maximum.
GoSetup::GoSetup_SetActiveAreaY
kStatus GoSetup_SetActiveAreaY(GoSetup setup, GoRole role, k64f value)
Sets the active area Y.
GoSetup::GoSetup_YGapFillingWindow
k64f GoSetup_YGapFillingWindow(GoSetup setup)
Gets the y-direction gap-filling window.
GoSetup::GoSetup_XSmoothingWindow
k64f GoSetup_XSmoothingWindow(GoSetup setup)
Gets the x-direction smoothing window.
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_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_YSmoothingEnabled
kBool GoSetup_YSmoothingEnabled(GoSetup setup)
Gets the status of y-direction smoothing.
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_YMedianWindow
k64f GoSetup_YMedianWindow(GoSetup setup)
Gets the y-direction median window.
GoSetup::GoSetup_YDecimationWindow
k64f GoSetup_YDecimationWindow(GoSetup setup)
Gets the y-direction decimation window.
GoSetup::GoSetup_BarHoleDistance
k64f GoSetup_BarHoleDistance(GoSetup setup)
Gets the distance between holes that are defined on the calibration bar.
GoSetup::GoSetup_YGapFillingWindowLimitMax
k64f GoSetup_YGapFillingWindowLimitMax(GoSetup setup)
Gets the y-direction gap-filling window maximum.
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_XMedianWindowLimitMax
k64f GoSetup_XMedianWindowLimitMax(GoSetup setup)
Gets the x-direction median window maximum.
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.
GoSetup::GoSetup_SetScanMode
kStatus GoSetup_SetScanMode(GoSetup setup, GoMode mode)
Sets the default operation mode of the sensor system.
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_XSmoothingWindowLimitMax
k64f GoSetup_XSmoothingWindowLimitMax(GoSetup setup)
Gets the x-direction smoothing window maximum.
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_YMedianEnabled
kBool GoSetup_YMedianEnabled(GoSetup setup)
Gets the status of y-direction median.
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_EnableYSmoothing
kStatus GoSetup_EnableYSmoothing(GoSetup setup, kBool enable)
Sets the status of y-direction smoothing.
GoSetup::GoSetup_ActiveAreaLengthLimitMin
k64f GoSetup_ActiveAreaLengthLimitMin(GoSetup setup, GoRole role)
Gets the minimum valid value for the ActiveAreaLength setting.
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_EnableXDecimation
kStatus GoSetup_EnableXDecimation(GoSetup setup, kBool enabled)
Sets the status of x-direction decimation.
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_YDecimationEnabled
kBool GoSetup_YDecimationEnabled(GoSetup setup)
Gets the status of y-direction decimation.
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_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.
GoSetup::GoSetup_YDecimationWindowLimitMax
k64f GoSetup_YDecimationWindowLimitMax(GoSetup setup)
Gets the y-direction decimation window maximum.
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.
GoSetup::GoSetup_SetActiveAreaZ
kStatus GoSetup_SetActiveAreaZ(GoSetup setup, GoRole role, k64f value)
Sets the active area z origin.
GoAlignmentTarget
Represents a alignment target type.
GoExposureMode
Represents all possible exposure modes.
GoSetup::GoSetup_TriggerSource
GoTrigger GoSetup_TriggerSource(GoSetup setup)
Gets the trigger source for profile triggering.
GoSetup::GoSetup_YSmoothingWindowLimitMax
k64f GoSetup_YSmoothingWindowLimitMax(GoSetup setup)
Gets the y-direction smoothing window maximum.
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_XMedianWindowLimitMin
k64f GoSetup_XMedianWindowLimitMin(GoSetup setup)
Gets the x-direction median window minimum.
GoSetup::GoSetup_PlateHeight
k64f GoSetup_PlateHeight(GoSetup setup)
Gets the height of the plate used for travel calibration.
GoSetup::GoSetup_XGapFillingWindowLimitMin
k64f GoSetup_XGapFillingWindowLimitMin(GoSetup setup)
Gets the x-direction gap-filling window minimum.
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_SetXMedianWindow
kStatus GoSetup_SetXMedianWindow(GoSetup setup, k64f window)
Sets the x-direction median window.
GoSetup::GoSetup_SetPlateHeight
kStatus GoSetup_SetPlateHeight(GoSetup setup, k64f height)
Sets the height of the plate used for travel calibration.
GoSetup::GoSetup_TriggerDelayLimitMax
k64f GoSetup_TriggerDelayLimitMax(GoSetup setup)
Reports the maximum trigger delay, based on current settings.
GoSetup::GoSetup_XSmoothingEnabled
kBool GoSetup_XSmoothingEnabled(GoSetup setup)
Gets the status of x-direction smoothing.
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_SetBarWidth
kStatus GoSetup_SetBarWidth(GoSetup setup, k64f width)
Sets the width of the bar used for travel calibration.
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_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_EnableYGapFilling
kStatus GoSetup_EnableYGapFilling(GoSetup setup, kBool enable)
Sets the status of y-direction gap-filling.
GoSetup::GoSetup_EncoderSpacing
k64f GoSetup_EncoderSpacing(GoSetup setup)
Gets the current encoder period for encoder-based triggering.
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.
GoSetup::GoSetup_ExposureMode
GoExposureMode GoSetup_ExposureMode(GoSetup setup, GoRole role)
Gets the exposure mode.
GoSetup::GoSetup_SetYSmoothingWindow
kStatus GoSetup_SetYSmoothingWindow(GoSetup setup, k64f window)
Sets the y-direction smoothing window.
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.
kObject
GoMode
Represents a scan mode.
GoSetup::GoSetup_EnableXMedian
kStatus GoSetup_EnableXMedian(GoSetup setup, kBool enabled)
Sets the status of x-direction median.
kStatus
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_ActiveAreaYLimitMax
k64f GoSetup_ActiveAreaYLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the ActiveAreaY setting.
GoSetup::GoSetup_EnableXGapFilling
kStatus GoSetup_EnableXGapFilling(GoSetup setup, kBool enable)
Sets the status of x-direction gap-filling.
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.
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_XDecimationWindow
k64f GoSetup_XDecimationWindow(GoSetup setup)
Gets the x-direction decimation window.
GoSetup::GoSetup_SetXGapFillingWindow
kStatus GoSetup_SetXGapFillingWindow(GoSetup setup, k64f window)
Sets the status of x-direction gap-filling.
GoSetup::GoSetup_ScanMode
GoMode GoSetup_ScanMode(GoSetup setup)
Gets the default operation mode of the sensor system.
GoSetup::GoSetup_XDecimationWindowLimitMax
k64f GoSetup_XDecimationWindowLimitMax(GoSetup setup)
Gets the x-direction decimation window maximum.
GoSetup::GoSetup_ExposureLimitMax
k64f GoSetup_ExposureLimitMax(GoSetup setup, GoRole role)
Gets the maximum valid value for the Exposure setting.
GoSetup::GoSetup_XMedianEnabled
kBool GoSetup_XMedianEnabled(GoSetup setup)
Gets the status of x-direction median.
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_SetXSmoothingWindow
kStatus GoSetup_SetXSmoothingWindow(GoSetup setup, k64f window)
Sets the x-direction smoothing window.
GoSetup::GoSetup_XSubsampling
k32u GoSetup_XSubsampling(GoSetup setup, GoRole role)
Gets the current x-resolution divider.
GoSetup::GoSetup_SetTriggerUnit
kStatus GoSetup_SetTriggerUnit(GoSetup setup, GoTriggerUnits unit)
Sets the system trigger units.
GoSetup::GoSetup_YGapFillingWindowLimitMin
k64f GoSetup_YGapFillingWindowLimitMin(GoSetup setup)
Gets the y-direction gap-filling window minimum.
GoSetup::GoSetup_YDecimationWindowLimitMin
k64f GoSetup_YDecimationWindowLimitMin(GoSetup setup)
Gets the y-direction decimation window minimum.
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.
GoPartMatching.h
Declares the GoPartMatching class.
GoSetup::GoSetup_SetYMedianWindow
kStatus GoSetup_SetYMedianWindow(GoSetup setup, k64f window)
Sets the y-direction median window.
GoSetup::GoSetup_EnableYDecimation
kStatus GoSetup_EnableYDecimation(GoSetup setup, kBool enable)
Sets the status of y-direction decimation.
GoSetup::GoSetup_AlignmentTypeOptionAt
GoAlignmentType GoSetup_AlignmentTypeOptionAt(GoSetup setup, kSize index)
Gets the alignment type option at the given index.
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.
GoSetup::GoSetup_YSmoothingWindowLimitMin
k64f GoSetup_YSmoothingWindowLimitMin(GoSetup setup)
Gets the y-direction smoothing window minimum.
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_SetYDecimationWindow
kStatus GoSetup_SetYDecimationWindow(GoSetup setup, k64f window)
Sets the y-direction decimation window.
GoSetup::GoSetup_ActiveAreaLength
k64f GoSetup_ActiveAreaLength(GoSetup setup, GoRole role)
Gets the active area Length.
GoSetup::GoSetup_XDecimationWindowLimitMin
k64f GoSetup_XDecimationWindowLimitMin(GoSetup setup)
Gets the x-direction decimation window minimum.
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_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.