Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoMeasurements.h
Go to the documentation of this file.
1 /**
2 * @file GoMeasurements.h
3 * @brief Declares the GoMeasurement classes.
4 *
5 * @internal
6 * Copyright (C) 2014 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_MEASUREMENTS_H
11 #define GO_SDK_MEASUREMENTS_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoMeasurement.h>
15 kBeginHeader()
16
17 /// @cond Gocator_1x00
18
19 /**
20 * @class GoRangePositionZ
21 * @extends GoMeasurement
22 * @ingroup GoSdk
23 * @brief Represents a position Z measurement of a Range Position tool.
24 */
25 typedef GoMeasurement GoRangePositionZ;
26
27 /**
28 * @class GoRangeThicknessThickness
29 * @extends GoMeasurement
30 * @ingroup GoSdk
31 * @brief Represents a the thickness measurement of a Range Thickness tool.
32 */
33 typedef GoMeasurement GoRangeThicknessThickness;
34
35 /// @endcond
36
37
38 /// @cond Gocator_2x00
39
40 /**
41 * @class GoProfileAreaArea
42 * @extends GoMeasurement
43 * @ingroup GoSdk-ProfileTools
44 * @brief Represents an area measurement for a Profile Area tool.
45 */
46 typedef GoMeasurement GoProfileAreaArea;
47
48 /**
49 * @class GoProfileAreaCentroidX
50 * @extends GoMeasurement
51 * @ingroup GoSdk-ProfileTools
52 * @brief Represents a centroid X measurement for a Profile Area Tool.
53 */
54 typedef GoMeasurement GoProfileAreaCentroidX;
55
56 /**
57 * @class GoProfileAreaCentroidZ
58 * @extends GoMeasurement
59 * @ingroup GoSdk-ProfileTools
60 * @brief Represents a centroid Z measurement for a Profile Area Tool.
61 */
62 typedef GoMeasurement GoProfileAreaCentroidZ;
63
64
65 /**
66 * @class GoProfileCircleX
67 * @extends GoMeasurement
68 * @ingroup GoSdk-ProfileTools
69 * @brief Represents an X value measurement for a Profile Circle Tool.
70 */
71 typedef GoMeasurement GoProfileCircleX;
72
73 /**
74 * @class GoProfileCircleZ
75 * @extends GoMeasurement
76 * @ingroup GoSdk-ProfileTools
77 * @brief Represents a Z value measurement for a Profile Circle Tool.
78 */
79 typedef GoMeasurement GoProfileCircleZ;
80
81
82 /**
83 * @class GoProfileCircleRadius
84 * @extends GoMeasurement
85 * @ingroup GoSdk-ProfileTools
86 * @brief Represents a radius value measurement for a Profile Circle Tool.
87 */
88 typedef GoMeasurement GoProfileCircleRadius;
89
90
91 /**
92 * @class GoProfileDimWidth
93 * @extends GoMeasurement
94 * @ingroup GoSdk-ProfileTools
95 * @brief Represents a width value measurement for a Profile Dimension Tool.
96 */
97 typedef GoMeasurement GoProfileDimWidth;
98
99 /**
100 * Returns a boolean value representing whether an absolute measurement value will be returned.
101 *
102 * @public @memberof GoProfileDimWidth
103 * @param measurement GoProfileDimWidth object.
104 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
105 */
106 GoFx(kBool) GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement);
107
108 /**
109 * Enables or disables an absolute value result for the given measurement.
110 *
111 * @public @memberof GoProfileDimWidth
112 * @param measurement GoProfileDimWidth object.
113 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
114 * @return Operation status.
115 */
116 GoFx(kStatus) GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute);
117
118 /**
119 * @class GoProfileDimHeight
120 * @extends GoMeasurement
121 * @ingroup GoSdk-ProfileTools
122 * @brief Represents a height value measurement for a Profile Dimension Tool.
123 */
124 typedef GoMeasurement GoProfileDimHeight;
125
126 /**
127 * Returns a boolean value representing whether an absolute measurement value will be returned.
128 *
129 * @public @memberof GoProfileDimHeight
130 * @param measurement GoProfileDimHeight object.
131 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
132 */
133 GoFx(kBool) GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement);
134
135 /**
136 * Enables or disables an absolute value result for the given measurement.
137 *
138 * @public @memberof GoProfileDimHeight
139 * @param measurement GoProfileDimHeight object.
140 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
141 * @return Operation status.
142 */
143 GoFx(kStatus) GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute);
144
145 /**
146 * @class GoProfileDimDistance
147 * @extends GoMeasurement
148 * @ingroup GoSdk-ProfileTools
149 * @brief Represents a distance value measurement for a Profile Dimension Tool.
150 */
151 typedef GoMeasurement GoProfileDimDistance;
152
153 /**
154 * @class GoProfileDimCenterX
155 * @extends GoMeasurement
156 * @ingroup GoSdk-ProfileTools
157 * @brief Represents a center X value measurement for a Profile Dimension Tool.
158 */
159 typedef GoMeasurement GoProfileDimCenterX;
160
161 /**
162 * @class GoProfileDimCenterZ
163 * @extends GoMeasurement
164 * @ingroup GoSdk-ProfileTools
165 * @brief Represents a center Z value measurement for a Profile Dimension Tool.
166 */
167 typedef GoMeasurement GoProfileDimCenterZ;
168
169 /**
170 * @class GoProfileIntersectX
171 * @extends GoMeasurement
172 * @ingroup GoSdk-ProfileTools
173 * @brief Represents an intersect X measurement for a Profile Intersect Tool.
174 */
175 typedef GoMeasurement GoProfileIntersectX;
176
177 /**
178 * @class GoProfileIntersectZ
179 * @extends GoMeasurement
180 * @ingroup GoSdk-ProfileTools
181 * @brief Represents an intersect Z measurement for a Profile Intersect Tool.
182 */
183 typedef GoMeasurement GoProfileIntersectZ;
184
185 /**
186 * @class GoProfileIntersectAngle
187 * @extends GoMeasurement
188 * @ingroup GoSdk-ProfileTools
189 * @brief Represents an intersect angle measurement for a Profile Intersect Tool.
190 */
191 typedef GoMeasurement GoProfileIntersectAngle;
192
193 /**
194 * Returns a boolean value representing whether an absolute measurement value will be returned.
195 *
196 * @public @memberof GoProfileIntersectAngle
197 * @param measurement GoProfileIntersectAngle object.
198 * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
199 */
200 GoFx(kBool) GoProfileIntersectAngle_AbsoluteEnabled(GoProfileIntersectAngle measurement);
201
202 /**
203 * Enables or disables an absolute value result for the given measurement.
204 *
205 * @public @memberof GoProfileIntersectAngle
206 * @param measurement GoProfileIntersectAngle object.
207 * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
208 * @return Operation status.
209 */
210 GoFx(kStatus) GoProfileIntersectAngle_EnableAbsolute(GoProfileIntersectAngle measurement, kBool absolute);
211
212 /**
213 * @class GoProfileGrooveX
214 * @extends GoMeasurement
215 * @ingroup GoSdk-ProfileTools
216 * @brief Represents an X value measurement for a Profile Groove Tool.
217 */
218 typedef GoMeasurement GoProfileGrooveX;
219
220 /**
221 * Gets the current groove selection type.
222 *
223 * @public @memberof GoProfileGrooveX
224 * @param measurement GoProfileGrooveX object.
225 * @return The profile groove location.
226 */
227 GoFx(GoProfileGrooveLocation) GoProfileGrooveX_Location(GoProfileGrooveX measurement);
228
229 /**
230 * Sets the groove location.
231 *
232 * @public @memberof GoProfileGrooveX
233 * @param measurement GoProfileGrooveX object.
234 * @param value The groove location value to be set.
235 * @return Operation status.
236 */
237 GoFx(kStatus) GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value);
238
239
240 /**
241 * Gets the current groove selection type.
242 *
243 * @public @memberof GoProfileGrooveX
244 * @param measurement GoProfileGrooveX object.
245 * @return The profile groove selection type.
246 */
247 GoFx(GoProfileGrooveSelectType) GoProfileGrooveX_SelectType(GoProfileGrooveX measurement);
248
249 /**
250 * Sets the groove selection type.
251 *
252 * @public @memberof GoProfileGrooveX
253 * @param measurement GoProfileGrooveX object.
254 * @param selectType The profile groove type.
255 * @return Operation status.
256 */
257 GoFx(kStatus) GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType);
258
259 /**
260 * Gets the current selected groove index.
261 *
262 * @public @memberof GoProfileGrooveX
263 * @param measurement GoProfileGrooveX object.
264 * @return The current groove index.
265 */
266 GoFx(k32u) GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement);
267
268 /**
269 * Sets the selected groove index.
270 *
271 * @public @memberof GoProfileGrooveX
272 * @param measurement GoProfileGrooveX object.
273 * @param selectN The selected groove index.
274 * @return Operation status.
275 */
276 GoFx(kStatus) GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN);
277
278
279
280 /**
281 * @class GoProfileGrooveZ
282 * @extends GoMeasurement
283 * @ingroup GoSdk-ProfileTools
284 * @brief Represents a Z value measurement for a Profile Groove tool.
285 */
286 typedef GoMeasurement GoProfileGrooveZ;
287
288 /**
289 * Gets the current groove location type.
290 *
291 * @public @memberof GoProfileGrooveZ
292 * @param measurement GoProfileGrooveZ object.
293 * @return The profile groove location type.
294 */
295 GoFx(GoProfileGrooveLocation) GoProfileGrooveZ_Location(GoProfileGrooveZ measurement);
296
297 /**
298 * Sets the groove location type.
299 *
300 * @public @memberof GoProfileGrooveZ
301 * @param measurement GoProfileGrooveZ object.
302 * @param location The profile groove location type.
303 * @return Operation status.
304 */
305 GoFx(kStatus) GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location);
306
307 /**
308 * Gets the current groove selection type.
309 *
310 * @public @memberof GoProfileGrooveZ
311 * @param measurement GoProfileGrooveZ object.
312 * @return The profile groove selection type.
313 */
314 GoFx(GoProfileGrooveSelectType) GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement);
315
316 /**
317 * Sets the groove selection type.
318 *
319 * @public @memberof GoProfileGrooveZ
320 * @param measurement GoProfileGrooveZ object.
321 * @param selectType The profile groove selection type.
322 * @return Operation status.
323 */
324 GoFx(kStatus) GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType);
325
326 /**
327 * Gets the current selected groove index.
328 *
329 * @public @memberof GoProfileGrooveZ
330 * @param measurement GoProfileGrooveZ object.
331 * @return The current groove index.
332 */
333 GoFx(k32u) GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement);
334
335 /**
336 * Sets the selected groove index.
337 *
338 * @public @memberof GoProfileGrooveZ
339 * @param measurement GoProfileGrooveZ object.
340 * @param selectN The selected groove index.
341 * @return Operation status.
342 */
343 GoFx(kStatus) GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN);
344
345
346 /**
347 * @class GoProfileGrooveWidth
348 * @extends GoMeasurement
349 * @ingroup GoSdk-ProfileTools
350 * @brief Represents a width measurement for a Profile Groove Tool.
351 */
352 typedef GoMeasurement GoProfileGrooveWidth;
353
354 /**
355 * Gets the current groove selection type.
356 *
357 * @public @memberof GoProfileGrooveWidth
358 * @param measurement GoProfileGrooveWidth object.
359 * @return The profile groove selection type.
360 */
361 GoFx(GoProfileGrooveSelectType) GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement);
362
363 /**
364 * Sets the groove selection type.
365 *
366 * @public @memberof GoProfileGrooveWidth
367 * @param measurement GoProfileGrooveWidth object.
368 * @param selectType The profile groove type.
369 * @return Operation status.
370 */
371 GoFx(kStatus) GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType);
372
373 /**
374 * Gets the current selected groove index.
375 *
376 * @public @memberof GoProfileGrooveWidth
377 * @param measurement GoProfileGrooveWidth object.
378 * @return The current groove index.
379 */
380 GoFx(k32u) GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement);
381
382 /**
383 * Sets the selected groove index.
384 *
385 * @public @memberof GoProfileGrooveWidth
386 * @param measurement GoProfileGrooveWidth object.
387 * @param selectN The selected groove index.
388 * @return Operation status.
389 */
390 GoFx(kStatus) GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN);
391
392
393 /**
394 * @class GoProfileGrooveDepth
395 * @extends GoMeasurement
396 * @ingroup GoSdk-ProfileTools
397 * @brief Represents a depth measurement for a Profile Groove Tool.
398 */
399 typedef GoMeasurement GoProfileGrooveDepth;
400
401 /**
402 * Gets the current groove selection type.
403 *
404 * @public @memberof GoProfileGrooveDepth
405 * @param measurement GoProfileGrooveDepth object.
406 * @return The profile groove selection type.
407 */
408 GoFx(GoProfileGrooveSelectType) GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement);
409
410 /**
411 * Sets the groove selection type.
412 *
413 * @public @memberof GoProfileGrooveDepth
414 * @param measurement GoProfileGrooveDepth object.
415 * @param selectType The profile groove type.
416 * @return Operation status.
417 */
418 GoFx(kStatus) GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType);
419
420 /**
421 * Gets the current selected groove index.
422 *
423 * @public @memberof GoProfileGrooveDepth
424 * @param measurement GoProfileGrooveDepth object.
425 * @return The current groove index.
426 */
427 GoFx(k32u) GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement);
428
429 /**
430 * Sets the selected groove index.
431 *
432 * @public @memberof GoProfileGrooveDepth
433 * @param measurement GoProfileGrooveDepth object.
434 * @param selectN The selected groove index.
435 * @return Operation status.
436 */
437 GoFx(kStatus) GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN);
438
439
440 /**
441 * @class GoProfileLineStdDev
442 * @extends GoMeasurement
443 * @ingroup GoSdk-ProfileTools
444 * @brief Represents a standard deviation measurement for a Profile Line Tool.
445 */
446 typedef GoMeasurement GoProfileLineStdDev;
447
448 /**
449 * @class GoProfileLineMinError
450 * @extends GoMeasurement
451 * @ingroup GoSdk-ProfileTools
452 * @brief Represents a minimum error measurement for a Profile Line Tool.
453 */
454 typedef GoMeasurement GoProfileLineMinError;
455
456 /**
457 * @class GoProfileLineMaxError
458 * @extends GoMeasurement
459 * @ingroup GoSdk-ProfileTools
460 * @brief Represents a maximum error measurement for a Profile Line Tool.
461 */
462 typedef GoMeasurement GoProfileLineMaxError;
463
464 /**
465 * @class GoProfileLinePercentile
466 * @extends GoMeasurement
467 * @ingroup GoSdk-ProfileTools
468 * @brief Represents a percentile measurement for a Profile Line Tool.
469 */
470 typedef GoMeasurement GoProfileLinePercentile;
471
472 /**
473 * Gets the percent threshold.
474 *
475 * @public @memberof GoProfileLinePercentile
476 * @param measurement GoProfileLinePercentile object.
477 * @return The percent threshold.
478 */
479 GoFx(k64f) GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement);
480
481 /**
482 * Sets the percent threshold.
483 *
484 * @public @memberof GoProfileLinePercentile
485 * @param measurement GoProfileLinePercentile object.
486 * @param percent The percent threshold to set.
487 * @return Operation status.
488 */
489 GoFx(kStatus) GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent);
490
491 /**
492 * @class GoProfilePanelGap
493 * @extends GoMeasurement
494 * @ingroup GoSdk-ProfileTools
495 * @brief Represents a gap measurement for a Profile Panel Tool.
496 */
497 typedef GoMeasurement GoProfilePanelGap;
498
499 /**
500 * Gets the gap axis.
501 *
502 * @public @memberof GoProfilePanelGap
503 * @param measurement GoProfilePanelGap object.
504 * @return The gap axis.
505 */
506 GoFx(GoProfileGapAxis) GoProfilePanelGap_Axis(GoProfilePanelGap measurement);
507
508 /**
509 * Sets the gap axis.
510 *
511 * @public @memberof GoProfilePanelGap
512 * @param measurement GoProfilePanelGap object.
513 * @param axis The gap axis value to set.
514 * @return Operation status.
515 */
516 GoFx(kStatus) GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis);
517
518 /**
519 * @class GoProfilePanelFlush
520 * @extends GoMeasurement
521 * @ingroup GoSdk-ProfileTools
522 * @brief Represents a flush measurement for a Profile Panel Tool.
523 */
524 typedef GoMeasurement GoProfilePanelFlush;
525
526 /**
527 * Gets absolute value state.
528 *
529 * @public @memberof GoProfilePanelFlush
530 * @param measurement GoProfilePanelFlush object.
531 * @return kTRUE if absolute value is enabled and kFALSE otherwise.
532 */
533 GoFx(kBool) GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement);
534
535 /**
536 * Enables or disables the absolute value state.
537 *
538 * @public @memberof GoProfilePanelFlush
539 * @param measurement GoProfilePanelFlush object.
540 * @param absolute kTRUE to enable and kFALSE to disable.
541 * @return Operation status.
542 */
543 GoFx(kStatus) GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute);
544
545 /**
546 * @class GoProfilePositionX
547 * @extends GoMeasurement
548 * @ingroup GoSdk-ProfileTools
549 * @brief Represents an X measurement for a Profile Position tool.
550 */
551 typedef GoMeasurement GoProfilePositionX;
552
553 /**
554 * @class GoProfilePositionZ
555 * @extends GoMeasurement
556 * @ingroup GoSdk-ProfileTools
557 * @brief Represents an Z measurement for a Profile Position tool.
558 */
559 typedef GoMeasurement GoProfilePositionZ;
560
561
562 /**
563 * @class GoProfileStripX
564 * @extends GoMeasurement
565 * @ingroup GoSdk-ProfileTools
566 * @brief Represents an X measurement for a Profile Strip Tool.
567 */
568 typedef GoMeasurement GoProfileStripX;
569
570 /**
571 * Gets the groove location configuration value.
572 *
573 * @public @memberof GoProfileStripX
574 * @param measurement GoProfileStripX object.
575 * @return The profile groove location.
576 */
577 GoFx(GoProfileGrooveLocation) GoProfileStripX_Location(GoProfileStripX measurement);
578
579 /**
580 * Sets the groove location configuration value.
581 *
582 * @public @memberof GoProfileStripX
583 * @param measurement GoProfileStripX object.
584 * @param location The groove location value to set.
585 * @return Operation status.
586 */
587 GoFx(kStatus) GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location);
588
589 /**
590 * Gets the select type.
591 *
592 * @public @memberof GoProfileStripX
593 * @param measurement GoProfileStripX object.
594 * @return The select type.
595 */
596 GoFx(GoProfileGrooveSelectType) GoProfileStripX_SelectType(GoProfileStripX measurement);
597
598 /**
599 * Sets the select type.
600 *
601 * @public @memberof GoProfileStripX
602 * @param measurement GoProfileStripX object.
603 * @param selectType The select type to set.
604 * @return Operation status.
605 */
606 GoFx(kStatus) GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType);
607
608 /**
609 * Gets the select index.
610 *
611 * @public @memberof GoProfileStripX
612 * @param measurement GoProfileStripX object.
613 * @return The select index.
614 */
615 GoFx(k32u) GoProfileStripX_SelectIndex(GoProfileStripX measurement);
616
617 /**
618 * Sets the select index.
619 *
620 * @public @memberof GoProfileStripX
621 * @param measurement GoProfileStripX object.
622 * @param selectIndex The select index value to set.
623 * @return Operation status.
624 */
625 GoFx(kStatus) GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex);
626
627
628 /**
629 * @class GoProfileStripZ
630 * @extends GoMeasurement
631 * @ingroup GoSdk-ProfileTools
632 * @brief Represents a Z measurement for a Profile Strip Tool.
633 */
634 typedef GoMeasurement GoProfileStripZ;
635
636 /**
637 * Gets the groove location configuration value.
638 *
639 * @public @memberof GoProfileStripZ
640 * @param measurement GoProfileStripZ object.
641 * @return The profile groove location.
642 */
643 GoFx(GoProfileGrooveLocation) GoProfileStripZ_Location(GoProfileStripZ measurement);
644
645 /**
646 * Sets the groove location configuration value.
647 *
648 * @public @memberof GoProfileStripZ
649 * @param measurement GoProfileStripZ object.
650 * @param location The profile groove location to set.
651 * @return Operation status.
652 */
653 GoFx(kStatus) GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location);
654
655 /**
656 * Gets the select type.
657 *
658 * @public @memberof GoProfileStripZ
659 * @param measurement GoProfileStripZ object.
660 * @return The select type.
661 */
662 GoFx(GoProfileGrooveSelectType) GoProfileStripZ_SelectType(GoProfileStripZ measurement);
663
664 /**
665 * Sets the select type.
666 *
667 * @public @memberof GoProfileStripZ
668 * @param measurement GoProfileStripZ object.
669 * @param selectType The select type to set.
670 * @return Operation status.
671 */
672 GoFx(kStatus) GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType);
673
674 /**
675 * Gets the select index.
676 *
677 * @public @memberof GoProfileStripZ
678 * @param measurement GoProfileStripZ object.
679 * @return The select index.
680 */
681 GoFx(k32u) GoProfileStripZ_SelectIndex(GoProfileStripZ measurement);
682
683 /**
684 * Sets the select index.
685 *
686 * @public @memberof GoProfileStripZ
687 * @param measurement GoProfileStripZ object.
688 * @param selectIndex The select index value to set.
689 * @return Operation status.
690 */
691 GoFx(kStatus) GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex);
692
693
694 /**
695 * @class GoProfileStripWidth
696 * @extends GoMeasurement
697 * @ingroup GoSdk-ProfileTools
698 * @brief Represents a width measurement for a Profile Strip Tool.
699 */
700 typedef GoMeasurement GoProfileStripWidth;
701
702 /**
703 * Gets the select type.
704 *
705 * @public @memberof GoProfileStripWidth
706 * @param measurement GoProfileStripWidth object.
707 * @return The select type.
708 */
709 GoFx(GoProfileGrooveSelectType) GoProfileStripWidth_SelectType(GoProfileStripWidth measurement);
710
711 /**
712 * Sets the select type.
713 *
714 * @public @memberof GoProfileStripWidth
715 * @param measurement GoProfileStripWidth object.
716 * @param selectType The select type to set.
717 * @return Operation status.
718 */
719 GoFx(kStatus) GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType);
720
721 /**
722 * Gets the select index.
723 *
724 * @public @memberof GoProfileStripWidth
725 * @param measurement GoProfileStripWidth object.
726 * @return The select index.
727 */
728 GoFx(k32u) GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement);
729
730 /**
731 * Sets the select index.
732 *
733 * @public @memberof GoProfileStripWidth
734 * @param measurement GoProfileStripWidth object.
735 * @param selectIndex The select index value to set.
736 * @return Operation status.
737 */
738 GoFx(kStatus) GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex);
739
740
741 /**
742 * @class GoProfileStripHeight
743 * @extends GoMeasurement
744 * @ingroup GoSdk-ProfileTools
745 * @brief Represents an height measurement for a Profile Strip Tool.
746 */
747 typedef GoMeasurement GoProfileStripHeight;
748
749 /**
750 * Gets the groove location setting.
751 *
752 * @public @memberof GoProfileStripHeight
753 * @param measurement GoProfileStripHeight object.
754 * @return The groove location setting.
755 */
756 GoFx(GoProfileGrooveLocation) GoProfileStripHeight_Location(GoProfileStripHeight measurement);
757
758 /**
759 * Sets the location.
760 *
761 * @public @memberof GoProfileStripHeight
762 * @param measurement GoProfileStripHeight object.
763 * @param location The location value to set.
764 * @return Operation status.
765 */
766 GoFx(kStatus) GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location);
767
768 /**
769 * Gets the select type.
770 *
771 * @public @memberof GoProfileStripHeight
772 * @param measurement GoProfileStripHeight object.
773 * @return The select type.
774 */
775 GoFx(GoProfileGrooveSelectType) GoProfileStripHeight_SelectType(GoProfileStripHeight measurement);
776
777 /**
778 * Sets the select type.
779 *
780 * @public @memberof GoProfileStripHeight
781 * @param measurement GoProfileStripHeight object.
782 * @param selectType The select type value to set.
783 * @return Operation status.
784 */
785 GoFx(kStatus) GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType);
786
787 /**
788 * Gets the select index.
789 *
790 * @public @memberof GoProfileStripHeight
791 * @param measurement GoProfileStripHeight object.
792 * @return The select index.
793 */
794 GoFx(k32u) GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement);
795
796 /**
797 * Sets the select index.
798 *
799 * @public @memberof GoProfileStripHeight
800 * @param measurement GoProfileStripHeight object.
801 * @param selectIndex The select index value to set.
802 * @return Operation status.
803 */
804 GoFx(kStatus) GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex);
805
806 /// @endcond
807
808
809 /// @cond (Gocator_2x00 || Gocator_3x00)
810
811 /**
812 * @class GoSurfaceBoxX
813 * @extends GoMeasurement
814 * @ingroup GoSdk-SurfaceTools
815 * @brief Represents an X measurement for a Surface Bounding Box tool.
816 */
817 typedef GoMeasurement GoSurfaceBoxX;
818
819 /**
820 * @class GoSurfaceBoxY
821 * @extends GoMeasurement
822 * @ingroup GoSdk-SurfaceTools
823 * @brief Represents a Y measurement for a Surface Bounding Box tool.
824 */
825 typedef GoMeasurement GoSurfaceBoxY;
826
827 /**
828 * @class GoSurfaceBoxZ
829 * @extends GoMeasurement
830 * @ingroup GoSdk-SurfaceTools
831 * @brief Represents a Z measurement for a Surface Bounding Box tool.
832 */
833 typedef GoMeasurement GoSurfaceBoxZ;
834
835 /**
836 * @class GoSurfaceBoxWidth
837 * @extends GoMeasurement
838 * @ingroup GoSdk-SurfaceTools
839 * @brief Represents a width measurement for a Surface Bounding Box tool.
840 */
841 typedef GoMeasurement GoSurfaceBoxWidth;
842
843 /**
844 * @class GoSurfaceBoxLength
845 * @extends GoMeasurement
846 * @ingroup GoSdk-SurfaceTools
847 * @brief Represents a length measurement for a Surface Bounding Box tool.
848 */
849 typedef GoMeasurement GoSurfaceBoxLength;
850
851 /**
852 * @class GoSurfaceBoxHeight
853 * @extends GoMeasurement
854 * @ingroup GoSdk-SurfaceTools
855 * @brief Represents a height measurement for a Surface Bounding Box tool.
856 */
857 typedef GoMeasurement GoSurfaceBoxHeight;
858
859 /**
860 * @class GoSurfaceBoxZAngle
861 * @extends GoMeasurement
862 * @ingroup GoSdk-SurfaceTools
863 * @brief Represents a Z-angle measurement for a Surface Bounding Box tool.
864 */
865 typedef GoMeasurement GoSurfaceBoxZAngle;
866
867 /**
868 * @class GoSurfaceBoxGlobalX
869 * @extends GoMeasurement
870 * @ingroup GoSdk-SurfaceTools
871 * @brief Represents a global X measurement for a Surface Bounding Box tool.
872 */
873 typedef GoMeasurement GoSurfaceBoxGlobalX;
874
875 /**
876 * @class GoSurfaceBoxGlobalY
877 * @extends GoMeasurement
878 * @ingroup GoSdk-SurfaceTools
879 * @brief Represents a global Y measurement for a Surface Bounding Box tool.
880 */
881 typedef GoMeasurement GoSurfaceBoxGlobalY;
882
883
884 /**
885 * @class GoSurfaceEllipseMajor
886 * @extends GoMeasurement
887 * @ingroup GoSdk-SurfaceTools
888 * @brief Represents a major value measurement for a Surface Ellipse tool.
889 */
890 typedef GoMeasurement GoSurfaceEllipseMajor;
891
892 /**
893 * @class GoSurfaceEllipseMinor
894 * @extends GoMeasurement
895 * @ingroup GoSdk-SurfaceTools
896 * @brief Represents a minor value measurement for a Surface Ellipse tool.
897 */
898 typedef GoMeasurement GoSurfaceEllipseMinor;
899
900 /**
901 * @class GoSurfaceEllipseRatio
902 * @extends GoMeasurement
903 * @ingroup GoSdk-SurfaceTools
904 * @brief Represents a ratio measurement for a Surface Ellipse tool.
905 */
906 typedef GoMeasurement GoSurfaceEllipseRatio;
907
908 /**
909 * @class GoSurfaceEllipseZAngle
910 * @extends GoMeasurement
911 * @ingroup GoSdk-SurfaceTools
912 * @brief Represents a Z-angle measurement for a Surface Ellipse tool.
913 */
914 typedef GoMeasurement GoSurfaceEllipseZAngle;
915
916 /**
917 * @class GoSurfaceHoleX
918 * @extends GoMeasurement
919 * @ingroup GoSdk-SurfaceTools
920 * @brief Represents an X measurement for a Surface Hole Tool.
921 */
922 typedef GoMeasurement GoSurfaceHoleX;
923
924 /**
925 * @class GoSurfaceHoleY
926 * @extends GoMeasurement
927 * @ingroup GoSdk-SurfaceTools
928 * @brief Represents a Y measurement for a Surface Hole Tool.
929 */
930 typedef GoMeasurement GoSurfaceHoleY;
931
932 /**
933 * @class GoSurfaceHoleZ
934 * @extends GoMeasurement
935 * @ingroup GoSdk-SurfaceTools
936 * @brief Represents a Z measurement for a Surface Hole Tool.
937 */
938 typedef GoMeasurement GoSurfaceHoleZ;
939
940 /**
941 * @class GoSurfaceHoleRadius
942 * @extends GoMeasurement
943 * @ingroup GoSdk-SurfaceTools
944 * @brief Represents a radius measurement for a Surface Hole Tool.
945 */
946 typedef GoMeasurement GoSurfaceHoleRadius;
947
948
949 /**
950 * @class GoSurfaceOpeningX
951 * @extends GoMeasurement
952 * @ingroup GoSdk-SurfaceTools
953 * @brief Represents an X measurement for a Surface Opening Tool.
954 */
955 typedef GoMeasurement GoSurfaceOpeningX;
956
957 /**
958 * @class GoSurfaceOpeningY
959 * @extends GoMeasurement
960 * @ingroup GoSdk-SurfaceTools
961 * @brief Represents a Y measurement for a Surface Opening Tool.
962 */
963 typedef GoMeasurement GoSurfaceOpeningY;
964
965 /**
966 * @class GoSurfaceOpeningZ
967 * @extends GoMeasurement
968 * @ingroup GoSdk-SurfaceTools
969 * @brief Represents a Z measurement for a Surface Opening Tool.
970 */
971 typedef GoMeasurement GoSurfaceOpeningZ;
972
973 /**
974 * @class GoSurfaceOpeningWidth
975 * @extends GoMeasurement
976 * @ingroup GoSdk-SurfaceTools
977 * @brief Represents a width measurement for a Surface Opening Tool.
978 */
979 typedef GoMeasurement GoSurfaceOpeningWidth;
980
981 /**
982 * @class GoSurfaceOpeningLength
983 * @extends GoMeasurement
984 * @ingroup GoSdk-SurfaceTools
985 * @brief Represents a length measurement for a Surface Opening Tool.
986 */
987 typedef GoMeasurement GoSurfaceOpeningLength;
988
989 /**
990 * @class GoSurfaceOpeningAngle
991 * @extends GoMeasurement
992 * @ingroup GoSdk-SurfaceTools
993 * @brief Represents an angle measurement for a Surface Opening Tool.
994 */
995 typedef GoMeasurement GoSurfaceOpeningAngle;
996
997
998 /**
999 * @class GoSurfacePlaneXAngle
1000 * @extends GoMeasurement
1001 * @ingroup GoSdk-SurfaceTools
1002 * @brief Represents an X-angle measurement for a Surface Plane Tool.
1003 */
1004 typedef GoMeasurement GoSurfacePlaneXAngle;
1005
1006 /**
1007 * @class GoSurfacePlaneYAngle
1008 * @extends GoMeasurement
1009 * @ingroup GoSdk-SurfaceTools
1010 * @brief Represents a Y-angle measurement for a Surface Plane Tool.
1011 */
1012 typedef GoMeasurement GoSurfacePlaneYAngle;
1013
1014 /**
1015 * @class GoSurfacePlaneZOffset
1016 * @extends GoMeasurement
1017 * @ingroup GoSdk-SurfaceTools
1018 * @brief Represents a Z-offset measurement for a Surface Plane Tool.
1019 */
1020 typedef GoMeasurement GoSurfacePlaneZOffset;
1021
1022
1023 /**
1024 * @class GoSurfacePositionX
1025 * @extends GoMeasurement
1026 * @ingroup GoSdk-SurfaceTools
1027 * @brief Represents an X measurement for a Surface Position Tool.
1028 */
1029 typedef GoMeasurement GoSurfacePositionX;
1030
1031 /**
1032 * @class GoSurfacePositionY
1033 * @extends GoMeasurement
1034 * @ingroup GoSdk-SurfaceTools
1035 * @brief Represents a Y measurement for a Surface Position Tool.
1036 */
1037 typedef GoMeasurement GoSurfacePositionY;
1038
1039 /**
1040 * @class GoSurfacePositionZ
1041 * @extends GoMeasurement
1042 * @ingroup GoSdk-SurfaceTools
1043 * @brief Represents a Z measurement for a Surface Position Tool.
1044 */
1045 typedef GoMeasurement GoSurfacePositionZ;
1046
1047
1048 /**
1049 * @class GoSurfaceStudBaseX
1050 * @extends GoMeasurement
1051 * @ingroup GoSdk-SurfaceTools
1052 * @brief Represents a base X measurement for a Surface Stud Tool.
1053 */
1054 typedef GoMeasurement GoSurfaceStudBaseX;
1055
1056 /**
1057 * @class GoSurfaceStudBaseY
1058 * @extends GoMeasurement
1059 * @ingroup GoSdk-SurfaceTools
1060 * @brief Represents a base Y measurement for a Surface Stud Tool.
1061 */
1062 typedef GoMeasurement GoSurfaceStudBaseY;
1063
1064 /**
1065 * @class GoSurfaceStudBaseZ
1066 * @extends GoMeasurement
1067 * @ingroup GoSdk-SurfaceTools
1068 * @brief Represents a base Z measurement for a Surface Stud Tool.
1069 */
1070 typedef GoMeasurement GoSurfaceStudBaseZ;
1071
1072 /**
1073 * @class GoSurfaceStudTipX
1074 * @extends GoMeasurement
1075 * @ingroup GoSdk-SurfaceTools
1076 * @brief Represents a tip X measurement for a Surface Stud Tool.
1077 */
1078 typedef GoMeasurement GoSurfaceStudTipX;
1079
1080 /**
1081 * @class GoSurfaceStudTipY
1082 * @extends GoMeasurement
1083 * @ingroup GoSdk-SurfaceTools
1084 * @brief Represents a tip Y measurement for a Surface Stud Tool.
1085 */
1086 typedef GoMeasurement GoSurfaceStudTipY;
1087
1088 /**
1089 * @class GoSurfaceStudTipZ
1090 * @extends GoMeasurement
1091 * @ingroup GoSdk-SurfaceTools
1092 * @brief Represents a tip Z measurement for a Surface Stud Tool.
1093 */
1094 typedef GoMeasurement GoSurfaceStudTipZ;
1095
1096 /**
1097 * @class GoSurfaceStudRadius
1098 * @extends GoMeasurement
1099 * @ingroup GoSdk-SurfaceTools
1100 * @brief Represents a radius measurement for a Surface Stud Tool.
1101 */
1102 typedef GoMeasurement GoSurfaceStudRadius;
1103
1104 /**
1105 * Gets the radius offset.
1106 *
1107 * @public @memberof GoSurfaceStudRadius
1108 * @param measurement GoSurfaceStudRadius object.
1109 * @return The surface location.
1110 */
1111 GoFx(k64f) GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement);
1112
1113 /**
1114 * Sets the radius offset.
1115 *
1116 * @public @memberof GoSurfaceStudRadius
1117 * @param measurement GoSurfaceStudRadius object.
1118 * @param value The offset value to set..
1119 * @return Operation status.
1120 */
1121 GoFx(kStatus) GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value);
1122
1123 /**
1124 * @class GoSurfaceVolumeVolume
1125 * @extends GoMeasurement
1126 * @ingroup GoSdk-SurfaceTools
1127 * @brief Represents a volume measurement for a Surface Volume Tool.
1128 */
1129 typedef GoMeasurement GoSurfaceVolumeVolume;
1130
1131 /**
1132 * @class GoSurfaceVolumeArea
1133 * @extends GoMeasurement
1134 * @ingroup GoSdk-SurfaceTools
1135 * @brief Represents an area measurement for a Surface Volume Tool.
1136 */
1137 typedef GoMeasurement GoSurfaceVolumeArea;
1138
1139 /**
1140 * @class GoSurfaceVolumeThickness
1141 * @extends GoMeasurement
1142 * @ingroup GoSdk-SurfaceTools
1143 * @brief Represents a thickness measurement for a Surface Volume Tool.
1144 */
1145 typedef GoMeasurement GoSurfaceVolumeThickness;
1146
1147 /**
1148 * Gets the location.
1149 *
1150 * @public @memberof GoSurfaceVolumeThickness
1151 * @param measurement GoSurfaceVolumeThickness object.
1152 * @return The surface location.
1153 */
1154 GoFx(GoSurfaceLocation) GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement);
1155
1156 /**
1157 * Sets the location.
1158 *
1159 * @public @memberof GoSurfaceVolumeThickness
1160 * @param measurement GoSurfaceVolumeThickness object.
1161 * @param location The surface location.
1162 * @return Operation status.
1163 */
1164 GoFx(kStatus) GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location);
1165
1166 /// @endcond
1167
1168 /**
1169 * @class GoScriptOutput
1170 * @extends GoMeasurement
1171 * @ingroup GoSdk-Tools
1172 * @brief Represents a script output for a Script Tool.
1173 */
1174 typedef GoMeasurement GoScriptOutput;
1175
1176
1177 kEndHeader()
1178 #include <GoSdk/Tools/GoMeasurements.x.h>
1179
1180 #endif
GoProfileGrooveZ::GoProfileGrooveZ_SelectIndex
k32u GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement)
Gets the current selected groove index.
GoSurfacePlaneYAngle
Represents a Y-angle measurement for a Surface Plane Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SetSelectType
kStatus GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileCircleX
Represents an X value measurement for a Profile Circle Tool.
GoSurfaceBoxZAngle
Represents a Z-angle measurement for a Surface Bounding Box tool.
GoProfileStripZ::GoProfileStripZ_SelectType
GoProfileGrooveSelectType GoProfileStripZ_SelectType(GoProfileStripZ measurement)
Gets the select type.
GoMeasurement
Represents the base class for a tool measurement or script output.
Definition: GoMeasurement.h:15
GoProfileStripHeight::GoProfileStripHeight_SetSelectType
kStatus GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoSurfaceStudRadius
Represents a radius measurement for a Surface Stud Tool.
GoSurfaceBoxLength
Represents a length measurement for a Surface Bounding Box tool.
GoProfileStripZ::GoProfileStripZ_SelectIndex
k32u GoProfileStripZ_SelectIndex(GoProfileStripZ measurement)
Gets the select index.
GoSurfaceHoleY
Represents a Y measurement for a Surface Hole Tool.
GoProfileStripWidth::GoProfileStripWidth_SelectIndex
k32u GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement)
Gets the select index.
GoSurfaceOpeningZ
Represents a Z measurement for a Surface Opening Tool.
GoMeasurement.h
Declares the GoMeasurement class.
GoProfileDimHeight::GoProfileDimHeight_AbsoluteEnabled
kBool GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
GoSurfaceVolumeArea
Represents an area measurement for a Surface Volume Tool.
GoProfilePanelGap
Represents a gap measurement for a Profile Panel Tool.
GoProfileGrooveX::GoProfileGrooveX_SelectIndex
k32u GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement)
Gets the current selected groove index.
GoProfileStripHeight
Represents an height measurement for a Profile Strip Tool.
GoSurfaceStudRadius::GoSurfaceStudRadius_RadiusOffset
k64f GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement)
Gets the radius offset.
GoSurfaceEllipseMinor
Represents a minor value measurement for a Surface Ellipse tool.
GoSurfaceStudBaseY
Represents a base Y measurement for a Surface Stud Tool.
GoProfileDimCenterX
Represents a center X value measurement for a Profile Dimension Tool.
GoSurfaceEllipseZAngle
Represents a Z-angle measurement for a Surface Ellipse tool.
GoProfilePanelFlush
Represents a flush measurement for a Profile Panel Tool.
GoProfileStripZ::GoProfileStripZ_SetSelectType
kStatus GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoSurfacePlaneZOffset
Represents a Z-offset measurement for a Surface Plane Tool.
GoProfileGrooveWidth
Represents a width measurement for a Profile Groove Tool.
GoProfileDimWidth::GoProfileDimWidth_EnableAbsolute
kStatus GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
GoProfileGrooveZ::GoProfileGrooveZ_Location
GoProfileGrooveLocation GoProfileGrooveZ_Location(GoProfileGrooveZ measurement)
Gets the current groove location type.
GoSurfaceStudTipX
Represents a tip X measurement for a Surface Stud Tool.
GoProfileStripZ
Represents a Z measurement for a Profile Strip Tool.
GoProfileStripWidth::GoProfileStripWidth_SetSelectIndex
kStatus GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex)
Sets the select index.
GoProfileGrooveX::GoProfileGrooveX_SelectType
GoProfileGrooveSelectType GoProfileGrooveX_SelectType(GoProfileGrooveX measurement)
Gets the current groove selection type.
GoProfileDimWidth
Represents a width value measurement for a Profile Dimension Tool.
GoProfileStripWidth
Represents a width measurement for a Profile Strip Tool.
GoProfileGrooveX
Represents an X value measurement for a Profile Groove Tool.
GoProfileLinePercentile::GoProfileLinePercentile_Percent
k64f GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement)
Gets the percent threshold.
GoProfileIntersectX
Represents an intersect X measurement for a Profile Intersect Tool.
GoSurfaceStudRadius::GoSurfaceStudRadius_SetRadiusOffset
kStatus GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value)
Sets the radius offset.
GoSurfaceHoleX
Represents an X measurement for a Surface Hole Tool.
GoProfileLineMaxError
Represents a maximum error measurement for a Profile Line Tool.
GoProfilePanelFlush::GoProfilePanelFlush_EnableAbsolute
kStatus GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute)
Enables or disables the absolute value state.
GoSurfaceOpeningY
Represents a Y measurement for a Surface Opening Tool.
GoScriptOutput
Represents a script output for a Script Tool.
GoProfileAreaCentroidZ
Represents a centroid Z measurement for a Profile Area Tool.
GoProfileStripHeight::GoProfileStripHeight_Location
GoProfileGrooveLocation GoProfileStripHeight_Location(GoProfileStripHeight measurement)
Gets the groove location setting.
GoProfileGrooveX::GoProfileGrooveX_SetLocation
kStatus GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value)
Sets the groove location.
GoSurfacePlaneXAngle
Represents an X-angle measurement for a Surface Plane Tool.
GoSurfaceEllipseMajor
Represents a major value measurement for a Surface Ellipse tool.
GoProfilePanelFlush::GoProfilePanelFlush_AbsoluteEnabled
kBool GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement)
Gets absolute value state.
GoSurfacePositionX
Represents an X measurement for a Surface Position Tool.
GoProfileGrooveWidth::GoProfileGrooveWidth_SelectIndex
k32u GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement)
Gets the current selected groove index.
GoProfileAreaArea
Represents an area measurement for a Profile Area tool.
Definition: GoMeasurements.h:15
GoProfilePanelGap::GoProfilePanelGap_SetAxis
kStatus GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis)
Sets the gap axis.
GoProfileLineMinError
Represents a minimum error measurement for a Profile Line Tool.
GoProfileGrooveWidth::GoProfileGrooveWidth_SetSelectType
kStatus GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoSurfaceStudTipY
Represents a tip Y measurement for a Surface Stud Tool.
GoProfileGrooveSelectType
Determines which groove to select when multiple are present.
GoProfilePositionZ
Represents an Z measurement for a Profile Position tool.
GoSdkDef.h
Essential SDK declarations.
GoSurfaceLocation
Represents a surface location.
GoSurfaceOpeningWidth
Represents a width measurement for a Surface Opening Tool.
GoProfileLinePercentile
Represents a percentile measurement for a Profile Line Tool.
GoProfileGrooveWidth::GoProfileGrooveWidth_SelectType
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement)
Gets the current groove selection type.
GoProfileGrooveDepth::GoProfileGrooveDepth_SetSelectIndex
kStatus GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN)
Sets the selected groove index.
GoProfileStripX::GoProfileStripX_SelectIndex
k32u GoProfileStripX_SelectIndex(GoProfileStripX measurement)
Gets the select index.
GoProfileGrooveX::GoProfileGrooveX_SetSelectType
kStatus GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileLinePercentile::GoProfileLinePercentile_SetPercent
kStatus GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent)
Sets the percent threshold.
GoSurfaceBoxX
Represents an X measurement for a Surface Bounding Box tool.
GoProfileStripWidth::GoProfileStripWidth_SelectType
GoProfileGrooveSelectType GoProfileStripWidth_SelectType(GoProfileStripWidth measurement)
Gets the select type.
GoSurfaceStudBaseX
Represents a base X measurement for a Surface Stud Tool.
GoProfileStripHeight::GoProfileStripHeight_SelectType
GoProfileGrooveSelectType GoProfileStripHeight_SelectType(GoProfileStripHeight measurement)
Gets the select type.
GoSurfaceOpeningX
Represents an X measurement for a Surface Opening Tool.
GoProfileDimHeight
Represents a height value measurement for a Profile Dimension Tool.
GoProfileStripHeight::GoProfileStripHeight_SelectIndex
k32u GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement)
Gets the select index.
GoSurfaceVolumeThickness
Represents a thickness measurement for a Surface Volume Tool.
GoSurfaceBoxWidth
Represents a width measurement for a Surface Bounding Box tool.
GoProfileStripX::GoProfileStripX_SetSelectIndex
kStatus GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex)
Sets the select index.
GoSurfaceBoxGlobalX
Represents a global X measurement for a Surface Bounding Box tool.
GoSurfaceOpeningAngle
Represents an angle measurement for a Surface Opening Tool.
GoProfileDimWidth::GoProfileDimWidth_AbsoluteEnabled
kBool GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
GoProfileCircleZ
Represents a Z value measurement for a Profile Circle Tool.
GoProfileGrooveWidth::GoProfileGrooveWidth_SetSelectIndex
kStatus GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN)
Sets the selected groove index.
GoSurfacePositionY
Represents a Y measurement for a Surface Position Tool.
GoSurfaceVolumeThickness::GoSurfaceVolumeThickness_SetLocation
kStatus GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location)
Sets the location.
GoProfileGrooveLocation
Determines which groove position to return.
GoProfileIntersectAngle::GoProfileIntersectAngle_EnableAbsolute
kStatus GoProfileIntersectAngle_EnableAbsolute(GoProfileIntersectAngle measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
GoProfileStripZ::GoProfileStripZ_Location
GoProfileGrooveLocation GoProfileStripZ_Location(GoProfileStripZ measurement)
Gets the groove location configuration value.
GoSurfaceBoxHeight
Represents a height measurement for a Surface Bounding Box tool.
GoSurfaceStudTipZ
Represents a tip Z measurement for a Surface Stud Tool.
GoProfileStripX
Represents an X measurement for a Profile Strip Tool.
GoProfilePanelGap::GoProfilePanelGap_Axis
GoProfileGapAxis GoProfilePanelGap_Axis(GoProfilePanelGap measurement)
Gets the gap axis.
GoProfileStripHeight::GoProfileStripHeight_SetLocation
kStatus GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location)
Sets the location.
GoProfileStripX::GoProfileStripX_SetLocation
kStatus GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
GoProfileStripZ::GoProfileStripZ_SetSelectIndex
kStatus GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex)
Sets the select index.
GoProfileGapAxis
Represents a profile gap measurement axis.
GoProfileGrooveZ::GoProfileGrooveZ_SelectType
GoProfileGrooveSelectType GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement)
Gets the current groove selection type.
GoProfileStripX::GoProfileStripX_SetSelectType
kStatus GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoSurfaceBoxY
Represents a Y measurement for a Surface Bounding Box tool.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoSurfaceVolumeVolume
Represents a volume measurement for a Surface Volume Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SetLocation
kStatus GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location)
Sets the groove location type.
GoProfileLineStdDev
Represents a standard deviation measurement for a Profile Line Tool.
GoProfileDimCenterZ
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SelectIndex
k32u GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement)
Gets the current selected groove index.
GoSurfaceHoleRadius
Represents a radius measurement for a Surface Hole Tool.
GoProfileAreaCentroidX
Represents a centroid X measurement for a Profile Area Tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SetSelectType
kStatus GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileGrooveDepth
Represents a depth measurement for a Profile Groove Tool.
GoSurfaceBoxGlobalY
Represents a global Y measurement for a Surface Bounding Box tool.
GoProfileStripHeight::GoProfileStripHeight_SetSelectIndex
kStatus GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex)
Sets the select index.
GoProfileStripX::GoProfileStripX_SelectType
GoProfileGrooveSelectType GoProfileStripX_SelectType(GoProfileStripX measurement)
Gets the select type.
GoProfileIntersectAngle
Represents an intersect angle measurement for a Profile Intersect Tool.
GoProfileCircleRadius
Represents a radius value measurement for a Profile Circle Tool.
GoSurfacePositionZ
Represents a Z measurement for a Surface Position Tool.
GoProfileGrooveDepth::GoProfileGrooveDepth_SelectType
GoProfileGrooveSelectType GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement)
Gets the current groove selection type.
GoProfileGrooveZ
Represents a Z value measurement for a Profile Groove tool.
GoProfileGrooveX::GoProfileGrooveX_SetSelectIndex
kStatus GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN)
Sets the selected groove index.
GoProfileDimHeight::GoProfileDimHeight_EnableAbsolute
kStatus GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
GoProfileIntersectZ
Represents an intersect Z measurement for a Profile Intersect Tool.
GoProfilePositionX
Represents an X measurement for a Profile Position tool.
GoSurfaceEllipseRatio
Represents a ratio measurement for a Surface Ellipse tool.
GoSurfaceHoleZ
Represents a Z measurement for a Surface Hole Tool.
GoProfileStripX::GoProfileStripX_Location
GoProfileGrooveLocation GoProfileStripX_Location(GoProfileStripX measurement)
Gets the groove location configuration value.
GoSurfaceOpeningLength
Represents a length measurement for a Surface Opening Tool.
GoProfileGrooveZ::GoProfileGrooveZ_SetSelectIndex
kStatus GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN)
Sets the selected groove index.
GoSurfaceVolumeThickness::GoSurfaceVolumeThickness_Location
GoSurfaceLocation GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement)
Gets the location.
GoProfileStripWidth::GoProfileStripWidth_SetSelectType
kStatus GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
GoProfileIntersectAngle::GoProfileIntersectAngle_AbsoluteEnabled
kBool GoProfileIntersectAngle_AbsoluteEnabled(GoProfileIntersectAngle measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
GoSurfaceBoxZ
Represents a Z measurement for a Surface Bounding Box tool.
GoSurfaceStudBaseZ
Represents a base Z measurement for a Surface Stud Tool.
GoProfileGrooveX::GoProfileGrooveX_Location
GoProfileGrooveLocation GoProfileGrooveX_Location(GoProfileGrooveX measurement)
Gets the current groove selection type.
GoProfileStripZ::GoProfileStripZ_SetLocation
kStatus GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
GoProfileDimDistance
Represents a distance value measurement for a Profile Dimension Tool.