Gocator API

- Home
- Types
- Files

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