Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules 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) 2016 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_SDK_MEASUREMENTS_H
11 #define GO_SDK_MEASUREMENTS_H
12 
13 #include <GoSdk/GoSdkDef.h>
15 #include <GoSdk/Tools/GoExtParam.h>
16 
17 kBeginHeader()
18 
19 /// @cond Gocator_1x00
20 
21 /**
22  * @class GoRangePositionZ
23  * @extends GoMeasurement
24  * @ingroup GoSdk
25  * @brief Represents a position Z measurement of a Range Position tool.
26  */
27 typedef GoMeasurement GoRangePositionZ;
28 
29 /**
30  * @class GoRangeThicknessThickness
31  * @extends GoMeasurement
32  * @ingroup GoSdk
33  * @brief Represents a the thickness measurement of a Range Thickness tool.
34  */
35 typedef GoMeasurement GoRangeThicknessThickness;
36 
37 /// @endcond
38 
39 
40 /**
41  * @class GoProfileAreaArea
42  * @extends GoMeasurement
43  * @ingroup GoSdk-ProfileTools
44  * @brief Represents an area measurement for a Profile Area tool.
45  */
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  */
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  */
63 
64 /**
65  * @class GoProfileBoxX
66  * @extends GoMeasurement
67  * @ingroup GoSdk-ProfileTools
68  * @brief Represents an X measurement for a Profile Bounding Box tool.
69  */
71 
72 /**
73  * @class GoProfileBoxZ
74  * @extends GoMeasurement
75  * @ingroup GoSdk-ProfileTools
76  * @brief Represents a Z measurement for a Profile Bounding Box tool.
77  */
79 
80 /**
81  * @class GoProfileBoxWidth
82  * @extends GoMeasurement
83  * @ingroup GoSdk-ProfileTools
84  * @brief Represents a width measurement for a Profile Bounding Box tool.
85  */
87 
88 /**
89  * @class GoProfileBoxHeight
90  * @extends GoMeasurement
91  * @ingroup GoSdk-ProfileTools
92  * @brief Represents a height measurement for a Profile Bounding Box tool.
93  */
95 
96 /**
97  * @class GoProfileBoxGlobalX
98  * @extends GoMeasurement
99  * @ingroup GoSdk-ProfileTools
100  * @brief Represents a global X measurement for a Profile Bounding Box tool.
101  */
103 
104 /**
105  * @class GoProfileBoxGlobalY
106  * @extends GoMeasurement
107  * @ingroup GoSdk-ProfileTools
108  * @brief Represents a global Y measurement for a Profile Bounding Box tool.
109  */
111 
112 /**
113  * @class GoProfileBoxGlobalAngle
114  * @extends GoMeasurement
115  * @ingroup GoSdk-ProfileTools
116  * @brief Represents a global angle measurement for a Profile Bounding Box tool.
117  */
119 
120 /**
121 * @class GoProfileBridgeValueBridgeValue
122 * @extends GoMeasurement
123 * @ingroup GoSdk-ProfileTools
124 * @brief Represents a bridge value measurement for a Profile Bridge Value tool.
125 */
127 
128 /**
129 * @class GoProfileBridgeValueAngle
130 * @extends GoMeasurement
131 * @ingroup GoSdk-ProfileTools
132 * @brief Represents an angle measurement for a Profile Bridge Value tool.
133 */
135 
136 
137 /**
138  * @class GoProfileCircleX
139  * @extends GoMeasurement
140  * @ingroup GoSdk-ProfileTools
141  * @brief Represents an X value measurement for a Profile Circle Tool.
142  */
144 
145 /**
146  * @class GoProfileCircleZ
147  * @extends GoMeasurement
148  * @ingroup GoSdk-ProfileTools
149  * @brief Represents a Z value measurement for a Profile Circle Tool.
150  */
152 
153 
154 /**
155  * @class GoProfileCircleRadius
156  * @extends GoMeasurement
157  * @ingroup GoSdk-ProfileTools
158  * @brief Represents a radius value measurement for a Profile Circle Tool.
159  */
161 
162 
163 /**
164  * @class GoProfileDimWidth
165  * @extends GoMeasurement
166  * @ingroup GoSdk-ProfileTools
167  * @brief Represents a width value measurement for a Profile Dimension Tool.
168  */
170 
171 /**
172  * Returns a boolean value representing whether an absolute measurement value will be returned.
173  *
174  * @public @memberof GoProfileDimWidth
175  * @version Introduced in firmware 4.0.10.27
176  * @param measurement GoProfileDimWidth object.
177  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
178  */
179 GoFx(kBool) GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement);
180 
181 /**
182  * Enables or disables an absolute value result for the given measurement.
183  *
184  * @public @memberof GoProfileDimWidth
185  * @version Introduced in firmware 4.0.10.27
186  * @param measurement GoProfileDimWidth object.
187  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
188  * @return Operation status.
189  */
190 GoFx(kStatus) GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute);
191 
192 /**
193  * @class GoProfileDimHeight
194  * @extends GoMeasurement
195  * @ingroup GoSdk-ProfileTools
196  * @brief Represents a height value measurement for a Profile Dimension Tool.
197  */
199 
200 /**
201  * Returns a boolean value representing whether an absolute measurement value will be returned.
202  *
203  * @public @memberof GoProfileDimHeight
204  * @version Introduced in firmware 4.0.10.27
205  * @param measurement GoProfileDimHeight object.
206  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
207  */
208 GoFx(kBool) GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement);
209 
210 /**
211  * Enables or disables an absolute value result for the given measurement.
212  *
213  * @public @memberof GoProfileDimHeight
214  * @version Introduced in firmware 4.0.10.27
215  * @param measurement GoProfileDimHeight object.
216  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
217  * @return Operation status.
218  */
219 GoFx(kStatus) GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute);
220 
221 /**
222  * @class GoProfileDimDistance
223  * @extends GoMeasurement
224  * @ingroup GoSdk-ProfileTools
225  * @brief Represents a distance value measurement for a Profile Dimension Tool.
226  */
228 
229 /**
230  * @class GoProfileDimCenterX
231  * @extends GoMeasurement
232  * @ingroup GoSdk-ProfileTools
233  * @brief Represents a center X value measurement for a Profile Dimension Tool.
234  */
236 
237 /**
238  * @class GoProfileDimCenterZ
239  * @extends GoMeasurement
240  * @ingroup GoSdk-ProfileTools
241  * @brief Represents a center Z value measurement for a Profile Dimension Tool.
242  */
244 
245 /**
246  * @class GoProfileIntersectX
247  * @extends GoMeasurement
248  * @ingroup GoSdk-ProfileTools
249  * @brief Represents an intersect X measurement for a Profile Intersect Tool.
250  */
252 
253 /**
254  * @class GoProfileIntersectZ
255  * @extends GoMeasurement
256  * @ingroup GoSdk-ProfileTools
257  * @brief Represents an intersect Z measurement for a Profile Intersect Tool.
258  */
260 
261 /**
262  * @class GoProfileIntersectAngle
263  * @extends GoMeasurement
264  * @ingroup GoSdk-ProfileTools
265  * @brief Represents an intersect angle measurement for a Profile Intersect Tool.
266  */
268 
269 /**
270  * Returns a boolean value representing whether a absolute measurement value
271  * in the range of 0 to 180 degrees instead of -90 to 90 will be returned.
272  *
273  * @public @memberof GoProfileIntersectAngle
274  * @version Introduced in firmware 4.4.4.14
275  * @param measurement GoProfileIntersectAngle object.
276  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
277  */
278 GoFx(kBool) GoProfileIntersectAngle_Range0to180Enabled(GoProfileIntersectAngle measurement);
279 
280 /**
281  * Enables or disables a result in the range of 0 to 180 instead of -90 to 90 degrees for the given measurement.
282  *
283  * @public @memberof GoProfileIntersectAngle
284  * @version Introduced in firmware 4.4.4.14
285  * @param measurement GoProfileIntersectAngle object.
286  * @param enable kTRUE to use a range of 0 to 180 and kFALSE to use a range of -90 to 90 degrees.
287  * @return Operation status.
288  */
289 GoFx(kStatus) GoProfileIntersectAngle_EnableRange0to180(GoProfileIntersectAngle measurement, kBool enable);
290 
291 /**
292  * @class GoProfileGrooveX
293  * @extends GoMeasurement
294  * @ingroup GoSdk-ProfileTools
295  * @brief Represents an X value measurement for a Profile Groove Tool.
296  */
298 
299 /**
300  * Gets the current groove location.
301  *
302  * @public @memberof GoProfileGrooveX
303  * @version Introduced in firmware 4.0.10.27
304  * @param measurement GoProfileGrooveX object.
305  * @return The profile groove location.
306  */
307 GoFx(GoProfileGrooveLocation) GoProfileGrooveX_Location(GoProfileGrooveX measurement);
308 
309 /**
310  * Sets the groove location.
311  *
312  * @public @memberof GoProfileGrooveX
313  * @version Introduced in firmware 4.0.10.27
314  * @param measurement GoProfileGrooveX object.
315  * @param value The groove location value to be set.
316  * @return Operation status.
317  */
318 GoFx(kStatus) GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value);
319 
320 
321 /**
322  * Gets the current groove selection type.
323  *
324  * @public @memberof GoProfileGrooveX
325  * @version Introduced in firmware 4.0.10.27
326  * @param measurement GoProfileGrooveX object.
327  * @return The profile groove selection type.
328  */
329 GoFx(GoProfileGrooveSelectType) GoProfileGrooveX_SelectType(GoProfileGrooveX measurement);
330 
331 /**
332  * Sets the groove selection type.
333  *
334  * @public @memberof GoProfileGrooveX
335  * @version Introduced in firmware 4.0.10.27
336  * @param measurement GoProfileGrooveX object.
337  * @param selectType The profile groove type.
338  * @return Operation status.
339  */
340 GoFx(kStatus) GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType);
341 
342 /**
343  * Gets the current selected groove index.
344  *
345  * @public @memberof GoProfileGrooveX
346  * @version Introduced in firmware 4.0.10.27
347  * @param measurement GoProfileGrooveX object.
348  * @return The current groove index.
349  */
350 GoFx(k32u) GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement);
351 
352 /**
353  * Sets the selected groove index.
354  *
355  * @public @memberof GoProfileGrooveX
356  * @version Introduced in firmware 4.0.10.27
357  * @param measurement GoProfileGrooveX object.
358  * @param selectN The selected groove index.
359  * @return Operation status.
360  */
361 GoFx(kStatus) GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN);
362 
363 
364 
365 /**
366  * @class GoProfileGrooveZ
367  * @extends GoMeasurement
368  * @ingroup GoSdk-ProfileTools
369  * @brief Represents a Z value measurement for a Profile Groove tool.
370  */
372 
373 /**
374  * Gets the current groove location type.
375  *
376  * @public @memberof GoProfileGrooveZ
377  * @version Introduced in firmware 4.0.10.27
378  * @param measurement GoProfileGrooveZ object.
379  * @return The profile groove location type.
380  */
381 GoFx(GoProfileGrooveLocation) GoProfileGrooveZ_Location(GoProfileGrooveZ measurement);
382 
383 /**
384  * Sets the groove location type.
385  *
386  * @public @memberof GoProfileGrooveZ
387  * @version Introduced in firmware 4.0.10.27
388  * @param measurement GoProfileGrooveZ object.
389  * @param location The profile groove location type.
390  * @return Operation status.
391  */
392 GoFx(kStatus) GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location);
393 
394 /**
395  * Gets the current groove selection type.
396  *
397  * @public @memberof GoProfileGrooveZ
398  * @version Introduced in firmware 4.0.10.27
399  * @param measurement GoProfileGrooveZ object.
400  * @return The profile groove selection type.
401  */
402 GoFx(GoProfileGrooveSelectType) GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement);
403 
404 /**
405  * Sets the groove selection type.
406  *
407  * @public @memberof GoProfileGrooveZ
408  * @version Introduced in firmware 4.0.10.27
409  * @param measurement GoProfileGrooveZ object.
410  * @param selectType The profile groove selection type.
411  * @return Operation status.
412  */
413 GoFx(kStatus) GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType);
414 
415 /**
416  * Gets the current selected groove index.
417  *
418  * @public @memberof GoProfileGrooveZ
419  * @version Introduced in firmware 4.0.10.27
420  * @param measurement GoProfileGrooveZ object.
421  * @return The current groove index.
422  */
423 GoFx(k32u) GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement);
424 
425 /**
426  * Sets the selected groove index.
427  *
428  * @public @memberof GoProfileGrooveZ
429  * @version Introduced in firmware 4.0.10.27
430  * @param measurement GoProfileGrooveZ object.
431  * @param selectN The selected groove index.
432  * @return Operation status.
433  */
434 GoFx(kStatus) GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN);
435 
436 
437 /**
438  * @class GoProfileGrooveWidth
439  * @extends GoMeasurement
440  * @ingroup GoSdk-ProfileTools
441  * @brief Represents a width measurement for a Profile Groove Tool.
442  */
444 
445 /**
446  * Gets the current groove selection type.
447  *
448  * @public @memberof GoProfileGrooveWidth
449  * @version Introduced in firmware 4.0.10.27
450  * @param measurement GoProfileGrooveWidth object.
451  * @return The profile groove selection type.
452  */
453 GoFx(GoProfileGrooveSelectType) GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement);
454 
455 /**
456  * Sets the groove selection type.
457  *
458  * @public @memberof GoProfileGrooveWidth
459  * @version Introduced in firmware 4.0.10.27
460  * @param measurement GoProfileGrooveWidth object.
461  * @param selectType The profile groove type.
462  * @return Operation status.
463  */
464 GoFx(kStatus) GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType);
465 
466 /**
467  * Gets the current selected groove index.
468  *
469  * @public @memberof GoProfileGrooveWidth
470  * @version Introduced in firmware 4.0.10.27
471  * @param measurement GoProfileGrooveWidth object.
472  * @return The current groove index.
473  */
474 GoFx(k32u) GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement);
475 
476 /**
477  * Sets the selected groove index.
478  *
479  * @public @memberof GoProfileGrooveWidth
480  * @version Introduced in firmware 4.0.10.27
481  * @param measurement GoProfileGrooveWidth object.
482  * @param selectN The selected groove index.
483  * @return Operation status.
484  */
485 GoFx(kStatus) GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN);
486 
487 
488 /**
489  * @class GoProfileGrooveDepth
490  * @extends GoMeasurement
491  * @ingroup GoSdk-ProfileTools
492  * @brief Represents a depth measurement for a Profile Groove Tool.
493  */
495 
496 /**
497  * Gets the current groove selection type.
498  *
499  * @public @memberof GoProfileGrooveDepth
500  * @version Introduced in firmware 4.0.10.27
501  * @param measurement GoProfileGrooveDepth object.
502  * @return The profile groove selection type.
503  */
504 GoFx(GoProfileGrooveSelectType) GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement);
505 
506 /**
507  * Sets the groove selection type.
508  *
509  * @public @memberof GoProfileGrooveDepth
510  * @version Introduced in firmware 4.0.10.27
511  * @param measurement GoProfileGrooveDepth object.
512  * @param selectType The profile groove type.
513  * @return Operation status.
514  */
515 GoFx(kStatus) GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType);
516 
517 /**
518  * Gets the current selected groove index.
519  *
520  * @public @memberof GoProfileGrooveDepth
521  * @version Introduced in firmware 4.0.10.27
522  * @param measurement GoProfileGrooveDepth object.
523  * @return The current groove index.
524  */
525 GoFx(k32u) GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement);
526 
527 /**
528  * Sets the selected groove index.
529  *
530  * @public @memberof GoProfileGrooveDepth
531  * @version Introduced in firmware 4.0.10.27
532  * @param measurement GoProfileGrooveDepth object.
533  * @param selectN The selected groove index.
534  * @return Operation status.
535  */
536 GoFx(kStatus) GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN);
537 
538 
539 /**
540  * @class GoProfileLineStdDev
541  * @extends GoMeasurement
542  * @ingroup GoSdk-ProfileTools
543  * @brief Represents a standard deviation measurement for a Profile Line Tool.
544  */
546 
547 /**
548  * @class GoProfileLineMinError
549  * @extends GoMeasurement
550  * @ingroup GoSdk-ProfileTools
551  * @brief Represents a minimum error measurement for a Profile Line Tool.
552  */
554 
555 /**
556  * @class GoProfileLineMaxError
557  * @extends GoMeasurement
558  * @ingroup GoSdk-ProfileTools
559  * @brief Represents a maximum error measurement for a Profile Line Tool.
560  */
562 
563 /**
564  * @class GoProfileLinePercentile
565  * @extends GoMeasurement
566  * @ingroup GoSdk-ProfileTools
567  * @brief Represents a percentile measurement for a Profile Line Tool.
568  */
570 
571 /**
572  * Gets the percent threshold.
573  *
574  * @public @memberof GoProfileLinePercentile
575  * @version Introduced in firmware 4.0.10.27
576  * @param measurement GoProfileLinePercentile object.
577  * @return The percent threshold.
578  */
579 GoFx(k64f) GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement);
580 
581 /**
582  * Sets the percent threshold.
583  *
584  * @public @memberof GoProfileLinePercentile
585  * @version Introduced in firmware 4.0.10.27
586  * @param measurement GoProfileLinePercentile object.
587  * @param percent The percent threshold to set.
588  * @return Operation status.
589  */
590 GoFx(kStatus) GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent);
591 
592 /**
593  * @class GoProfilePanelGap
594  * @extends GoMeasurement
595  * @ingroup GoSdk-ProfileTools
596  * @brief Represents a gap measurement for a Profile Panel Tool.
597  */
599 
600 /**
601  * Gets the gap axis.
602  *
603  * @public @memberof GoProfilePanelGap
604  * @version Introduced in firmware 4.0.10.27
605  * @param measurement GoProfilePanelGap object.
606  * @return The gap axis.
607  */
608 GoFx(GoProfileGapAxis) GoProfilePanelGap_Axis(GoProfilePanelGap measurement);
609 
610 /**
611  * Sets the gap axis.
612  *
613  * @public @memberof GoProfilePanelGap
614  * @version Introduced in firmware 4.0.10.27
615  * @param measurement GoProfilePanelGap object.
616  * @param axis The gap axis value to set.
617  * @return Operation status.
618  */
619 GoFx(kStatus) GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis);
620 
621 /**
622  * @class GoProfilePanelFlush
623  * @extends GoMeasurement
624  * @ingroup GoSdk-ProfileTools
625  * @brief Represents a flush measurement for a Profile Panel Tool.
626  */
628 
629 /**
630  * Gets absolute value state.
631  *
632  * @public @memberof GoProfilePanelFlush
633  * @version Introduced in firmware 4.0.10.27
634  * @param measurement GoProfilePanelFlush object.
635  * @return kTRUE if absolute value is enabled and kFALSE otherwise.
636  */
637 GoFx(kBool) GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement);
638 
639 /**
640  * Enables or disables the absolute value state.
641  *
642  * @public @memberof GoProfilePanelFlush
643  * @version Introduced in firmware 4.0.10.27
644  * @param measurement GoProfilePanelFlush object.
645  * @param absolute kTRUE to enable and kFALSE to disable.
646  * @return Operation status.
647  */
648 GoFx(kStatus) GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute);
649 
650 /**
651  * @class GoProfileRoundCornerX
652  * @extends GoMeasurement
653  * @ingroup GoSdk-ProfileTools
654  * @brief Represents an X measurement for a Profile Round Corner tool.
655  */
657 
658 /**
659  * @class GoProfileRoundCornerZ
660  * @extends GoMeasurement
661  * @ingroup GoSdk-ProfileTools
662  * @brief Represents an Z measurement for a Profile Round Corner tool.
663  */
665 
666 /**
667  * @class GoProfileRoundCornerAngle
668  * @extends GoMeasurement
669  * @ingroup GoSdk-ProfileTools
670  * @brief Represents an Angle measurement for a Profile Round Corner tool.
671  */
673 
674 /**
675  * @class GoProfilePositionX
676  * @extends GoMeasurement
677  * @ingroup GoSdk-ProfileTools
678  * @brief Represents an X measurement for a Profile Position tool.
679  */
681 
682 /**
683  * @class GoProfilePositionZ
684  * @extends GoMeasurement
685  * @ingroup GoSdk-ProfileTools
686  * @brief Represents an Z measurement for a Profile Position tool.
687  */
689 
690 
691 /**
692  * @class GoProfileStripX
693  * @extends GoMeasurement
694  * @ingroup GoSdk-ProfileTools
695  * @brief Represents an X measurement for a Profile Strip Tool.
696  */
698 
699 /**
700  * Gets the groove location configuration value.
701  *
702  * @public @memberof GoProfileStripX
703  * @version Introduced in firmware 4.0.10.27
704  * @param measurement GoProfileStripX object.
705  * @return The profile groove location.
706  */
707 GoFx(GoProfileGrooveLocation) GoProfileStripX_Location(GoProfileStripX measurement);
708 
709 /**
710  * Sets the groove location configuration value.
711  *
712  * @public @memberof GoProfileStripX
713  * @version Introduced in firmware 4.0.10.27
714  * @param measurement GoProfileStripX object.
715  * @param location The groove location value to set.
716  * @return Operation status.
717  */
718 GoFx(kStatus) GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location);
719 
720 /**
721  * Gets the select type.
722  *
723  * @public @memberof GoProfileStripX
724  * @version Introduced in firmware 4.0.10.27
725  * @param measurement GoProfileStripX object.
726  * @return The select type.
727  */
728 GoFx(GoProfileGrooveSelectType) GoProfileStripX_SelectType(GoProfileStripX measurement);
729 
730 /**
731  * Sets the select type.
732  *
733  * @public @memberof GoProfileStripX
734  * @version Introduced in firmware 4.0.10.27
735  * @param measurement GoProfileStripX object.
736  * @param selectType The select type to set.
737  * @return Operation status.
738  */
739 GoFx(kStatus) GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType);
740 
741 /**
742  * Gets the select index.
743  *
744  * @public @memberof GoProfileStripX
745  * @version Introduced in firmware 4.0.10.27
746  * @param measurement GoProfileStripX object.
747  * @return The select index.
748  */
749 GoFx(k32u) GoProfileStripX_SelectIndex(GoProfileStripX measurement);
750 
751 /**
752  * Sets the select index.
753  *
754  * @public @memberof GoProfileStripX
755  * @version Introduced in firmware 4.0.10.27
756  * @param measurement GoProfileStripX object.
757  * @param selectIndex The select index value to set.
758  * @return Operation status.
759  */
760 GoFx(kStatus) GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex);
761 
762 
763 /**
764  * @class GoProfileStripZ
765  * @extends GoMeasurement
766  * @ingroup GoSdk-ProfileTools
767  * @brief Represents a Z measurement for a Profile Strip Tool.
768  */
770 
771 /**
772  * Gets the groove location configuration value.
773  *
774  * @public @memberof GoProfileStripZ
775  * @version Introduced in firmware 4.0.10.27
776  * @param measurement GoProfileStripZ object.
777  * @return The profile groove location.
778  */
779 GoFx(GoProfileGrooveLocation) GoProfileStripZ_Location(GoProfileStripZ measurement);
780 
781 /**
782  * Sets the groove location configuration value.
783  *
784  * @public @memberof GoProfileStripZ
785  * @version Introduced in firmware 4.0.10.27
786  * @param measurement GoProfileStripZ object.
787  * @param location The profile groove location to set.
788  * @return Operation status.
789  */
790 GoFx(kStatus) GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location);
791 
792 /**
793  * Gets the select type.
794  *
795  * @public @memberof GoProfileStripZ
796  * @version Introduced in firmware 4.0.10.27
797  * @param measurement GoProfileStripZ object.
798  * @return The select type.
799  */
800 GoFx(GoProfileGrooveSelectType) GoProfileStripZ_SelectType(GoProfileStripZ measurement);
801 
802 /**
803  * Sets the select type.
804  *
805  * @public @memberof GoProfileStripZ
806  * @version Introduced in firmware 4.0.10.27
807  * @param measurement GoProfileStripZ object.
808  * @param selectType The select type to set.
809  * @return Operation status.
810  */
811 GoFx(kStatus) GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType);
812 
813 /**
814  * Gets the select index.
815  *
816  * @public @memberof GoProfileStripZ
817  * @version Introduced in firmware 4.0.10.27
818  * @param measurement GoProfileStripZ object.
819  * @return The select index.
820  */
821 GoFx(k32u) GoProfileStripZ_SelectIndex(GoProfileStripZ measurement);
822 
823 /**
824  * Sets the select index.
825  *
826  * @public @memberof GoProfileStripZ
827  * @version Introduced in firmware 4.0.10.27
828  * @param measurement GoProfileStripZ object.
829  * @param selectIndex The select index value to set.
830  * @return Operation status.
831  */
832 GoFx(kStatus) GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex);
833 
834 
835 /**
836  * @class GoProfileStripWidth
837  * @extends GoMeasurement
838  * @ingroup GoSdk-ProfileTools
839  * @brief Represents a width measurement for a Profile Strip Tool.
840  */
842 
843 /**
844  * Gets the select type.
845  *
846  * @public @memberof GoProfileStripWidth
847  * @version Introduced in firmware 4.0.10.27
848  * @param measurement GoProfileStripWidth object.
849  * @return The select type.
850  */
851 GoFx(GoProfileGrooveSelectType) GoProfileStripWidth_SelectType(GoProfileStripWidth measurement);
852 
853 /**
854  * Sets the select type.
855  *
856  * @public @memberof GoProfileStripWidth
857  * @version Introduced in firmware 4.0.10.27
858  * @param measurement GoProfileStripWidth object.
859  * @param selectType The select type to set.
860  * @return Operation status.
861  */
862 GoFx(kStatus) GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType);
863 
864 /**
865  * Gets the select index.
866  *
867  * @public @memberof GoProfileStripWidth
868  * @version Introduced in firmware 4.0.10.27
869  * @param measurement GoProfileStripWidth object.
870  * @return The select index.
871  */
872 GoFx(k32u) GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement);
873 
874 /**
875  * Sets the select index.
876  *
877  * @public @memberof GoProfileStripWidth
878  * @version Introduced in firmware 4.0.10.27
879  * @param measurement GoProfileStripWidth object.
880  * @param selectIndex The select index value to set.
881  * @return Operation status.
882  */
883 GoFx(kStatus) GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex);
884 
885 
886 /**
887  * @class GoProfileStripHeight
888  * @extends GoMeasurement
889  * @ingroup GoSdk-ProfileTools
890  * @brief Represents an height measurement for a Profile Strip Tool.
891  */
893 
894 /**
895  * Gets the groove location setting.
896  *
897  * @public @memberof GoProfileStripHeight
898  * @version Introduced in firmware 4.0.10.27
899  * @param measurement GoProfileStripHeight object.
900  * @return The groove location setting.
901  */
902 GoFx(GoProfileGrooveLocation) GoProfileStripHeight_Location(GoProfileStripHeight measurement);
903 
904 /**
905  * Sets the location.
906  *
907  * @public @memberof GoProfileStripHeight
908  * @version Introduced in firmware 4.0.10.27
909  * @param measurement GoProfileStripHeight object.
910  * @param location The location value to set.
911  * @return Operation status.
912  */
913 GoFx(kStatus) GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location);
914 
915 /**
916  * Gets the select type.
917  *
918  * @public @memberof GoProfileStripHeight
919  * @version Introduced in firmware 4.0.10.27
920  * @param measurement GoProfileStripHeight object.
921  * @return The select type.
922  */
923 GoFx(GoProfileGrooveSelectType) GoProfileStripHeight_SelectType(GoProfileStripHeight measurement);
924 
925 /**
926  * Sets the select type.
927  *
928  * @public @memberof GoProfileStripHeight
929  * @version Introduced in firmware 4.0.10.27
930  * @param measurement GoProfileStripHeight object.
931  * @param selectType The select type value to set.
932  * @return Operation status.
933  */
934 GoFx(kStatus) GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType);
935 
936 /**
937  * Gets the select index.
938  *
939  * @public @memberof GoProfileStripHeight
940  * @version Introduced in firmware 4.0.10.27
941  * @param measurement GoProfileStripHeight object.
942  * @return The select index.
943  */
944 GoFx(k32u) GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement);
945 
946 /**
947  * Sets the select index.
948  *
949  * @public @memberof GoProfileStripHeight
950  * @version Introduced in firmware 4.0.10.27
951  * @param measurement GoProfileStripHeight object.
952  * @param selectIndex The select index value to set.
953  * @return Operation status.
954  */
955 GoFx(kStatus) GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex);
956 
957 /**
958 * @class GoProfileXLineZ
959 * @extends GoMeasurement
960 * @ingroup GoSdk-ProfileTools
961 * @brief Represents an Z measurement for a Profile X-Line tool.
962 */
964 
965 /**
966 * @class GoProfileXLineValidity
967 * @extends GoMeasurement
968 * @ingroup GoSdk-ProfileTools
969 * @brief Represents a validity measurement for a Profile X-Line tool.
970 */
972 
973 
974 /// @cond (Gocator_2x00 || Gocator_3x00)
975 
976 /**
977  * @class GoSurfaceBoxX
978  * @extends GoMeasurement
979  * @ingroup GoSdk-SurfaceTools
980  * @brief Represents an X measurement for a Surface Bounding Box tool.
981  */
983 
984 /**
985  * @class GoSurfaceBoxY
986  * @extends GoMeasurement
987  * @ingroup GoSdk-SurfaceTools
988  * @brief Represents a Y measurement for a Surface Bounding Box tool.
989  */
991 
992 /**
993  * @class GoSurfaceBoxZ
994  * @extends GoMeasurement
995  * @ingroup GoSdk-SurfaceTools
996  * @brief Represents a Z measurement for a Surface Bounding Box tool.
997  */
999 
1000 
1001 /**
1002  * @class GoSurfaceBoxZAngle
1003  * @extends GoMeasurement
1004  * @ingroup GoSdk-SurfaceTools
1005  * @brief Represents a Z-angle measurement for a Surface Bounding Box tool.
1006  */
1008 
1009 /**
1010  * @class GoSurfaceBoxGlobalX
1011  * @extends GoMeasurement
1012  * @ingroup GoSdk-SurfaceTools
1013  * @brief Represents a global X measurement for a Surface Bounding Box tool.
1014  */
1016 
1017 /**
1018  * @class GoSurfaceBoxGlobalY
1019  * @extends GoMeasurement
1020  * @ingroup GoSdk-SurfaceTools
1021  * @brief Represents a global Y measurement for a Surface Bounding Box tool.
1022  */
1024 
1025 /**
1026  * @class GoSurfaceBoxGlobalZAngle
1027  * @extends GoMeasurement
1028  * @ingroup GoSdk-SurfaceTools
1029  * @brief Represents a global Z angle measurement for a Surface Bounding Box tool.
1030  */
1032 
1033 /**
1034  * @class GoSurfaceBoxLength
1035  * @extends GoMeasurement
1036  * @ingroup GoSdk-SurfaceTools
1037  * @brief Represents a length measurement for a Surface Bounding Box tool.
1038  */
1040 
1041 /**
1042  * @class GoSurfaceBoxWidth
1043  * @extends GoMeasurement
1044  * @ingroup GoSdk-SurfaceTools
1045  * @brief Represents a width measurement for a Surface Bounding Box tool.
1046  */
1048 
1049 /**
1050  * @class GoSurfaceBoxHeight
1051  * @extends GoMeasurement
1052  * @ingroup GoSdk-SurfaceTools
1053  * @brief Represents a height measurement for a Surface Bounding Box tool.
1054  */
1056 
1057 
1058 /**
1059  * @class GoSurfaceDimWidth
1060  * @extends GoMeasurement
1061  * @ingroup GoSdk-SurfaceTools
1062  * @brief Represents a width value measurement for a Surface Dimension Tool.
1063  */
1065 
1066 /**
1067  * Returns a boolean value representing whether an absolute measurement value will be returned.
1068  *
1069  * @public @memberof GoSurfaceDimWidth
1070  * @version Introduced in firmware 4.4.4.14
1071  * @param measurement GoSurfaceDimWidth object.
1072  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1073  */
1074 GoFx(kBool) GoSurfaceDimWidth_AbsoluteEnabled(GoSurfaceDimWidth measurement);
1075 
1076 /**
1077  * Enables or disables an absolute value result for the given measurement.
1078  *
1079  * @public @memberof GoSurfaceDimWidth
1080  * @version Introduced in firmware 4.4.4.14
1081  * @param measurement GoSurfaceDimWidth object.
1082  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1083  * @return Operation status.
1084  */
1085 GoFx(kStatus) GoSurfaceDimWidth_EnableAbsolute(GoSurfaceDimWidth measurement, kBool absolute);
1086 
1087 /**
1088  * @class GoSurfaceDimHeight
1089  * @extends GoMeasurement
1090  * @ingroup GoSdk-SurfaceTools
1091  * @brief Represents a height value measurement for a Surface Dimension Tool.
1092  */
1094 
1095 /**
1096  * Returns a boolean value representing whether an absolute measurement value will be returned.
1097  *
1098  * @public @memberof GoSurfaceDimHeight
1099  * @version Introduced in firmware 4.4.4.14
1100  * @param measurement GoSurfaceDimHeight object.
1101  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1102  */
1103 GoFx(kBool) GoSurfaceDimHeight_AbsoluteEnabled(GoSurfaceDimHeight measurement);
1104 
1105 /**
1106  * Enables or disables an absolute value result for the given measurement.
1107  *
1108  * @public @memberof GoSurfaceDimHeight
1109  * @version Introduced in firmware 4.4.4.14
1110  * @param measurement GoSurfaceDimHeight object.
1111  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1112  * @return Operation status.
1113  */
1114 GoFx(kStatus) GoSurfaceDimHeight_EnableAbsolute(GoSurfaceDimHeight measurement, kBool absolute);
1115 
1116 /**
1117  * @class GoSurfaceDimLength
1118  * @extends GoMeasurement
1119  * @ingroup GoSdk-SurfaceTools
1120  * @brief Represents a Length value measurement for a Surface Dimension Tool.
1121  */
1123 
1124 /**
1125  * Returns a boolean value representing whether an absolute measurement value will be returned.
1126  *
1127  * @public @memberof GoSurfaceDimLength
1128  * @version Introduced in firmware 4.4.4.14
1129  * @param measurement GoSurfaceDimLength object.
1130  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1131  */
1132 GoFx(kBool) GoSurfaceDimLength_AbsoluteEnabled(GoSurfaceDimLength measurement);
1133 
1134 /**
1135  * Enables or disables an absolute value result for the given measurement.
1136  *
1137  * @public @memberof GoSurfaceDimLength
1138  * @version Introduced in firmware 4.4.4.14
1139  * @param measurement GoSurfaceDimLength object.
1140  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1141  * @return Operation status.
1142  */
1143 GoFx(kStatus) GoSurfaceDimLength_EnableAbsolute(GoSurfaceDimLength measurement, kBool absolute);
1144 
1145 /**
1146  * @class GoSurfaceDimDistance
1147  * @extends GoMeasurement
1148  * @ingroup GoSdk-SurfaceTools
1149  * @brief Represents a distance value measurement for a Surface Dimension Tool.
1150  */
1152 
1153 /**
1154  * @class GoSurfaceDimPlaneDistance
1155  * @extends GoMeasurement
1156  * @ingroup GoSdk-SurfaceTools
1157  * @brief Represents a distance value measurement for a Surface Dimension Tool.
1158  */
1160 
1161 /**
1162  * @class GoSurfaceDimCenterX
1163  * @extends GoMeasurement
1164  * @ingroup GoSdk-SurfaceTools
1165  * @brief Represents a center X value measurement for a Surface Dimension Tool.
1166  */
1168 
1169 /**
1170  * @class GoSurfaceDimCenterY
1171  * @extends GoMeasurement
1172  * @ingroup GoSdk-SurfaceTools
1173  * @brief Represents a center Y value measurement for a Surface Dimension Tool.
1174  */
1176 
1177 
1178 /**
1179  * @class GoSurfaceDimCenterZ
1180  * @extends GoMeasurement
1181  * @ingroup GoSdk-SurfaceTools
1182  * @brief Represents a center Z value measurement for a Surface Dimension Tool.
1183  */
1185 
1186 /**
1187  * @class GoSurfaceEllipseMajor
1188  * @extends GoMeasurement
1189  * @ingroup GoSdk-SurfaceTools
1190  * @brief Represents a major value measurement for a Surface Ellipse tool.
1191  */
1193 
1194 /**
1195  * @class GoSurfaceEllipseMinor
1196  * @extends GoMeasurement
1197  * @ingroup GoSdk-SurfaceTools
1198  * @brief Represents a minor value measurement for a Surface Ellipse tool.
1199  */
1201 
1202 /**
1203  * @class GoSurfaceEllipseRatio
1204  * @extends GoMeasurement
1205  * @ingroup GoSdk-SurfaceTools
1206  * @brief Represents a ratio measurement for a Surface Ellipse tool.
1207  */
1209 
1210 /**
1211  * @class GoSurfaceEllipseZAngle
1212  * @extends GoMeasurement
1213  * @ingroup GoSdk-SurfaceTools
1214  * @brief Represents a Z-angle measurement for a Surface Ellipse tool.
1215  */
1217 
1218 /**
1219  * @class GoSurfaceHoleX
1220  * @extends GoMeasurement
1221  * @ingroup GoSdk-SurfaceTools
1222  * @brief Represents an X measurement for a Surface Hole Tool.
1223  */
1225 
1226 /**
1227  * @class GoSurfaceHoleY
1228  * @extends GoMeasurement
1229  * @ingroup GoSdk-SurfaceTools
1230  * @brief Represents a Y measurement for a Surface Hole Tool.
1231  */
1233 
1234 /**
1235  * @class GoSurfaceHoleZ
1236  * @extends GoMeasurement
1237  * @ingroup GoSdk-SurfaceTools
1238  * @brief Represents a Z measurement for a Surface Hole Tool.
1239  */
1241 
1242 /**
1243  * @class GoSurfaceHoleRadius
1244  * @extends GoMeasurement
1245  * @ingroup GoSdk-SurfaceTools
1246  * @brief Represents a radius measurement for a Surface Hole Tool.
1247  */
1249 
1250 
1251 /**
1252  * @class GoSurfaceOpeningX
1253  * @extends GoMeasurement
1254  * @ingroup GoSdk-SurfaceTools
1255  * @brief Represents an X measurement for a Surface Opening Tool.
1256  */
1258 
1259 /**
1260  * @class GoSurfaceOpeningY
1261  * @extends GoMeasurement
1262  * @ingroup GoSdk-SurfaceTools
1263  * @brief Represents a Y measurement for a Surface Opening Tool.
1264  */
1266 
1267 /**
1268  * @class GoSurfaceOpeningZ
1269  * @extends GoMeasurement
1270  * @ingroup GoSdk-SurfaceTools
1271  * @brief Represents a Z measurement for a Surface Opening Tool.
1272  */
1274 
1275 /**
1276  * @class GoSurfaceOpeningWidth
1277  * @extends GoMeasurement
1278  * @ingroup GoSdk-SurfaceTools
1279  * @brief Represents a width measurement for a Surface Opening Tool.
1280  */
1282 
1283 /**
1284  * @class GoSurfaceOpeningLength
1285  * @extends GoMeasurement
1286  * @ingroup GoSdk-SurfaceTools
1287  * @brief Represents a length measurement for a Surface Opening Tool.
1288  */
1290 
1291 /**
1292  * @class GoSurfaceOpeningAngle
1293  * @extends GoMeasurement
1294  * @ingroup GoSdk-SurfaceTools
1295  * @brief Represents an angle measurement for a Surface Opening Tool.
1296  */
1298 
1299 
1300 /**
1301  * @class GoSurfacePlaneXAngle
1302  * @extends GoMeasurement
1303  * @ingroup GoSdk-SurfaceTools
1304  * @brief Represents an X-angle measurement for a Surface Plane Tool.
1305  */
1307 
1308 /**
1309  * @class GoSurfacePlaneYAngle
1310  * @extends GoMeasurement
1311  * @ingroup GoSdk-SurfaceTools
1312  * @brief Represents a Y-angle measurement for a Surface Plane Tool.
1313  */
1315 
1316 /**
1317  * @class GoSurfacePlaneZOffset
1318  * @extends GoMeasurement
1319  * @ingroup GoSdk-SurfaceTools
1320  * @brief Represents a Z-offset measurement for a Surface Plane Tool.
1321  */
1323 
1324 /**
1325  * @class GoSurfacePlaneStdDev
1326  * @extends GoMeasurement
1327  * @ingroup GoSdk-SurfaceTools
1328  * @brief Represents a Standard Deviation measurement for a Surface Plane Tool.
1329  */
1331 
1332 /**
1333  * @class GoSurfacePlaneMaxError
1334  * @extends GoMeasurement
1335  * @ingroup GoSdk-SurfaceTools
1336  * @brief Represents a Maximum Error measurement for a Surface Plane Tool.
1337  */
1339 
1340 /**
1341  * @class GoSurfacePlaneMinError
1342  * @extends GoMeasurement
1343  * @ingroup GoSdk-SurfaceTools
1344  * @brief Represents a Minimum Error measurement for a Surface Plane Tool.
1345  */
1347 
1348 
1349 /**
1350  * @class GoSurfacePositionX
1351  * @extends GoMeasurement
1352  * @ingroup GoSdk-SurfaceTools
1353  * @brief Represents an X measurement for a Surface Position Tool.
1354  */
1356 
1357 /**
1358  * @class GoSurfacePositionY
1359  * @extends GoMeasurement
1360  * @ingroup GoSdk-SurfaceTools
1361  * @brief Represents a Y measurement for a Surface Position Tool.
1362  */
1364 
1365 /**
1366  * @class GoSurfacePositionZ
1367  * @extends GoMeasurement
1368  * @ingroup GoSdk-SurfaceTools
1369  * @brief Represents a Z measurement for a Surface Position Tool.
1370  */
1372 
1373 
1374 /**
1375  * @class GoSurfaceStudBaseX
1376  * @extends GoMeasurement
1377  * @ingroup GoSdk-SurfaceTools
1378  * @brief Represents a base X measurement for a Surface Stud Tool.
1379  */
1381 
1382 /**
1383  * @class GoSurfaceStudBaseY
1384  * @extends GoMeasurement
1385  * @ingroup GoSdk-SurfaceTools
1386  * @brief Represents a base Y measurement for a Surface Stud Tool.
1387  */
1389 
1390 /**
1391  * @class GoSurfaceStudBaseZ
1392  * @extends GoMeasurement
1393  * @ingroup GoSdk-SurfaceTools
1394  * @brief Represents a base Z measurement for a Surface Stud Tool.
1395  */
1397 
1398 /**
1399  * @class GoSurfaceStudTipX
1400  * @extends GoMeasurement
1401  * @ingroup GoSdk-SurfaceTools
1402  * @brief Represents a tip X measurement for a Surface Stud Tool.
1403  */
1405 
1406 /**
1407  * @class GoSurfaceStudTipY
1408  * @extends GoMeasurement
1409  * @ingroup GoSdk-SurfaceTools
1410  * @brief Represents a tip Y measurement for a Surface Stud Tool.
1411  */
1413 
1414 /**
1415  * @class GoSurfaceStudTipZ
1416  * @extends GoMeasurement
1417  * @ingroup GoSdk-SurfaceTools
1418  * @brief Represents a tip Z measurement for a Surface Stud Tool.
1419  */
1421 
1422 /**
1423  * @class GoSurfaceStudRadius
1424  * @extends GoMeasurement
1425  * @ingroup GoSdk-SurfaceTools
1426  * @brief Represents a radius measurement for a Surface Stud Tool.
1427  */
1429 
1430 /**
1431  * Gets the radius offset.
1432  *
1433  * @public @memberof GoSurfaceStudRadius
1434  * @version Introduced in firmware 4.0.10.27
1435  * @param measurement GoSurfaceStudRadius object.
1436  * @return The surface location.
1437  */
1438 GoFx(k64f) GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement);
1439 
1440 /**
1441  * Sets the radius offset.
1442  *
1443  * @public @memberof GoSurfaceStudRadius
1444  * @version Introduced in firmware 4.0.10.27
1445  * @param measurement GoSurfaceStudRadius object.
1446  * @param value The offset value to set.
1447  * @return Operation status.
1448  */
1449 GoFx(kStatus) GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value);
1450 
1451 /**
1452  * @class GoSurfaceVolumeVolume
1453  * @extends GoMeasurement
1454  * @ingroup GoSdk-SurfaceTools
1455  * @brief Represents a volume measurement for a Surface Volume Tool.
1456  */
1458 
1459 /**
1460  * @class GoSurfaceVolumeArea
1461  * @extends GoMeasurement
1462  * @ingroup GoSdk-SurfaceTools
1463  * @brief Represents an area measurement for a Surface Volume Tool.
1464  */
1466 
1467 /**
1468  * @class GoSurfaceVolumeThickness
1469  * @extends GoMeasurement
1470  * @ingroup GoSdk-SurfaceTools
1471  * @brief Represents a thickness measurement for a Surface Volume Tool.
1472  */
1474 
1475 /**
1476  * Gets the location.
1477  *
1478  * @public @memberof GoSurfaceVolumeThickness
1479  * @version Introduced in firmware 4.0.10.27
1480  * @param measurement GoSurfaceVolumeThickness object.
1481  * @return The surface location.
1482  */
1483 GoFx(GoSurfaceLocation) GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement);
1484 
1485 /**
1486  * Sets the location.
1487  *
1488  * @public @memberof GoSurfaceVolumeThickness
1489  * @version Introduced in firmware 4.0.10.27
1490  * @param measurement GoSurfaceVolumeThickness object.
1491  * @param location The surface location.
1492  * @return Operation status.
1493  */
1494 GoFx(kStatus) GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location);
1495 
1496 /**
1497  * @class GoSurfaceCountersunkHoleX
1498  * @extends GoMeasurement
1499  * @ingroup GoSdk-SurfaceTools
1500  * @brief Represents an X position measurement for a Surface Counter Sunk Hole Tool.
1501  */
1503 
1504 /**
1505  * @class GoSurfaceCountersunkHoleY
1506  * @extends GoMeasurement
1507  * @ingroup GoSdk-SurfaceTools
1508  * @brief Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
1509  */
1511 
1512 /**
1513  * @class GoSurfaceCountersunkHoleZ
1514  * @extends GoMeasurement
1515  * @ingroup GoSdk-SurfaceTools
1516  * @brief Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
1517  */
1519 
1520 /**
1521  * @class GoSurfaceCountersunkHoleOuterRadius
1522  * @extends GoMeasurement
1523  * @ingroup GoSdk-SurfaceTools
1524  * @brief Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
1525  */
1527 
1528 /**
1529  * @class GoSurfaceCountersunkHoleDepth
1530  * @extends GoMeasurement
1531  * @ingroup GoSdk-SurfaceTools
1532  * @brief Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
1533  */
1535 
1536 /**
1537  * @class GoSurfaceCountersunkHoleBevelRadius
1538  * @extends GoMeasurement
1539  * @ingroup GoSdk-SurfaceTools
1540  * @brief Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
1541  */
1543 
1544 /**
1545  * @class GoSurfaceCountersunkHoleBevelAngle
1546  * @extends GoMeasurement
1547  * @ingroup GoSdk-SurfaceTools
1548  * @brief Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
1549  */
1551 
1552 /**
1553  * @class GoSurfaceCountersunkHoleXAngle
1554  * @extends GoMeasurement
1555  * @ingroup GoSdk-SurfaceTools
1556  * @brief Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
1557  */
1559 
1560 /**
1561  * @class GoSurfaceCountersunkHoleYAngle
1562  * @extends GoMeasurement
1563  * @ingroup GoSdk-SurfaceTools
1564  * @brief Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
1565  */
1567 
1568 /**
1569  * @class GoSurfaceCountersunkHoleCounterboreDepth
1570  * @extends GoMeasurement
1571  * @ingroup GoSdk-SurfaceTools
1572  * @brief Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
1573  */
1575 
1576 /**
1577  * @class GoSurfaceCountersunkHoleAxisTilt
1578  * @extends GoMeasurement
1579  * @ingroup GoSdk-SurfaceTools
1580  * @brief Represents a axis tilt measurement for a Surface Counter Sunk Hole Tool.
1581  */
1583 
1584 /**
1585  * @class GoSurfaceCountersunkHoleAxisOrientation
1586  * @extends GoMeasurement
1587  * @ingroup GoSdk-SurfaceTools
1588  * @brief Represents a axis orientation measurement for a Surface Counter Sunk Hole Tool.
1589  */
1591 
1592 /// @endcond
1593 
1594 
1595 /**
1596  * @class GoScriptOutput
1597  * @extends GoMeasurement
1598  * @ingroup GoSdk-Tools
1599  * @brief Represents a script output for a Script Tool.
1600  */
1602 
1603 kEndHeader()
1604 #include <GoSdk/Tools/GoMeasurements.x.h>
1605 
1606 #endif
Represents a Y-angle measurement for a Surface Plane Tool.
Represents a global Z angle measurement for a Surface Bounding Box tool.
kStatus GoProfileGrooveZ_SetSelectIndex(GoProfileGrooveZ measurement, k32u selectN)
Sets the selected groove index.
kStatus GoProfilePanelGap_SetAxis(GoProfilePanelGap measurement, GoProfileGapAxis axis)
Sets the gap axis.
kStatus GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
kStatus GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
kStatus GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value)
Sets the radius offset.
Represents an X value measurement for a Profile Circle Tool.
Represents a Z-angle measurement for a Surface Bounding Box tool.
kStatus GoProfileDimWidth_EnableAbsolute(GoProfileDimWidth measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
Represents the base class for a tool measurement or script output.
Represents a radius measurement for a Surface Stud Tool.
kStatus GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location)
Sets the location.
Represents a length measurement for a Surface Bounding Box tool.
k32u GoProfileGrooveX_SelectIndex(GoProfileGrooveX measurement)
Gets the current selected groove index.
GoProfileGrooveLocation GoProfileStripZ_Location(GoProfileStripZ measurement)
Gets the groove location configuration value.
Represents a Z measurement for a Profile Bounding Box tool.
Represents a Standard Deviation measurement for a Surface Plane Tool.
GoProfileGrooveLocation GoProfileGrooveZ_Location(GoProfileGrooveZ measurement)
Gets the current groove location type.
Represents a width value measurement for a Surface Dimension Tool.
Represents a Y measurement for a Surface Hole Tool.
k32u GoProfileStripX_SelectIndex(GoProfileStripX measurement)
Gets the select index.
Represents a Z measurement for a Surface Opening Tool.
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement)
Gets the current groove selection type.
Declares the GoMeasurement class.
kBool GoSurfaceDimLength_AbsoluteEnabled(GoSurfaceDimLength measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
Represents an area measurement for a Surface Volume Tool.
Represents a Maximum Error measurement for a Surface Plane Tool.
Represents a gap measurement for a Profile Panel Tool.
Represents a center X value measurement for a Surface Dimension Tool.
Represents an height measurement for a Profile Strip Tool.
Represents a Minimum Error measurement for a Surface Plane Tool.
Represents a minor value measurement for a Surface Ellipse tool.
Represents a base Y measurement for a Surface Stud Tool.
Represents a center X value measurement for a Profile Dimension Tool.
Represents a Z-angle measurement for a Surface Ellipse tool.
Represents a flush measurement for a Profile Panel Tool.
kStatus GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex)
Sets the select index.
Represents a Z-offset measurement for a Surface Plane Tool.
Represents a width measurement for a Profile Groove Tool.
kStatus GoSurfaceDimWidth_EnableAbsolute(GoSurfaceDimWidth measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
kStatus GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex)
Sets the select index.
Represents a tip X measurement for a Surface Stud Tool.
kStatus GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location)
Sets the location.
kStatus GoProfileGrooveX_SetSelectIndex(GoProfileGrooveX measurement, k32u selectN)
Sets the selected groove index.
Represents a Z measurement for a Profile Strip Tool.
kBool GoProfileDimWidth_AbsoluteEnabled(GoProfileDimWidth measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
Represents an Z measurement for a Profile Round Corner tool.
Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
Represents a width value measurement for a Profile Dimension Tool.
kStatus GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
Represents a axis orientation measurement for a Surface Counter Sunk Hole Tool.
Represents an angle measurement for a Profile Bridge Value tool.
kStatus GoSurfaceDimHeight_EnableAbsolute(GoSurfaceDimHeight measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
kStatus GoProfilePanelFlush_EnableAbsolute(GoProfilePanelFlush measurement, kBool absolute)
Enables or disables the absolute value state.
k32u GoProfileGrooveDepth_SelectIndex(GoProfileGrooveDepth measurement)
Gets the current selected groove index.
Represents a width measurement for a Profile Strip Tool.
Represents an X value measurement for a Profile Groove Tool.
GoProfileGrooveSelectType GoProfileGrooveDepth_SelectType(GoProfileGrooveDepth measurement)
Gets the current groove selection type.
Represents an intersect X measurement for a Profile Intersect Tool.
GoProfileGrooveLocation GoProfileGrooveX_Location(GoProfileGrooveX measurement)
Gets the current groove location.
Represents an X measurement for a Surface Hole Tool.
Represents a maximum error measurement for a Profile Line Tool.
kStatus GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location)
Sets the groove location type.
kStatus GoSurfaceDimLength_EnableAbsolute(GoSurfaceDimLength measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
Represents a Y measurement for a Surface Opening Tool.
Represents a script output for a Script Tool.
Represents a centroid Z measurement for a Profile Area Tool.
Represents an X-angle measurement for a Surface Plane Tool.
kStatus GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value)
Sets the groove location.
Represents a major value measurement for a Surface Ellipse tool.
Represents an X measurement for a Surface Position Tool.
kStatus GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
GoProfileGrooveSelectType GoProfileStripX_SelectType(GoProfileStripX measurement)
Gets the select type.
Represents an area measurement for a Profile Area tool.
Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
Represents a height measurement for a Profile Bounding Box tool.
Represents a distance value measurement for a Surface Dimension Tool.
Represents a global angle measurement for a Profile Bounding Box tool.
Represents a minimum error measurement for a Profile Line Tool.
Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
k32u GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement)
Gets the current selected groove index.
Represents a tip Y measurement for a Surface Stud Tool.
Determines which groove to select when multiple are present.
Represents an Z measurement for a Profile Position tool.
Essential SDK declarations.
Represents a surface location.
kStatus GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileGrooveLocation GoProfileStripHeight_Location(GoProfileStripHeight measurement)
Gets the groove location setting.
Represents a width measurement for a Surface Opening Tool.
Represents a distance value measurement for a Surface Dimension Tool.
Represents a percentile measurement for a Profile Line Tool.
kBool GoProfilePanelFlush_AbsoluteEnabled(GoProfilePanelFlush measurement)
Gets absolute value state.
kStatus GoProfileGrooveWidth_SetSelectType(GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
kStatus GoProfileGrooveWidth_SetSelectIndex(GoProfileGrooveWidth measurement, k32u selectN)
Sets the selected groove index.
kStatus GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex)
Sets the select index.
kStatus GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex)
Sets the select index.
k32u GoProfileStripZ_SelectIndex(GoProfileStripZ measurement)
Gets the select index.
Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
Represents an X measurement for a Profile Bounding Box tool.
kStatus GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN)
Sets the selected groove index.
Represents an X measurement for a Surface Bounding Box tool.
Represents a base X measurement for a Surface Stud Tool.
Represents an X measurement for a Surface Opening Tool.
Represents a height value measurement for a Profile Dimension Tool.
Represents an X position measurement for a Surface Counter Sunk Hole Tool.
Represents a thickness measurement for a Surface Volume Tool.
Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
Represents a width measurement for a Surface Bounding Box tool.
kStatus GoProfileLinePercentile_SetPercent(GoProfileLinePercentile measurement, k64f percent)
Sets the percent threshold.
GoProfileGrooveSelectType GoProfileGrooveZ_SelectType(GoProfileGrooveZ measurement)
Gets the current groove selection type.
Represents a global X measurement for a Surface Bounding Box tool.
Represents an angle measurement for a Surface Opening Tool.
Represents a Z value measurement for a Profile Circle Tool.
GoProfileGrooveSelectType GoProfileStripZ_SelectType(GoProfileStripZ measurement)
Gets the select type.
Represents a global Y measurement for a Profile Bounding Box tool.
Represents a Y measurement for a Surface Position Tool.
GoProfileGapAxis GoProfilePanelGap_Axis(GoProfilePanelGap measurement)
Gets the gap axis.
k32u GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement)
Gets the select index.
kBool GoSurfaceDimHeight_AbsoluteEnabled(GoSurfaceDimHeight measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
Determines which groove position to return.
kStatus GoProfileIntersectAngle_EnableRange0to180(GoProfileIntersectAngle measurement, kBool enable)
Enables or disables a result in the range of 0 to 180 instead of -90 to 90 degrees for the given meas...
GoSurfaceLocation GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement)
Gets the location.
Represents a height measurement for a Surface Bounding Box tool.
Represents a tip Z measurement for a Surface Stud Tool.
Represents an X measurement for a Profile Strip Tool.
GoProfileGrooveSelectType GoProfileGrooveX_SelectType(GoProfileGrooveX measurement)
Gets the current groove selection type.
Represents an X measurement for a Profile Round Corner tool.
k64f GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement)
Gets the percent threshold.
Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
Represents a center Z value measurement for a Surface Dimension Tool.
Represents a profile gap measurement axis.
kStatus GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
Represents a Y measurement for a Surface Bounding Box tool.
Represents a height value measurement for a Surface Dimension Tool.
Represents a volume measurement for a Surface Volume Tool.
kStatus GoProfileGrooveX_SetSelectType(GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
Represents a standard deviation measurement for a Profile Line Tool.
Represents a center Z value measurement for a Profile Dimension Tool.
Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
k32u GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement)
Gets the select index.
Represents a radius measurement for a Surface Hole Tool.
Represents a validity measurement for a Profile X-Line tool.
k32u GoProfileGrooveWidth_SelectIndex(GoProfileGrooveWidth measurement)
Gets the current selected groove index.
Represents a centroid X measurement for a Profile Area Tool.
Represents a depth measurement for a Profile Groove Tool.
kBool GoProfileDimHeight_AbsoluteEnabled(GoProfileDimHeight measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
Represents a global Y measurement for a Surface Bounding Box tool.
Represents an intersect angle measurement for a Profile Intersect Tool.
Represents a radius value measurement for a Profile Circle Tool.
Represents a Z measurement for a Surface Position Tool.
GoProfileGrooveLocation GoProfileStripX_Location(GoProfileStripX measurement)
Gets the groove location configuration value.
Represents an Z measurement for a Profile X-Line tool.
GoProfileGrooveSelectType GoProfileStripHeight_SelectType(GoProfileStripHeight measurement)
Gets the select type.
Represents a width measurement for a Profile Bounding Box tool.
kStatus GoProfileDimHeight_EnableAbsolute(GoProfileDimHeight measurement, kBool absolute)
Enables or disables an absolute value result for the given measurement.
Represents a Z value measurement for a Profile Groove tool.
Represents a axis tilt measurement for a Surface Counter Sunk Hole Tool.
Represents an intersect Z measurement for a Profile Intersect Tool.
Represents an X measurement for a Profile Position tool.
Represents a ratio measurement for a Surface Ellipse tool.
Represents a Z measurement for a Surface Hole Tool.
kStatus GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
Represents a length measurement for a Surface Opening Tool.
k64f GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement)
Gets the radius offset.
Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
Represents a Length value measurement for a Surface Dimension Tool.
Represents a bridge value measurement for a Profile Bridge Value tool.
kBool GoSurfaceDimWidth_AbsoluteEnabled(GoSurfaceDimWidth measurement)
Returns a boolean value representing whether an absolute measurement value will be returned...
Represents a center Y value measurement for a Surface Dimension Tool.
Represents a global X measurement for a Profile Bounding Box tool.
kStatus GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
Represents a Z measurement for a Surface Bounding Box tool.
Represents a base Z measurement for a Surface Stud Tool.
Represents an Angle measurement for a Profile Round Corner tool.
GoProfileGrooveSelectType GoProfileStripWidth_SelectType(GoProfileStripWidth measurement)
Gets the select type.
kBool GoProfileIntersectAngle_Range0to180Enabled(GoProfileIntersectAngle measurement)
Returns a boolean value representing whether a absolute measurement value in the range of 0 to 180 de...
Represents a distance value measurement for a Profile Dimension Tool.