Gocator API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoPartDetection.h
Go to the documentation of this file.
1 /**
2 * @file GoPartDetection.h
3 * @brief Declares the GoPartDetection class.
4 *
5 * @internal
6 * Copyright (C) 2016-2022 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_PART_DETECTION_H
11 #define GO_PART_DETECTION_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 /**
16 * @class GoPartDetection
17 * @extends kObject
18 * @note Supported with G2, G3
19 * @ingroup GoSdk-Surface
20 * @brief Represents the part detection parameters of the surface mode configuration.
21 */
22 typedef kObject GoPartDetection;
23
24 /**
25 * Enables part detection.
26 *
27 * @public @memberof GoPartDetection
28 * @note Supported with G2, G3
29 * @version Introduced in firmware 4.0.10.27
30 * @param detection GoPartDetection object.
31 * @param enable kTRUE to enable, or kFALSE to disable.
32 * @return Operation status.
33 */
34 GoFx(kStatus) GoPartDetection_EnablePartDetection(GoPartDetection detection, kBool enable);
35
36 /**
37 * Gets the current state of part detection.
38 *
39 * @public @memberof GoPartDetection
40 * @note Supported with G2, G3
41 * @version Introduced in firmware 4.0.10.27
42 * @param detection GoPartDetection object.
43 * @return kTRUE if enabled and kFALSE if disabled.
44 */
45 GoFx(kBool) GoPartDetection_PartDetectionEnabled(GoPartDetection detection);
46
47 /**
48 * Returns the state of whether or not the user specified part detection value is used.
49 *
50 * @public @memberof GoPartDetection
51 * @note Supported with G2, G3
52 * @version Introduced in firmware 4.0.10.27
53 * @param detection GoPartDetection object.
54 * @return kTRUE if used and kFALSE if not.
55 */
56 GoFx(kBool) GoPartDetection_EnablePartDetectionUsed(GoPartDetection detection);
57
58 /**
59 * Gets the current part detection system state.
60 *
61 * @public @memberof GoPartDetection
62 * @note Supported with G2, G3
63 * @version Introduced in firmware 4.0.10.27
64 * @param detection GoPartDetection object.
65 * @return kTRUE if enabled and kFALSE if disabled.
66 */
67 GoFx(kBool) GoPartDetection_PartDetectionEnabledSystemValue(GoPartDetection detection);
68
69 /**
70 * Gets the part detection minimum threshold value.
71 *
72 * @public @memberof GoPartDetection
73 * @note Supported with G2, G3
74 * @version Introduced in firmware 4.0.10.27
75 * @param detection GoPartDetection object.
76 * @return Part detection minimum threshold value.(mm)
77 */
78 GoFx(k64f) GoPartDetection_ThresholdLimitMin(GoPartDetection detection);
79
80 /**
81 * Gets the part detection maximum threshold value.
82 *
83 * @public @memberof GoPartDetection
84 * @note Supported with G2, G3
85 * @version Introduced in firmware 4.0.10.27
86 * @param detection GoPartDetection object.
87 * @return Part detection maximum threshold value.(mm)
88 */
89 GoFx(k64f) GoPartDetection_ThresholdLimitMax(GoPartDetection detection);
90
91 /**
92 * Sets the part detection height threshold.
93 *
94 * @public @memberof GoPartDetection
95 * @note Supported with G2, G3
96 * @version Introduced in firmware 4.0.10.27
97 * @param detection GoPartDetection object.
98 * @param height The part detection height threshold value to set.(mm)
99 * @return Operation status.
100 */
101 GoFx(kStatus) GoPartDetection_SetThreshold(GoPartDetection detection, k64f height);
102
103 /**
104 * Gets the part detection threshold value.
105 *
106 * @public @memberof GoPartDetection
107 * @note Supported with G2, G3
108 * @version Introduced in firmware 4.0.10.27
109 * @param detection GoPartDetection object.
110 * @return Part detection threshold value.(mm)
111 */
112 GoFx(k64f) GoPartDetection_Threshold(GoPartDetection detection);
113
114 /**
115 * Sets the part detection height threshold direction.
116 *
117 * @public @memberof GoPartDetection
118 * @note Supported with G2, G3
119 * @version Introduced in firmware 4.0.10.27
120 * @param detection GoPartDetection object.
121 * @param direction The part detection height threshold direction value to set.
122 * @return Operation status.
123 */
124 GoFx(kStatus) GoPartDetection_SetThresholdDirection(GoPartDetection detection, GoPartHeightThresholdDirection direction);
125
126 /**
127 * Gets the part detection threshold direction.
128 *
129 * @public @memberof GoPartDetection
130 * @note Supported with G2, G3
131 * @version Introduced in firmware 4.0.10.27
132 * @param detection GoPartDetection object.
133 * @return Part detection threshold direction.
134 */
135 GoFx(GoPartHeightThresholdDirection) GoPartDetection_ThresholdDirection(GoPartDetection detection);
136
137 /**
138 * Sets the part detection flag for including one sided data when in opposite layout.
139 *
140 * @public @memberof GoPartDetection
141 * @note Supported with G2, G3
142 * @version Introduced in firmware 5.3.19.x
143 * @param detection GoPartDetection object.
144 * @param includeFlag The value of the flag to set.
145 * @return Operation status.
146 */
147 GoFx(kStatus) GoPartDetection_SetIncludeSinglePoints(GoPartDetection detection, kBool includeFlag);
148
149 /**
150 * Gets the part detection flag value for including one sided data when in opposite layout.
151 *
152 * @public @memberof GoPartDetection
153 * @note Supported with G2, G3
154 * @version Introduced in firmware 5.3.19.x
155 * @param detection GoPartDetection object.
156 * @return Part detection flag state.
157 */
158 GoFx(kBool) GoPartDetection_IncludeSinglePoints(GoPartDetection detection);
159
160 /**
161 * Gets the part detection used flag value for including one sided data when in opposite layout.
162 *
163 * @public @memberof GoPartDetection
164 * @note Supported with G2, G3
165 * @version Introduced in firmware 5.3.19.x
166 * @param detection GoPartDetection object.
167 * @return kTRUE if used and kFALSE if not.
168 */
169 GoFx(kBool) GoPartDetection_IncludeSinglePointsUsed(GoPartDetection detection);
170 /**
171 * Sets the part detection frame of reference.
172 *
173 * @public @memberof GoPartDetection
174 * @note Supported with G2, G3
175 * @version Introduced in firmware 4.0.10.27
176 * @param detection GoPartDetection object.
177 * @param frameOfRef The part detection frame of reference value to set.
178 * @return Operation status.
179 */
180 GoFx(kStatus) GoPartDetection_SetFrameOfReference(GoPartDetection detection, GoPartFrameOfReference frameOfRef);
181
182 /**
183 * Gets the part detection frame of reference.
184 *
185 * @public @memberof GoPartDetection
186 * @note Supported with G2, G3
187 * @version Introduced in firmware 4.0.10.27
188 * @param detection GoPartDetection object.
189 * @return Part detection frame of reference.
190 */
191 GoFx(GoPartFrameOfReference) GoPartDetection_FrameOfReference(GoPartDetection detection);
192
193 /**
194 * Returns the state of whether or not the user specified frame of reference value is used.
195 *
196 * @public @memberof GoPartDetection
197 * @note Supported with G2, G3
198 * @version Introduced in firmware 4.2.4.7
199 * @param detection GoPartDetection object.
200 * @return kTRUE if used and kFALSE if not.
201 */
202 GoFx(kBool) GoPartDetection_FrameOfReferenceUsed(GoPartDetection detection);
203
204 /**
205 * Gets the part detection gap width minimum limit value.
206 *
207 * @public @memberof GoPartDetection
208 * @note Supported with G2, G3
209 * @version Introduced in firmware 4.0.10.27
210 * @param detection GoPartDetection object.
211 * @return Part detection gap width minimum value.(mm)
212 */
213 GoFx(k64f) GoPartDetection_GapWidthLimitMin(GoPartDetection detection);
214
215 /**
216 * Gets the part detection gap width maximum limit value.
217 *
218 * @public @memberof GoPartDetection
219 * @note Supported with G2, G3
220 * @version Introduced in firmware 4.0.10.27
221 * @param detection GoPartDetection object.
222 * @return Part detection gap width maximum value.(mm)
223 */
224 GoFx(k64f) GoPartDetection_GapWidthLimitMax(GoPartDetection detection);
225
226 /**
227 * Sets the part detection gap width.
228 *
229 * @public @memberof GoPartDetection
230 * @note Supported with G2, G3
231 * @version Introduced in firmware 4.0.10.27
232 * @param detection GoPartDetection object.
233 * @param gap The part detection gap width value to set.(mm)
234 * @return Operation status.
235 */
236 GoFx(kStatus) GoPartDetection_SetGapWidth(GoPartDetection detection, k64f gap);
237
238 /**
239 * Gets the part detection gap width value.
240 *
241 * @public @memberof GoPartDetection
242 * @note Supported with G2, G3
243 * @version Introduced in firmware 4.0.10.27
244 * @param detection GoPartDetection object.
245 * @return Part detection gap width value.(mm)
246 */
247 GoFx(k64f) GoPartDetection_GapWidth(GoPartDetection detection);
248
249 /**
250 * Returns the state of whether or not the user specified gap width value is used.
251 *
252 * @public @memberof GoPartDetection
253 * @note Supported with G2, G3
254 * @version Introduced in firmware 4.2.4.7
255 * @param detection GoPartDetection object.
256 * @return kTRUE if used and kFALSE if not.
257 */
258 GoFx(kBool) GoPartDetection_GapWidthUsed(GoPartDetection detection);
259
260 /**
261 * Gets the part detection gap width minimum limit value.
262 *
263 * @public @memberof GoPartDetection
264 * @note Supported with G2, G3
265 * @version Introduced in firmware 4.0.10.27
266 * @param detection GoPartDetection object.
267 * @return Part detection gap width minimum value.(mm)
268 */
269 GoFx(k64f) GoPartDetection_GapLengthLimitMin(GoPartDetection detection);
270
271 /**
272 * Gets the part detection gap length maximum limit value.
273 *
274 * @public @memberof GoPartDetection
275 * @note Supported with G2, G3
276 * @version Introduced in firmware 4.0.10.27
277 * @param detection GoPartDetection object.
278 * @return Part detection gap length maximum value.(mm)
279 */
280 GoFx(k64f) GoPartDetection_GapLengthLimitMax(GoPartDetection detection);
281
282 /**
283 * Sets the part detection gap length.
284 *
285 * @public @memberof GoPartDetection
286 * @note Supported with G2, G3
287 * @version Introduced in firmware 4.0.10.27
288 * @param detection GoPartDetection object.
289 * @param gap The part detection gap length value to set.(mm)
290 * @return Operation status.
291 */
292 GoFx(kStatus) GoPartDetection_SetGapLength(GoPartDetection detection, k64f gap);
293
294 /**
295 * Gets the part detection gap length value.
296 *
297 * @public @memberof GoPartDetection
298 * @note Supported with G2, G3
299 * @version Introduced in firmware 4.0.10.27
300 * @param detection GoPartDetection object.
301 * @return Part detection gap length value.(mm)
302 */
303 GoFx(k64f) GoPartDetection_GapLength(GoPartDetection detection);
304
305 /**
306 * Returns the state of whether or not the user specified gap length value is used.
307 *
308 * @public @memberof GoPartDetection
309 * @note Supported with G2, G3
310 * @version Introduced in firmware 4.2.4.7
311 * @param detection GoPartDetection object.
312 * @return kTRUE if used and kFALSE if not.
313 */
314 GoFx(kBool) GoPartDetection_GapLengthUsed(GoPartDetection detection);
315
316 /**
317 * Gets the part detection padding width minimum limit value.
318 *
319 * @public @memberof GoPartDetection
320 * @note Supported with G2, G3
321 * @version Introduced in firmware 4.0.10.27
322 * @param detection GoPartDetection object.
323 * @return Part detection padding width minimum value.(mm)
324 */
325 GoFx(k64f) GoPartDetection_PaddingWidthLimitMin(GoPartDetection detection);
326
327 /**
328 * Gets the part detection padding width maximum limit value.
329 *
330 * @public @memberof GoPartDetection
331 * @note Supported with G2, G3
332 * @version Introduced in firmware 4.0.10.27
333 * @param detection GoPartDetection object.
334 * @return Part detection padding width maximum value.(mm)
335 */
336 GoFx(k64f) GoPartDetection_PaddingWidthLimitMax(GoPartDetection detection);
337
338 /**
339 * Sets the part detection padding width.
340 *
341 * @public @memberof GoPartDetection
342 * @note Supported with G2, G3
343 * @version Introduced in firmware 4.0.10.27
344 * @param detection GoPartDetection object.
345 * @param padding The part detection padding width value to set.(mm)
346 * @return Operation status.
347 */
348 GoFx(kStatus) GoPartDetection_SetPaddingWidth(GoPartDetection detection, k64f padding);
349
350 /**
351 * Gets the part detection padding width value.
352 *
353 * @public @memberof GoPartDetection
354 * @note Supported with G2, G3
355 * @version Introduced in firmware 4.0.10.27
356 * @param detection GoPartDetection object.
357 * @return Part detection padding width value.(mm)
358 */
359 GoFx(k64f) GoPartDetection_PaddingWidth(GoPartDetection detection);
360
361 /**
362 * Returns the state of whether or not the user specified padding width value is used.
363 *
364 * @public @memberof GoPartDetection
365 * @note Supported with G2, G3
366 * @version Introduced in firmware 4.2.4.7
367 * @param detection GoPartDetection object.
368 * @return kTRUE if used and kFALSE if not.
369 */
370 GoFx(kBool) GoPartDetection_PaddingWidthUsed(GoPartDetection detection);
371
372 /**
373 * Gets the part detection padding length minimum limit value.
374 *
375 * @public @memberof GoPartDetection
376 * @note Supported with G2, G3
377 * @version Introduced in firmware 4.0.10.27
378 * @param detection GoPartDetection object.
379 * @return Part detection padding length minimum value.(mm)
380 */
381 GoFx(k64f) GoPartDetection_PaddingLengthLimitMin(GoPartDetection detection);
382
383 /**
384 * Gets the part detection padding length maximum limit value.
385 *
386 * @public @memberof GoPartDetection
387 * @note Supported with G2, G3
388 * @version Introduced in firmware 4.0.10.27
389 * @param detection GoPartDetection object.
390 * @return Part detection padding length maximum value.(mm)
391 */
392 GoFx(k64f) GoPartDetection_PaddingLengthLimitMax(GoPartDetection detection);
393
394 /**
395 * Sets the part detection padding length.
396 *
397 * @public @memberof GoPartDetection
398 * @note Supported with G2, G3
399 * @version Introduced in firmware 4.0.10.27
400 * @param detection GoPartDetection object.
401 * @param padding The part detection padding length value to set.(mm)
402 * @return Operation status.
403 */
404 GoFx(kStatus) GoPartDetection_SetPaddingLength(GoPartDetection detection, k64f padding);
405
406 /**
407 * Gets the part detection padding length value.
408 *
409 * @public @memberof GoPartDetection
410 * @note Supported with G2, G3
411 * @version Introduced in firmware 4.0.10.27
412 * @param detection GoPartDetection object.
413 * @return Part detection padding length value.(mm)
414 */
415 GoFx(k64f) GoPartDetection_PaddingLength(GoPartDetection detection);
416
417 /**
418 * Returns the state of whether or not the user specified padding length value is used.
419 *
420 * @public @memberof GoPartDetection
421 * @note Supported with G2, G3
422 * @version Introduced in firmware 4.2.4.7
423 * @param detection GoPartDetection object.
424 * @return kTRUE if used and kFALSE if not.
425 */
426 GoFx(kBool) GoPartDetection_PaddingLengthUsed(GoPartDetection detection);
427
428 /**
429 * Gets the part detection minimum length range minimum value.
430 *
431 * @public @memberof GoPartDetection
432 * @note Supported with G2, G3
433 * @version Introduced in firmware 4.2.4.7
434 * @param detection GoPartDetection object.
435 * @return Part detection minimum length range minimum value.(mm)
436 */
437 GoFx(k64f) GoPartDetection_MinLengthLimitMin(GoPartDetection detection);
438
439 /**
440 * Gets the part detection minimum length range maximum value.
441 *
442 * @public @memberof GoPartDetection
443 * @note Supported with G2, G3
444 * @version Introduced in firmware 4.2.4.7
445 * @param detection GoPartDetection object.
446 * @return Part detection minimum length range maximum value.(mm)
447 */
448 GoFx(k64f) GoPartDetection_MinLengthLimitMax(GoPartDetection detection);
449
450 /**
451 * Sets the part detection minimum length.
452 *
453 * @public @memberof GoPartDetection
454 * @note Supported with G2, G3
455 * @version Introduced in firmware 4.2.4.7
456 * @param detection GoPartDetection object.
457 * @param length The part detection minimum length value to set.(mm)
458 * @return Operation status.
459 */
460 GoFx(kStatus) GoPartDetection_SetMinLength(GoPartDetection detection, k64f length);
461
462 /**
463 * Gets the part detection minimum length value.
464 *
465 * @public @memberof GoPartDetection
466 * @note Supported with G2, G3
467 * @version Introduced in firmware 4.2.4.7
468 * @param detection GoPartDetection object.
469 * @return Part detection minimum length value.(mm)
470 */
471 GoFx(k64f) GoPartDetection_MinLength(GoPartDetection detection);
472
473 /**
474 * Returns the state of whether or not the user specified minimum length value is used.
475 *
476 * @public @memberof GoPartDetection
477 * @note Supported with G2, G3
478 * @version Introduced in firmware 4.2.4.7
479 * @param detection GoPartDetection object.
480 * @return kTRUE if used and kFALSE if not.
481 */
482 GoFx(kBool) GoPartDetection_MinLengthUsed(GoPartDetection detection);
483
484 /**
485 * Gets the part detection maximum length range minimum value.
486 *
487 * @public @memberof GoPartDetection
488 * @note Supported with G2, G3
489 * @version Introduced in firmware 4.0.10.27
490 * @param detection GoPartDetection object.
491 * @return Part detection maximum length range minimum value.(mm)
492 */
493 GoFx(k64f) GoPartDetection_MaxLengthLimitMin(GoPartDetection detection);
494
495 /**
496 * Gets the part detection maximum length range maximum value.
497 *
498 * @public @memberof GoPartDetection
499 * @note Supported with G2, G3
500 * @version Introduced in firmware 4.0.10.27
501 * @param detection GoPartDetection object.
502 * @return Part detection maximum length range maximum value.(mm)
503 */
504 GoFx(k64f) GoPartDetection_MaxLengthLimitMax(GoPartDetection detection);
505
506 /**
507 * Sets the part detection maximum length.
508 *
509 * @public @memberof GoPartDetection
510 * @note Supported with G2, G3
511 * @version Introduced in firmware 4.0.10.27
512 * @param detection GoPartDetection object.
513 * @param length The part detection maximum length value to set.(mm)
514 * @return Operation status.
515 */
516 GoFx(kStatus) GoPartDetection_SetMaxLength(GoPartDetection detection, k64f length);
517
518 /**
519 * Gets the part detection max length value.
520 *
521 * @public @memberof GoPartDetection
522 * @note Supported with G2, G3
523 * @version Introduced in firmware 4.0.10.27
524 * @param detection GoPartDetection object.
525 * @return Part detection max length value.(mm)
526 */
527 GoFx(k64f) GoPartDetection_MaxLength(GoPartDetection detection);
528
529 /**
530 * Returns the state of whether or not the user specified maximum length value is used.
531 *
532 * @public @memberof GoPartDetection
533 * @note Supported with G2, G3
534 * @version Introduced in firmware 4.2.4.7
535 * @param detection GoPartDetection object.
536 * @return kTRUE if used and kFALSE if not.
537 */
538 GoFx(kBool) GoPartDetection_MaxLengthUsed(GoPartDetection detection);
539
540 /**
541 * Sets the part detection minimum area.
542 *
543 * @public @memberof GoPartDetection
544 * @note Supported with G2, G3
545 * @version Introduced in firmware 4.0.10.27
546 * @param detection GoPartDetection object.
547 * @param area The part detection minimum area value to set.(mm^2)
548 * @return Operation status.
549 */
550 GoFx(kStatus) GoPartDetection_SetMinArea(GoPartDetection detection, k64f area);
551
552 /**
553 * Gets the part detection minimum area value.
554 *
555 * @public @memberof GoPartDetection
556 * @note Supported with G2, G3
557 * @version Introduced in firmware 4.0.10.27
558 * @param detection GoPartDetection object.
559 * @return Part detection minimum area value.(mm^2)
560 */
561 GoFx(k64f) GoPartDetection_MinArea(GoPartDetection detection);
562
563 /**
564 * Returns the state of whether or not the user specified minimum area value is used.
565 *
566 * @public @memberof GoPartDetection
567 * @note Supported with G2, G3
568 * @version Introduced in firmware 4.2.4.7
569 * @param detection GoPartDetection object.
570 * @return kTRUE if used and kFALSE if not.
571 */
572 GoFx(kBool) GoPartDetection_MinAreaUsed(GoPartDetection detection);
573
574 /**
575 * Gets the part detection minimum area range maximum value.
576 *
577 * @public @memberof GoPartDetection
578 * @note Supported with G2, G3
579 * @version Introduced in firmware 4.0.10.27
580 * @param detection GoPartDetection object.
581 * @return Part detection minimum area range maximum value.(mm^2)
582 */
583 GoFx(k64f) GoPartDetection_MinAreaLimitMin(GoPartDetection detection);
584
585 /**
586 * Gets the part detection maximum area range maximum value.
587 *
588 * @public @memberof GoPartDetection
589 * @note Supported with G2, G3
590 * @version Introduced in firmware 4.0.10.27
591 * @param detection GoPartDetection object.
592 * @return Part detection maximum area range maximum value.(mm^2)
593 */
594 GoFx(k64f) GoPartDetection_MinAreaLimitMax(GoPartDetection detection);
595
596 /**
597 * Returns the state of whether or not the user specified edge filtering configuration is used.
598 *
599 * @public @memberof GoPartDetection
600 * @note Supported with G2, G3
601 * @version Introduced in firmware 4.2.4.7
602 * @param detection GoPartDetection object.
603 * @return kTRUE if used and kFALSE if not.
604 */
605 GoFx(kBool) GoPartDetection_EdgeFilterUsed(GoPartDetection detection);
606
607 /**
608 * Enables or disables edge filtering.
609 *
610 * @public @memberof GoPartDetection
611 * @note Supported with G2, G3
612 * @version Introduced in firmware 4.2.4.7
613 * @param detection GoPartDetection object.
614 * @param enable kTRUE to enable edge filtering and kFALSE to disable it.
615 * @return Operation status.
616 */
617 GoFx(kStatus) GoPartDetection_EnableEdgeFilter(GoPartDetection detection, kBool enable);
618
619 /**
620 * Returns the state of whether or not edge filtering is enabled.
621 *
622 * @public @memberof GoPartDetection
623 * @note Supported with G2, G3
624 * @version Introduced in firmware 4.2.4.7
625 * @param detection GoPartDetection object.
626 * @return kTRUE if enabled and kFALSE if not.
627 */
628 GoFx(kBool) GoPartDetection_EdgeFilterEnabled(GoPartDetection detection);
629
630 /**
631 * Gets the part detection edge filtering width minimum limit value.
632 *
633 * @public @memberof GoPartDetection
634 * @note Supported with G2, G3
635 * @version Introduced in firmware 4.2.4.7
636 * @param detection GoPartDetection object.
637 * @return Part detection edge filtering width minimum value. (mm)
638 */
639 GoFx(k64f) GoPartDetection_EdgeFilterWidthLimitMin(GoPartDetection detection);
640
641 /**
642 * Gets the part detection edge filtering width maximum limit value.
643 *
644 * @public @memberof GoPartDetection
645 * @note Supported with G2, G3
646 * @version Introduced in firmware 4.2.4.7
647 * @param detection GoPartDetection object.
648 * @return Part detection edge filtering width maximum value.(mm)
649 */
650 GoFx(k64f) GoPartDetection_EdgeFilterWidthLimitMax(GoPartDetection detection);
651
652 /**
653 * Sets the part detection edge filtering width.
654 *
655 * @public @memberof GoPartDetection
656 * @note Supported with G2, G3
657 * @version Introduced in firmware 4.2.4.7
658 * @param detection GoPartDetection object.
659 * @param value The part detection edge filtering width value to set.(mm)
660 * @return Operation status.
661 */
662 GoFx(kStatus) GoPartDetection_SetEdgeFilterWidth(GoPartDetection detection, k64f value);
663
664 /**
665 * Gets the part detection edge filtering width value.
666 *
667 * @public @memberof GoPartDetection
668 * @note Supported with G2, G3
669 * @version Introduced in firmware 4.2.4.7
670 * @param detection GoPartDetection object.
671 * @return Part detection edge filtering width value.(mm)
672 */
673 GoFx(k64f) GoPartDetection_EdgeFilterWidth(GoPartDetection detection);
674
675 /**
676 * Gets the part detection edge filtering length minimum limit value.
677 *
678 * @public @memberof GoPartDetection
679 * @note Supported with G2, G3
680 * @version Introduced in firmware 4.2.4.7
681 * @param detection GoPartDetection object.
682 * @return Part detection edge filtering length minimum value.(mm)
683 */
684 GoFx(k64f) GoPartDetection_EdgeFilterLengthLimitMin(GoPartDetection detection);
685
686 /**
687 * Gets the part detection edge filtering length maximum limit value.
688 *
689 * @public @memberof GoPartDetection
690 * @note Supported with G2, G3
691 * @version Introduced in firmware 4.2.4.7
692 * @param detection GoPartDetection object.
693 * @return Part detection edge filtering length maximum value.(mm)
694 */
695 GoFx(k64f) GoPartDetection_EdgeFilterLengthLimitMax(GoPartDetection detection);
696
697 /**
698 * Sets the part detection edge filtering Length.
699 *
700 * @public @memberof GoPartDetection
701 * @note Supported with G2, G3
702 * @version Introduced in firmware 4.2.4.7
703 * @param detection GoPartDetection object.
704 * @param value The part detection edge filtering length value to set.(mm)
705 * @return Operation status.
706 */
707 GoFx(kStatus) GoPartDetection_SetEdgeFilterLength(GoPartDetection detection, k64f value);
708
709 /**
710 * Gets the part detection edge filtering length value.
711 *
712 * @public @memberof GoPartDetection
713 * @note Supported with G2, G3
714 * @version Introduced in firmware 4.2.4.7
715 * @param detection GoPartDetection object.
716 * @return Part detection edge filtering length value.(mm)
717 */
718 GoFx(k64f) GoPartDetection_EdgeFilterLength(GoPartDetection detection);
719
720 /**
721 * Enables or disables the part detection edge filtering anterior preservation.
722 *
723 * @public @memberof GoPartDetection
724 * @note Supported with G2, G3
725 * @version Introduced in firmware 4.2.4.7
726 * @param detection GoPartDetection object.
727 * @param enable The part detection edge anterior preservation value to set.
728 * @return Operation status.
729 */
730 GoFx(kStatus) GoPartDetection_EnableEdgeFilterAnteriorPreservation(GoPartDetection detection, kBool enable);
731
732 /**
733 * Gets the part detection edge filtering anterior preservation value.
734 *
735 * @public @memberof GoPartDetection
736 * @note Supported with G2, G3
737 * @version Introduced in firmware 4.2.4.7
738 * @param detection GoPartDetection object.
739 * @return kTRUE if enabled and kFALSE otherwise.
740 */
741 GoFx(kBool) GoPartDetection_EdgeFilterAnteriorPreservationEnabled(GoPartDetection detection);
742
743 #include <GoSdk/GoPartDetection.x.h>
744
745 #endif
GoPartDetection::GoPartDetection_SetGapLength
kStatus GoPartDetection_SetGapLength(GoPartDetection detection, k64f gap)
Sets the part detection gap length.
GoPartDetection::GoPartDetection_PartDetectionEnabled
kBool GoPartDetection_PartDetectionEnabled(GoPartDetection detection)
Gets the current state of part detection.
GoPartDetection::GoPartDetection_GapLengthLimitMax
k64f GoPartDetection_GapLengthLimitMax(GoPartDetection detection)
Gets the part detection gap length maximum limit value.
GoPartDetection::GoPartDetection_EdgeFilterAnteriorPreservationEnabled
kBool GoPartDetection_EdgeFilterAnteriorPreservationEnabled(GoPartDetection detection)
Gets the part detection edge filtering anterior preservation value.
GoPartDetection::GoPartDetection_GapLengthUsed
kBool GoPartDetection_GapLengthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified gap length value is used.
GoPartDetection::GoPartDetection_PaddingWidthLimitMax
k64f GoPartDetection_PaddingWidthLimitMax(GoPartDetection detection)
Gets the part detection padding width maximum limit value.
GoPartDetection::GoPartDetection_MaxLengthLimitMax
k64f GoPartDetection_MaxLengthLimitMax(GoPartDetection detection)
Gets the part detection maximum length range maximum value.
GoPartDetection::GoPartDetection_PaddingLengthLimitMax
k64f GoPartDetection_PaddingLengthLimitMax(GoPartDetection detection)
Gets the part detection padding length maximum limit value.
GoPartDetection::GoPartDetection_EdgeFilterWidth
k64f GoPartDetection_EdgeFilterWidth(GoPartDetection detection)
Gets the part detection edge filtering width value.
GoPartDetection::GoPartDetection_Threshold
k64f GoPartDetection_Threshold(GoPartDetection detection)
Gets the part detection threshold value.
GoPartDetection::GoPartDetection_SetThresholdDirection
kStatus GoPartDetection_SetThresholdDirection(GoPartDetection detection, GoPartHeightThresholdDirection direction)
Sets the part detection height threshold direction.
GoPartDetection::GoPartDetection_EdgeFilterLengthLimitMax
k64f GoPartDetection_EdgeFilterLengthLimitMax(GoPartDetection detection)
Gets the part detection edge filtering length maximum limit value.
GoPartDetection::GoPartDetection_MinLength
k64f GoPartDetection_MinLength(GoPartDetection detection)
Gets the part detection minimum length value.
GoPartDetection::GoPartDetection_PaddingWidthUsed
kBool GoPartDetection_PaddingWidthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified padding width value is used.
GoPartDetection::GoPartDetection_EdgeFilterWidthLimitMin
k64f GoPartDetection_EdgeFilterWidthLimitMin(GoPartDetection detection)
Gets the part detection edge filtering width minimum limit value.
GoPartDetection::GoPartDetection_SetFrameOfReference
kStatus GoPartDetection_SetFrameOfReference(GoPartDetection detection, GoPartFrameOfReference frameOfRef)
Sets the part detection frame of reference.
GoPartDetection::GoPartDetection_ThresholdLimitMax
k64f GoPartDetection_ThresholdLimitMax(GoPartDetection detection)
Gets the part detection maximum threshold value.
GoPartDetection::GoPartDetection_EnableEdgeFilterAnteriorPreservation
kStatus GoPartDetection_EnableEdgeFilterAnteriorPreservation(GoPartDetection detection, kBool enable)
Enables or disables the part detection edge filtering anterior preservation.
GoPartDetection::GoPartDetection_MaxLengthUsed
kBool GoPartDetection_MaxLengthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified maximum length value is used.
GoPartDetection::GoPartDetection_EdgeFilterLength
k64f GoPartDetection_EdgeFilterLength(GoPartDetection detection)
Gets the part detection edge filtering length value.
GoPartDetection::GoPartDetection_MinAreaLimitMin
k64f GoPartDetection_MinAreaLimitMin(GoPartDetection detection)
Gets the part detection minimum area range maximum value.
GoPartDetection::GoPartDetection_EdgeFilterWidthLimitMax
k64f GoPartDetection_EdgeFilterWidthLimitMax(GoPartDetection detection)
Gets the part detection edge filtering width maximum limit value.
GoPartDetection::GoPartDetection_EdgeFilterUsed
kBool GoPartDetection_EdgeFilterUsed(GoPartDetection detection)
Returns the state of whether or not the user specified edge filtering configuration is used...
GoPartDetection::GoPartDetection_GapWidth
k64f GoPartDetection_GapWidth(GoPartDetection detection)
Gets the part detection gap width value.
GoPartDetection::GoPartDetection_MinLengthLimitMax
k64f GoPartDetection_MinLengthLimitMax(GoPartDetection detection)
Gets the part detection minimum length range maximum value.
GoPartDetection::GoPartDetection_PaddingLength
k64f GoPartDetection_PaddingLength(GoPartDetection detection)
Gets the part detection padding length value.
GoPartDetection::GoPartDetection_ThresholdLimitMin
k64f GoPartDetection_ThresholdLimitMin(GoPartDetection detection)
Gets the part detection minimum threshold value.
GoPartFrameOfReference
Represents a part detection frame of reference.
GoPartDetection::GoPartDetection_GapWidthLimitMax
k64f GoPartDetection_GapWidthLimitMax(GoPartDetection detection)
Gets the part detection gap width maximum limit value.
GoPartDetection::GoPartDetection_EdgeFilterEnabled
kBool GoPartDetection_EdgeFilterEnabled(GoPartDetection detection)
Returns the state of whether or not edge filtering is enabled.
GoPartDetection::GoPartDetection_IncludeSinglePoints
kBool GoPartDetection_IncludeSinglePoints(GoPartDetection detection)
Gets the part detection flag value for including one sided data when in opposite layout.
GoPartDetection::GoPartDetection_SetIncludeSinglePoints
kStatus GoPartDetection_SetIncludeSinglePoints(GoPartDetection detection, kBool includeFlag)
Sets the part detection flag for including one sided data when in opposite layout.
GoPartDetection::GoPartDetection_MinAreaLimitMax
k64f GoPartDetection_MinAreaLimitMax(GoPartDetection detection)
Gets the part detection maximum area range maximum value.
GoPartDetection::GoPartDetection_IncludeSinglePointsUsed
kBool GoPartDetection_IncludeSinglePointsUsed(GoPartDetection detection)
Gets the part detection used flag value for including one sided data when in opposite layout...
GoPartDetection::GoPartDetection_GapWidthUsed
kBool GoPartDetection_GapWidthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified gap width value is used.
GoPartDetection::GoPartDetection_MinLengthLimitMin
k64f GoPartDetection_MinLengthLimitMin(GoPartDetection detection)
Gets the part detection minimum length range minimum value.
GoPartDetection::GoPartDetection_EdgeFilterLengthLimitMin
k64f GoPartDetection_EdgeFilterLengthLimitMin(GoPartDetection detection)
Gets the part detection edge filtering length minimum limit value.
GoPartDetection::GoPartDetection_SetMinLength
kStatus GoPartDetection_SetMinLength(GoPartDetection detection, k64f length)
Sets the part detection minimum length.
GoPartDetection::GoPartDetection_GapWidthLimitMin
k64f GoPartDetection_GapWidthLimitMin(GoPartDetection detection)
Gets the part detection gap width minimum limit value.
GoSdkDef.h
Essential SDK declarations.
GoPartDetection::GoPartDetection_PartDetectionEnabledSystemValue
kBool GoPartDetection_PartDetectionEnabledSystemValue(GoPartDetection detection)
Gets the current part detection system state.
GoPartDetection::GoPartDetection_FrameOfReferenceUsed
kBool GoPartDetection_FrameOfReferenceUsed(GoPartDetection detection)
Returns the state of whether or not the user specified frame of reference value is used...
GoPartDetection::GoPartDetection_ThresholdDirection
GoPartHeightThresholdDirection GoPartDetection_ThresholdDirection(GoPartDetection detection)
Gets the part detection threshold direction.
GoPartDetection::GoPartDetection_SetMaxLength
kStatus GoPartDetection_SetMaxLength(GoPartDetection detection, k64f length)
Sets the part detection maximum length.
GoPartDetection::GoPartDetection_GapLengthLimitMin
k64f GoPartDetection_GapLengthLimitMin(GoPartDetection detection)
Gets the part detection gap width minimum limit value.
GoPartDetection::GoPartDetection_PaddingWidthLimitMin
k64f GoPartDetection_PaddingWidthLimitMin(GoPartDetection detection)
Gets the part detection padding width minimum limit value.
GoPartDetection
Represents the part detection parameters of the surface mode configuration.
GoPartDetection::GoPartDetection_EnablePartDetectionUsed
kBool GoPartDetection_EnablePartDetectionUsed(GoPartDetection detection)
Returns the state of whether or not the user specified part detection value is used.
GoPartDetection::GoPartDetection_EnablePartDetection
kStatus GoPartDetection_EnablePartDetection(GoPartDetection detection, kBool enable)
Enables part detection.
GoPartDetection::GoPartDetection_SetEdgeFilterWidth
kStatus GoPartDetection_SetEdgeFilterWidth(GoPartDetection detection, k64f value)
Sets the part detection edge filtering width.
GoPartDetection::GoPartDetection_MaxLengthLimitMin
k64f GoPartDetection_MaxLengthLimitMin(GoPartDetection detection)
Gets the part detection maximum length range minimum value.
GoPartDetection::GoPartDetection_EnableEdgeFilter
kStatus GoPartDetection_EnableEdgeFilter(GoPartDetection detection, kBool enable)
Enables or disables edge filtering.
GoPartDetection::GoPartDetection_SetPaddingWidth
kStatus GoPartDetection_SetPaddingWidth(GoPartDetection detection, k64f padding)
Sets the part detection padding width.
GoPartDetection::GoPartDetection_SetMinArea
kStatus GoPartDetection_SetMinArea(GoPartDetection detection, k64f area)
Sets the part detection minimum area.
GoPartDetection::GoPartDetection_MinArea
k64f GoPartDetection_MinArea(GoPartDetection detection)
Gets the part detection minimum area value.
GoPartDetection::GoPartDetection_PaddingLengthLimitMin
k64f GoPartDetection_PaddingLengthLimitMin(GoPartDetection detection)
Gets the part detection padding length minimum limit value.
GoPartDetection::GoPartDetection_MinAreaUsed
kBool GoPartDetection_MinAreaUsed(GoPartDetection detection)
Returns the state of whether or not the user specified minimum area value is used.
GoPartDetection::GoPartDetection_SetEdgeFilterLength
kStatus GoPartDetection_SetEdgeFilterLength(GoPartDetection detection, k64f value)
Sets the part detection edge filtering Length.
GoPartDetection::GoPartDetection_MaxLength
k64f GoPartDetection_MaxLength(GoPartDetection detection)
Gets the part detection max length value.
kObject
GoPartDetection::GoPartDetection_FrameOfReference
GoPartFrameOfReference GoPartDetection_FrameOfReference(GoPartDetection detection)
Gets the part detection frame of reference.
kStatus
GoPartDetection::GoPartDetection_MinLengthUsed
kBool GoPartDetection_MinLengthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified minimum length value is used.
GoPartDetection::GoPartDetection_PaddingLengthUsed
kBool GoPartDetection_PaddingLengthUsed(GoPartDetection detection)
Returns the state of whether or not the user specified padding length value is used.
GoPartDetection::GoPartDetection_GapLength
k64f GoPartDetection_GapLength(GoPartDetection detection)
Gets the part detection gap length value.
k64f
GoPartDetection::GoPartDetection_PaddingWidth
k64f GoPartDetection_PaddingWidth(GoPartDetection detection)
Gets the part detection padding width value.
GoPartHeightThresholdDirection
Represents a part detection height threshold direction.
kBool
GoPartDetection::GoPartDetection_SetPaddingLength
kStatus GoPartDetection_SetPaddingLength(GoPartDetection detection, k64f padding)
Sets the part detection padding length.
GoPartDetection::GoPartDetection_SetThreshold
kStatus GoPartDetection_SetThreshold(GoPartDetection detection, k64f height)
Sets the part detection height threshold.
GoPartDetection::GoPartDetection_SetGapWidth
kStatus GoPartDetection_SetGapWidth(GoPartDetection detection, k64f gap)
Sets the part detection gap width.