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  */
28 
29 /**
30  * @class GoRangeThicknessThickness
31  * @extends GoMeasurement
32  * @ingroup GoSdk
33  * @brief Represents a the thickness measurement of a Range Thickness tool.
34  */
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 GoProfilePositionX
652  * @extends GoMeasurement
653  * @ingroup GoSdk-ProfileTools
654  * @brief Represents an X measurement for a Profile Position tool.
655  */
657 
658 /**
659  * @class GoProfilePositionZ
660  * @extends GoMeasurement
661  * @ingroup GoSdk-ProfileTools
662  * @brief Represents an Z measurement for a Profile Position tool.
663  */
665 
666 
667 /**
668  * @class GoProfileStripX
669  * @extends GoMeasurement
670  * @ingroup GoSdk-ProfileTools
671  * @brief Represents an X measurement for a Profile Strip Tool.
672  */
674 
675 /**
676  * Gets the groove location configuration value.
677  *
678  * @public @memberof GoProfileStripX
679  * @version Introduced in firmware 4.0.10.27
680  * @param measurement GoProfileStripX object.
681  * @return The profile groove location.
682  */
683 GoFx(GoProfileGrooveLocation) GoProfileStripX_Location(GoProfileStripX measurement);
684 
685 /**
686  * Sets the groove location configuration value.
687  *
688  * @public @memberof GoProfileStripX
689  * @version Introduced in firmware 4.0.10.27
690  * @param measurement GoProfileStripX object.
691  * @param location The groove location value to set.
692  * @return Operation status.
693  */
694 GoFx(kStatus) GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location);
695 
696 /**
697  * Gets the select type.
698  *
699  * @public @memberof GoProfileStripX
700  * @version Introduced in firmware 4.0.10.27
701  * @param measurement GoProfileStripX object.
702  * @return The select type.
703  */
704 GoFx(GoProfileGrooveSelectType) GoProfileStripX_SelectType(GoProfileStripX measurement);
705 
706 /**
707  * Sets the select type.
708  *
709  * @public @memberof GoProfileStripX
710  * @version Introduced in firmware 4.0.10.27
711  * @param measurement GoProfileStripX object.
712  * @param selectType The select type to set.
713  * @return Operation status.
714  */
715 GoFx(kStatus) GoProfileStripX_SetSelectType(GoProfileStripX measurement, GoProfileGrooveSelectType selectType);
716 
717 /**
718  * Gets the select index.
719  *
720  * @public @memberof GoProfileStripX
721  * @version Introduced in firmware 4.0.10.27
722  * @param measurement GoProfileStripX object.
723  * @return The select index.
724  */
725 GoFx(k32u) GoProfileStripX_SelectIndex(GoProfileStripX measurement);
726 
727 /**
728  * Sets the select index.
729  *
730  * @public @memberof GoProfileStripX
731  * @version Introduced in firmware 4.0.10.27
732  * @param measurement GoProfileStripX object.
733  * @param selectIndex The select index value to set.
734  * @return Operation status.
735  */
736 GoFx(kStatus) GoProfileStripX_SetSelectIndex(GoProfileStripX measurement, k32u selectIndex);
737 
738 
739 /**
740  * @class GoProfileStripZ
741  * @extends GoMeasurement
742  * @ingroup GoSdk-ProfileTools
743  * @brief Represents a Z measurement for a Profile Strip Tool.
744  */
746 
747 /**
748  * Gets the groove location configuration value.
749  *
750  * @public @memberof GoProfileStripZ
751  * @version Introduced in firmware 4.0.10.27
752  * @param measurement GoProfileStripZ object.
753  * @return The profile groove location.
754  */
755 GoFx(GoProfileGrooveLocation) GoProfileStripZ_Location(GoProfileStripZ measurement);
756 
757 /**
758  * Sets the groove location configuration value.
759  *
760  * @public @memberof GoProfileStripZ
761  * @version Introduced in firmware 4.0.10.27
762  * @param measurement GoProfileStripZ object.
763  * @param location The profile groove location to set.
764  * @return Operation status.
765  */
766 GoFx(kStatus) GoProfileStripZ_SetLocation(GoProfileStripZ measurement, GoProfileGrooveLocation location);
767 
768 /**
769  * Gets the select type.
770  *
771  * @public @memberof GoProfileStripZ
772  * @version Introduced in firmware 4.0.10.27
773  * @param measurement GoProfileStripZ object.
774  * @return The select type.
775  */
776 GoFx(GoProfileGrooveSelectType) GoProfileStripZ_SelectType(GoProfileStripZ measurement);
777 
778 /**
779  * Sets the select type.
780  *
781  * @public @memberof GoProfileStripZ
782  * @version Introduced in firmware 4.0.10.27
783  * @param measurement GoProfileStripZ object.
784  * @param selectType The select type to set.
785  * @return Operation status.
786  */
787 GoFx(kStatus) GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType);
788 
789 /**
790  * Gets the select index.
791  *
792  * @public @memberof GoProfileStripZ
793  * @version Introduced in firmware 4.0.10.27
794  * @param measurement GoProfileStripZ object.
795  * @return The select index.
796  */
797 GoFx(k32u) GoProfileStripZ_SelectIndex(GoProfileStripZ measurement);
798 
799 /**
800  * Sets the select index.
801  *
802  * @public @memberof GoProfileStripZ
803  * @version Introduced in firmware 4.0.10.27
804  * @param measurement GoProfileStripZ object.
805  * @param selectIndex The select index value to set.
806  * @return Operation status.
807  */
808 GoFx(kStatus) GoProfileStripZ_SetSelectIndex(GoProfileStripZ measurement, k32u selectIndex);
809 
810 
811 /**
812  * @class GoProfileStripWidth
813  * @extends GoMeasurement
814  * @ingroup GoSdk-ProfileTools
815  * @brief Represents a width measurement for a Profile Strip Tool.
816  */
818 
819 /**
820  * Gets the select type.
821  *
822  * @public @memberof GoProfileStripWidth
823  * @version Introduced in firmware 4.0.10.27
824  * @param measurement GoProfileStripWidth object.
825  * @return The select type.
826  */
827 GoFx(GoProfileGrooveSelectType) GoProfileStripWidth_SelectType(GoProfileStripWidth measurement);
828 
829 /**
830  * Sets the select type.
831  *
832  * @public @memberof GoProfileStripWidth
833  * @version Introduced in firmware 4.0.10.27
834  * @param measurement GoProfileStripWidth object.
835  * @param selectType The select type to set.
836  * @return Operation status.
837  */
838 GoFx(kStatus) GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType);
839 
840 /**
841  * Gets the select index.
842  *
843  * @public @memberof GoProfileStripWidth
844  * @version Introduced in firmware 4.0.10.27
845  * @param measurement GoProfileStripWidth object.
846  * @return The select index.
847  */
848 GoFx(k32u) GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement);
849 
850 /**
851  * Sets the select index.
852  *
853  * @public @memberof GoProfileStripWidth
854  * @version Introduced in firmware 4.0.10.27
855  * @param measurement GoProfileStripWidth object.
856  * @param selectIndex The select index value to set.
857  * @return Operation status.
858  */
859 GoFx(kStatus) GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex);
860 
861 
862 /**
863  * @class GoProfileStripHeight
864  * @extends GoMeasurement
865  * @ingroup GoSdk-ProfileTools
866  * @brief Represents an height measurement for a Profile Strip Tool.
867  */
869 
870 /**
871  * Gets the groove location setting.
872  *
873  * @public @memberof GoProfileStripHeight
874  * @version Introduced in firmware 4.0.10.27
875  * @param measurement GoProfileStripHeight object.
876  * @return The groove location setting.
877  */
878 GoFx(GoProfileGrooveLocation) GoProfileStripHeight_Location(GoProfileStripHeight measurement);
879 
880 /**
881  * Sets the location.
882  *
883  * @public @memberof GoProfileStripHeight
884  * @version Introduced in firmware 4.0.10.27
885  * @param measurement GoProfileStripHeight object.
886  * @param location The location value to set.
887  * @return Operation status.
888  */
889 GoFx(kStatus) GoProfileStripHeight_SetLocation(GoProfileStripHeight measurement, GoProfileGrooveLocation location);
890 
891 /**
892  * Gets the select type.
893  *
894  * @public @memberof GoProfileStripHeight
895  * @version Introduced in firmware 4.0.10.27
896  * @param measurement GoProfileStripHeight object.
897  * @return The select type.
898  */
899 GoFx(GoProfileGrooveSelectType) GoProfileStripHeight_SelectType(GoProfileStripHeight measurement);
900 
901 /**
902  * Sets the select type.
903  *
904  * @public @memberof GoProfileStripHeight
905  * @version Introduced in firmware 4.0.10.27
906  * @param measurement GoProfileStripHeight object.
907  * @param selectType The select type value to set.
908  * @return Operation status.
909  */
910 GoFx(kStatus) GoProfileStripHeight_SetSelectType(GoProfileStripHeight measurement, GoProfileGrooveSelectType selectType);
911 
912 /**
913  * Gets the select index.
914  *
915  * @public @memberof GoProfileStripHeight
916  * @version Introduced in firmware 4.0.10.27
917  * @param measurement GoProfileStripHeight object.
918  * @return The select index.
919  */
920 GoFx(k32u) GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement);
921 
922 /**
923  * Sets the select index.
924  *
925  * @public @memberof GoProfileStripHeight
926  * @version Introduced in firmware 4.0.10.27
927  * @param measurement GoProfileStripHeight object.
928  * @param selectIndex The select index value to set.
929  * @return Operation status.
930  */
931 GoFx(kStatus) GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex);
932 
933 /**
934 * @class GoProfileXLineZ
935 * @extends GoMeasurement
936 * @ingroup GoSdk-ProfileTools
937 * @brief Represents an Z measurement for a Profile X-Line tool.
938 */
940 
941 /**
942 * @class GoProfileXLineValidity
943 * @extends GoMeasurement
944 * @ingroup GoSdk-ProfileTools
945 * @brief Represents a validity measurement for a Profile X-Line tool.
946 */
948 
949 
950 /// @cond (Gocator_2x00 || Gocator_3x00)
951 
952 /**
953  * @class GoSurfaceBoxX
954  * @extends GoMeasurement
955  * @ingroup GoSdk-SurfaceTools
956  * @brief Represents an X measurement for a Surface Bounding Box tool.
957  */
958 typedef GoMeasurement GoSurfaceBoxX;
959 
960 /**
961  * @class GoSurfaceBoxY
962  * @extends GoMeasurement
963  * @ingroup GoSdk-SurfaceTools
964  * @brief Represents a Y measurement for a Surface Bounding Box tool.
965  */
966 typedef GoMeasurement GoSurfaceBoxY;
967 
968 /**
969  * @class GoSurfaceBoxZ
970  * @extends GoMeasurement
971  * @ingroup GoSdk-SurfaceTools
972  * @brief Represents a Z measurement for a Surface Bounding Box tool.
973  */
974 typedef GoMeasurement GoSurfaceBoxZ;
975 
976 
977 /**
978  * @class GoSurfaceBoxZAngle
979  * @extends GoMeasurement
980  * @ingroup GoSdk-SurfaceTools
981  * @brief Represents a Z-angle measurement for a Surface Bounding Box tool.
982  */
983 typedef GoMeasurement GoSurfaceBoxZAngle;
984 
985 /**
986  * @class GoSurfaceBoxGlobalX
987  * @extends GoMeasurement
988  * @ingroup GoSdk-SurfaceTools
989  * @brief Represents a global X measurement for a Surface Bounding Box tool.
990  */
991 typedef GoMeasurement GoSurfaceBoxGlobalX;
992 
993 /**
994  * @class GoSurfaceBoxGlobalY
995  * @extends GoMeasurement
996  * @ingroup GoSdk-SurfaceTools
997  * @brief Represents a global Y measurement for a Surface Bounding Box tool.
998  */
999 typedef GoMeasurement GoSurfaceBoxGlobalY;
1000 
1001 /**
1002  * @class GoSurfaceBoxGlobalZAngle
1003  * @extends GoMeasurement
1004  * @ingroup GoSdk-SurfaceTools
1005  * @brief Represents a global Z angle measurement for a Surface Bounding Box tool.
1006  */
1007 typedef GoMeasurement GoSurfaceBoxGlobalZAngle;
1008 
1009 /**
1010  * @class GoSurfaceBoxLength
1011  * @extends GoMeasurement
1012  * @ingroup GoSdk-SurfaceTools
1013  * @brief Represents a length measurement for a Surface Bounding Box tool.
1014  */
1015 typedef GoMeasurement GoSurfaceBoxLength;
1016 
1017 /**
1018  * @class GoSurfaceBoxWidth
1019  * @extends GoMeasurement
1020  * @ingroup GoSdk-SurfaceTools
1021  * @brief Represents a width measurement for a Surface Bounding Box tool.
1022  */
1023 typedef GoMeasurement GoSurfaceBoxWidth;
1024 
1025 /**
1026  * @class GoSurfaceBoxHeight
1027  * @extends GoMeasurement
1028  * @ingroup GoSdk-SurfaceTools
1029  * @brief Represents a height measurement for a Surface Bounding Box tool.
1030  */
1031 typedef GoMeasurement GoSurfaceBoxHeight;
1032 
1033 
1034 /**
1035  * @class GoSurfaceDimWidth
1036  * @extends GoMeasurement
1037  * @ingroup GoSdk-SurfaceTools
1038  * @brief Represents a width value measurement for a Surface Dimension Tool.
1039  */
1040 typedef GoMeasurement GoSurfaceDimWidth;
1041 
1042 /**
1043  * Returns a boolean value representing whether an absolute measurement value will be returned.
1044  *
1045  * @public @memberof GoSurfaceDimWidth
1046  * @version Introduced in firmware 4.4.4.14
1047  * @param measurement GoSurfaceDimWidth object.
1048  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1049  */
1050 GoFx(kBool) GoSurfaceDimWidth_AbsoluteEnabled(GoSurfaceDimWidth measurement);
1051 
1052 /**
1053  * Enables or disables an absolute value result for the given measurement.
1054  *
1055  * @public @memberof GoSurfaceDimWidth
1056  * @version Introduced in firmware 4.4.4.14
1057  * @param measurement GoSurfaceDimWidth object.
1058  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1059  * @return Operation status.
1060  */
1061 GoFx(kStatus) GoSurfaceDimWidth_EnableAbsolute(GoSurfaceDimWidth measurement, kBool absolute);
1062 
1063 /**
1064  * @class GoSurfaceDimHeight
1065  * @extends GoMeasurement
1066  * @ingroup GoSdk-SurfaceTools
1067  * @brief Represents a height value measurement for a Surface Dimension Tool.
1068  */
1069 typedef GoMeasurement GoSurfaceDimHeight;
1070 
1071 /**
1072  * Returns a boolean value representing whether an absolute measurement value will be returned.
1073  *
1074  * @public @memberof GoSurfaceDimHeight
1075  * @version Introduced in firmware 4.4.4.14
1076  * @param measurement GoSurfaceDimHeight object.
1077  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1078  */
1079 GoFx(kBool) GoSurfaceDimHeight_AbsoluteEnabled(GoSurfaceDimHeight measurement);
1080 
1081 /**
1082  * Enables or disables an absolute value result for the given measurement.
1083  *
1084  * @public @memberof GoSurfaceDimHeight
1085  * @version Introduced in firmware 4.4.4.14
1086  * @param measurement GoSurfaceDimHeight object.
1087  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1088  * @return Operation status.
1089  */
1090 GoFx(kStatus) GoSurfaceDimHeight_EnableAbsolute(GoSurfaceDimHeight measurement, kBool absolute);
1091 
1092 /**
1093  * @class GoSurfaceDimLength
1094  * @extends GoMeasurement
1095  * @ingroup GoSdk-SurfaceTools
1096  * @brief Represents a Length value measurement for a Surface Dimension Tool.
1097  */
1098 typedef GoMeasurement GoSurfaceDimLength;
1099 
1100 /**
1101  * Returns a boolean value representing whether an absolute measurement value will be returned.
1102  *
1103  * @public @memberof GoSurfaceDimLength
1104  * @version Introduced in firmware 4.4.4.14
1105  * @param measurement GoSurfaceDimLength object.
1106  * @return kTRUE if an absolute value will be returned. kFALSE otherwise.
1107  */
1108 GoFx(kBool) GoSurfaceDimLength_AbsoluteEnabled(GoSurfaceDimLength measurement);
1109 
1110 /**
1111  * Enables or disables an absolute value result for the given measurement.
1112  *
1113  * @public @memberof GoSurfaceDimLength
1114  * @version Introduced in firmware 4.4.4.14
1115  * @param measurement GoSurfaceDimLength object.
1116  * @param absolute kTRUE to enable absolute value and kFALSE to disable it.
1117  * @return Operation status.
1118  */
1119 GoFx(kStatus) GoSurfaceDimLength_EnableAbsolute(GoSurfaceDimLength measurement, kBool absolute);
1120 
1121 /**
1122  * @class GoSurfaceDimDistance
1123  * @extends GoMeasurement
1124  * @ingroup GoSdk-SurfaceTools
1125  * @brief Represents a distance value measurement for a Surface Dimension Tool.
1126  */
1127 typedef GoMeasurement GoSurfaceDimDistance;
1128 
1129 /**
1130  * @class GoSurfaceDimPlaneDistance
1131  * @extends GoMeasurement
1132  * @ingroup GoSdk-SurfaceTools
1133  * @brief Represents a distance value measurement for a Surface Dimension Tool.
1134  */
1135 typedef GoMeasurement GoSurfaceDimPlaneDistance;
1136 
1137 /**
1138  * @class GoSurfaceDimCenterX
1139  * @extends GoMeasurement
1140  * @ingroup GoSdk-SurfaceTools
1141  * @brief Represents a center X value measurement for a Surface Dimension Tool.
1142  */
1143 typedef GoMeasurement GoSurfaceDimCenterX;
1144 
1145 /**
1146  * @class GoSurfaceDimCenterY
1147  * @extends GoMeasurement
1148  * @ingroup GoSdk-SurfaceTools
1149  * @brief Represents a center Y value measurement for a Surface Dimension Tool.
1150  */
1151 typedef GoMeasurement GoSurfaceDimCenterY;
1152 
1153 
1154 /**
1155  * @class GoSurfaceDimCenterZ
1156  * @extends GoMeasurement
1157  * @ingroup GoSdk-SurfaceTools
1158  * @brief Represents a center Z value measurement for a Surface Dimension Tool.
1159  */
1160 typedef GoMeasurement GoSurfaceDimCenterZ;
1161 
1162 /**
1163  * @class GoSurfaceEllipseMajor
1164  * @extends GoMeasurement
1165  * @ingroup GoSdk-SurfaceTools
1166  * @brief Represents a major value measurement for a Surface Ellipse tool.
1167  */
1168 typedef GoMeasurement GoSurfaceEllipseMajor;
1169 
1170 /**
1171  * @class GoSurfaceEllipseMinor
1172  * @extends GoMeasurement
1173  * @ingroup GoSdk-SurfaceTools
1174  * @brief Represents a minor value measurement for a Surface Ellipse tool.
1175  */
1176 typedef GoMeasurement GoSurfaceEllipseMinor;
1177 
1178 /**
1179  * @class GoSurfaceEllipseRatio
1180  * @extends GoMeasurement
1181  * @ingroup GoSdk-SurfaceTools
1182  * @brief Represents a ratio measurement for a Surface Ellipse tool.
1183  */
1184 typedef GoMeasurement GoSurfaceEllipseRatio;
1185 
1186 /**
1187  * @class GoSurfaceEllipseZAngle
1188  * @extends GoMeasurement
1189  * @ingroup GoSdk-SurfaceTools
1190  * @brief Represents a Z-angle measurement for a Surface Ellipse tool.
1191  */
1192 typedef GoMeasurement GoSurfaceEllipseZAngle;
1193 
1194 /**
1195  * @class GoSurfaceHoleX
1196  * @extends GoMeasurement
1197  * @ingroup GoSdk-SurfaceTools
1198  * @brief Represents an X measurement for a Surface Hole Tool.
1199  */
1200 typedef GoMeasurement GoSurfaceHoleX;
1201 
1202 /**
1203  * @class GoSurfaceHoleY
1204  * @extends GoMeasurement
1205  * @ingroup GoSdk-SurfaceTools
1206  * @brief Represents a Y measurement for a Surface Hole Tool.
1207  */
1208 typedef GoMeasurement GoSurfaceHoleY;
1209 
1210 /**
1211  * @class GoSurfaceHoleZ
1212  * @extends GoMeasurement
1213  * @ingroup GoSdk-SurfaceTools
1214  * @brief Represents a Z measurement for a Surface Hole Tool.
1215  */
1216 typedef GoMeasurement GoSurfaceHoleZ;
1217 
1218 /**
1219  * @class GoSurfaceHoleRadius
1220  * @extends GoMeasurement
1221  * @ingroup GoSdk-SurfaceTools
1222  * @brief Represents a radius measurement for a Surface Hole Tool.
1223  */
1224 typedef GoMeasurement GoSurfaceHoleRadius;
1225 
1226 
1227 /**
1228  * @class GoSurfaceOpeningX
1229  * @extends GoMeasurement
1230  * @ingroup GoSdk-SurfaceTools
1231  * @brief Represents an X measurement for a Surface Opening Tool.
1232  */
1233 typedef GoMeasurement GoSurfaceOpeningX;
1234 
1235 /**
1236  * @class GoSurfaceOpeningY
1237  * @extends GoMeasurement
1238  * @ingroup GoSdk-SurfaceTools
1239  * @brief Represents a Y measurement for a Surface Opening Tool.
1240  */
1241 typedef GoMeasurement GoSurfaceOpeningY;
1242 
1243 /**
1244  * @class GoSurfaceOpeningZ
1245  * @extends GoMeasurement
1246  * @ingroup GoSdk-SurfaceTools
1247  * @brief Represents a Z measurement for a Surface Opening Tool.
1248  */
1249 typedef GoMeasurement GoSurfaceOpeningZ;
1250 
1251 /**
1252  * @class GoSurfaceOpeningWidth
1253  * @extends GoMeasurement
1254  * @ingroup GoSdk-SurfaceTools
1255  * @brief Represents a width measurement for a Surface Opening Tool.
1256  */
1257 typedef GoMeasurement GoSurfaceOpeningWidth;
1258 
1259 /**
1260  * @class GoSurfaceOpeningLength
1261  * @extends GoMeasurement
1262  * @ingroup GoSdk-SurfaceTools
1263  * @brief Represents a length measurement for a Surface Opening Tool.
1264  */
1265 typedef GoMeasurement GoSurfaceOpeningLength;
1266 
1267 /**
1268  * @class GoSurfaceOpeningAngle
1269  * @extends GoMeasurement
1270  * @ingroup GoSdk-SurfaceTools
1271  * @brief Represents an angle measurement for a Surface Opening Tool.
1272  */
1273 typedef GoMeasurement GoSurfaceOpeningAngle;
1274 
1275 
1276 /**
1277  * @class GoSurfacePlaneXAngle
1278  * @extends GoMeasurement
1279  * @ingroup GoSdk-SurfaceTools
1280  * @brief Represents an X-angle measurement for a Surface Plane Tool.
1281  */
1282 typedef GoMeasurement GoSurfacePlaneXAngle;
1283 
1284 /**
1285  * @class GoSurfacePlaneYAngle
1286  * @extends GoMeasurement
1287  * @ingroup GoSdk-SurfaceTools
1288  * @brief Represents a Y-angle measurement for a Surface Plane Tool.
1289  */
1290 typedef GoMeasurement GoSurfacePlaneYAngle;
1291 
1292 /**
1293  * @class GoSurfacePlaneZOffset
1294  * @extends GoMeasurement
1295  * @ingroup GoSdk-SurfaceTools
1296  * @brief Represents a Z-offset measurement for a Surface Plane Tool.
1297  */
1298 typedef GoMeasurement GoSurfacePlaneZOffset;
1299 
1300 /**
1301  * @class GoSurfacePlaneStdDev
1302  * @extends GoMeasurement
1303  * @ingroup GoSdk-SurfaceTools
1304  * @brief Represents a Standard Deviation measurement for a Surface Plane Tool.
1305  */
1306 typedef GoMeasurement GoSurfacePlaneStdDev;
1307 
1308 /**
1309  * @class GoSurfacePlaneMaxError
1310  * @extends GoMeasurement
1311  * @ingroup GoSdk-SurfaceTools
1312  * @brief Represents a Maximum Error measurement for a Surface Plane Tool.
1313  */
1314 typedef GoMeasurement GoSurfacePlaneMaxError;
1315 
1316 /**
1317  * @class GoSurfacePlaneMinError
1318  * @extends GoMeasurement
1319  * @ingroup GoSdk-SurfaceTools
1320  * @brief Represents a Minimum Error measurement for a Surface Plane Tool.
1321  */
1322 typedef GoMeasurement GoSurfacePlaneMinError;
1323 
1324 
1325 /**
1326  * @class GoSurfacePositionX
1327  * @extends GoMeasurement
1328  * @ingroup GoSdk-SurfaceTools
1329  * @brief Represents an X measurement for a Surface Position Tool.
1330  */
1331 typedef GoMeasurement GoSurfacePositionX;
1332 
1333 /**
1334  * @class GoSurfacePositionY
1335  * @extends GoMeasurement
1336  * @ingroup GoSdk-SurfaceTools
1337  * @brief Represents a Y measurement for a Surface Position Tool.
1338  */
1339 typedef GoMeasurement GoSurfacePositionY;
1340 
1341 /**
1342  * @class GoSurfacePositionZ
1343  * @extends GoMeasurement
1344  * @ingroup GoSdk-SurfaceTools
1345  * @brief Represents a Z measurement for a Surface Position Tool.
1346  */
1347 typedef GoMeasurement GoSurfacePositionZ;
1348 
1349 
1350 /**
1351  * @class GoSurfaceStudBaseX
1352  * @extends GoMeasurement
1353  * @ingroup GoSdk-SurfaceTools
1354  * @brief Represents a base X measurement for a Surface Stud Tool.
1355  */
1356 typedef GoMeasurement GoSurfaceStudBaseX;
1357 
1358 /**
1359  * @class GoSurfaceStudBaseY
1360  * @extends GoMeasurement
1361  * @ingroup GoSdk-SurfaceTools
1362  * @brief Represents a base Y measurement for a Surface Stud Tool.
1363  */
1364 typedef GoMeasurement GoSurfaceStudBaseY;
1365 
1366 /**
1367  * @class GoSurfaceStudBaseZ
1368  * @extends GoMeasurement
1369  * @ingroup GoSdk-SurfaceTools
1370  * @brief Represents a base Z measurement for a Surface Stud Tool.
1371  */
1372 typedef GoMeasurement GoSurfaceStudBaseZ;
1373 
1374 /**
1375  * @class GoSurfaceStudTipX
1376  * @extends GoMeasurement
1377  * @ingroup GoSdk-SurfaceTools
1378  * @brief Represents a tip X measurement for a Surface Stud Tool.
1379  */
1380 typedef GoMeasurement GoSurfaceStudTipX;
1381 
1382 /**
1383  * @class GoSurfaceStudTipY
1384  * @extends GoMeasurement
1385  * @ingroup GoSdk-SurfaceTools
1386  * @brief Represents a tip Y measurement for a Surface Stud Tool.
1387  */
1388 typedef GoMeasurement GoSurfaceStudTipY;
1389 
1390 /**
1391  * @class GoSurfaceStudTipZ
1392  * @extends GoMeasurement
1393  * @ingroup GoSdk-SurfaceTools
1394  * @brief Represents a tip Z measurement for a Surface Stud Tool.
1395  */
1396 typedef GoMeasurement GoSurfaceStudTipZ;
1397 
1398 /**
1399  * @class GoSurfaceStudRadius
1400  * @extends GoMeasurement
1401  * @ingroup GoSdk-SurfaceTools
1402  * @brief Represents a radius measurement for a Surface Stud Tool.
1403  */
1404 typedef GoMeasurement GoSurfaceStudRadius;
1405 
1406 /**
1407  * Gets the radius offset.
1408  *
1409  * @public @memberof GoSurfaceStudRadius
1410  * @version Introduced in firmware 4.0.10.27
1411  * @param measurement GoSurfaceStudRadius object.
1412  * @return The surface location.
1413  */
1414 GoFx(k64f) GoSurfaceStudRadius_RadiusOffset(GoSurfaceStudRadius measurement);
1415 
1416 /**
1417  * Sets the radius offset.
1418  *
1419  * @public @memberof GoSurfaceStudRadius
1420  * @version Introduced in firmware 4.0.10.27
1421  * @param measurement GoSurfaceStudRadius object.
1422  * @param value The offset value to set.
1423  * @return Operation status.
1424  */
1425 GoFx(kStatus) GoSurfaceStudRadius_SetRadiusOffset(GoSurfaceStudRadius measurement, k64f value);
1426 
1427 /**
1428  * @class GoSurfaceVolumeVolume
1429  * @extends GoMeasurement
1430  * @ingroup GoSdk-SurfaceTools
1431  * @brief Represents a volume measurement for a Surface Volume Tool.
1432  */
1433 typedef GoMeasurement GoSurfaceVolumeVolume;
1434 
1435 /**
1436  * @class GoSurfaceVolumeArea
1437  * @extends GoMeasurement
1438  * @ingroup GoSdk-SurfaceTools
1439  * @brief Represents an area measurement for a Surface Volume Tool.
1440  */
1441 typedef GoMeasurement GoSurfaceVolumeArea;
1442 
1443 /**
1444  * @class GoSurfaceVolumeThickness
1445  * @extends GoMeasurement
1446  * @ingroup GoSdk-SurfaceTools
1447  * @brief Represents a thickness measurement for a Surface Volume Tool.
1448  */
1449 typedef GoMeasurement GoSurfaceVolumeThickness;
1450 
1451 /**
1452  * Gets the location.
1453  *
1454  * @public @memberof GoSurfaceVolumeThickness
1455  * @version Introduced in firmware 4.0.10.27
1456  * @param measurement GoSurfaceVolumeThickness object.
1457  * @return The surface location.
1458  */
1459 GoFx(GoSurfaceLocation) GoSurfaceVolumeThickness_Location(GoSurfaceVolumeThickness measurement);
1460 
1461 /**
1462  * Sets the location.
1463  *
1464  * @public @memberof GoSurfaceVolumeThickness
1465  * @version Introduced in firmware 4.0.10.27
1466  * @param measurement GoSurfaceVolumeThickness object.
1467  * @param location The surface location.
1468  * @return Operation status.
1469  */
1470 GoFx(kStatus) GoSurfaceVolumeThickness_SetLocation(GoSurfaceVolumeThickness measurement, GoSurfaceLocation location);
1471 
1472 /**
1473  * @class GoSurfaceCountersunkHoleX
1474  * @extends GoMeasurement
1475  * @ingroup GoSdk-SurfaceTools
1476  * @brief Represents an X position measurement for a Surface Counter Sunk Hole Tool.
1477  */
1478 typedef GoMeasurement GoSurfaceCountersunkHoleX;
1479 
1480 /**
1481  * @class GoSurfaceCountersunkHoleY
1482  * @extends GoMeasurement
1483  * @ingroup GoSdk-SurfaceTools
1484  * @brief Represents a Y position measurement for a Surface Counter Sunk Hole Tool.
1485  */
1486 typedef GoMeasurement GoSurfaceCountersunkHoleY;
1487 
1488 /**
1489  * @class GoSurfaceCountersunkHoleZ
1490  * @extends GoMeasurement
1491  * @ingroup GoSdk-SurfaceTools
1492  * @brief Represents a Z position measurement for a Surface Counter Sunk Hole Tool.
1493  */
1494 typedef GoMeasurement GoSurfaceCountersunkHoleZ;
1495 
1496 /**
1497  * @class GoSurfaceCountersunkHoleOuterRadius
1498  * @extends GoMeasurement
1499  * @ingroup GoSdk-SurfaceTools
1500  * @brief Represents an Outer Radius position measurement for a Surface Counter Sunk Hole Tool.
1501  */
1502 typedef GoMeasurement GoSurfaceCountersunkHoleOuterRadius;
1503 
1504 /**
1505  * @class GoSurfaceCountersunkHoleDepth
1506  * @extends GoMeasurement
1507  * @ingroup GoSdk-SurfaceTools
1508  * @brief Represents a Depth position measurement for a Surface Counter Sunk Hole Tool.
1509  */
1510 typedef GoMeasurement GoSurfaceCountersunkHoleDepth;
1511 
1512 /**
1513  * @class GoSurfaceCountersunkHoleBevelRadius
1514  * @extends GoMeasurement
1515  * @ingroup GoSdk-SurfaceTools
1516  * @brief Represents an Bevel Radius position measurement for a Surface Counter Sunk Hole Tool.
1517  */
1518 typedef GoMeasurement GoSurfaceCountersunkHoleBevelRadius;
1519 
1520 /**
1521  * @class GoSurfaceCountersunkHoleBevelAngle
1522  * @extends GoMeasurement
1523  * @ingroup GoSdk-SurfaceTools
1524  * @brief Represents a Bevel Angle measurement for a Surface Counter Sunk Hole Tool.
1525  */
1526 typedef GoMeasurement GoSurfaceCountersunkHoleBevelAngle;
1527 
1528 /**
1529  * @class GoSurfaceCountersunkHoleXAngle
1530  * @extends GoMeasurement
1531  * @ingroup GoSdk-SurfaceTools
1532  * @brief Represents an X Angle position measurement for a Surface Counter Sunk Hole Tool.
1533  */
1534 typedef GoMeasurement GoSurfaceCountersunkHoleXAngle;
1535 
1536 /**
1537  * @class GoSurfaceCountersunkHoleYAngle
1538  * @extends GoMeasurement
1539  * @ingroup GoSdk-SurfaceTools
1540  * @brief Represents a Y Angle position measurement for a Surface Counter Sunk Hole Tool.
1541  */
1542 typedef GoMeasurement GoSurfaceCountersunkHoleYAngle;
1543 
1544 /**
1545  * @class GoSurfaceCountersunkHoleCounterboreDepth
1546  * @extends GoMeasurement
1547  * @ingroup GoSdk-SurfaceTools
1548  * @brief Represents a counterbore depth measurement for a Surface Counter Sunk Hole Tool.
1549  */
1550 typedef GoMeasurement GoSurfaceCountersunkHoleCounterboreDepth;
1551 
1552 /// @endcond
1553 
1554 
1555 /**
1556  * @class GoScriptOutput
1557  * @extends GoMeasurement
1558  * @ingroup GoSdk-Tools
1559  * @brief Represents a script output for a Script Tool.
1560  */
1562 
1563 kEndHeader()
1564 #include <GoSdk/Tools/GoMeasurements.x.h>
1565 
1566 #endif
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.
Represents an X value measurement for a Profile Circle 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.
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.
GoProfileGrooveLocation GoProfileGrooveZ_Location(GoProfileGrooveZ measurement)
Gets the current groove location type.
k32u GoProfileStripX_SelectIndex(GoProfileStripX measurement)
Gets the select index.
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType(GoProfileGrooveWidth measurement)
Gets the current groove selection type.
Declares the GoMeasurement class.
Represents a gap measurement for a Profile Panel Tool.
Represents an height measurement for a Profile Strip Tool.
Represents a center X value measurement for a Profile Dimension Tool.
Represents a flush measurement for a Profile Panel Tool.
kStatus GoProfileStripWidth_SetSelectIndex(GoProfileStripWidth measurement, k32u selectIndex)
Sets the select index.
Represents a width measurement for a Profile Groove Tool.
kStatus GoProfileStripHeight_SetSelectIndex(GoProfileStripHeight measurement, k32u selectIndex)
Sets the select index.
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 a width value measurement for a Profile Dimension Tool.
kStatus GoProfileStripWidth_SetSelectType(GoProfileStripWidth measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
Represents an angle measurement for a Profile Bridge Value tool.
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 position Z measurement of a Range Position tool.
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 a maximum error measurement for a Profile Line Tool.
kStatus GoProfileGrooveZ_SetLocation(GoProfileGrooveZ measurement, GoProfileGrooveLocation location)
Sets the groove location type.
Represents a script output for a Script Tool.
Represents a centroid Z measurement for a Profile Area Tool.
kStatus GoProfileGrooveX_SetLocation(GoProfileGrooveX measurement, GoProfileGrooveLocation value)
Sets the groove location.
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 height measurement for a Profile Bounding Box tool.
Represents a global angle measurement for a Profile Bounding Box tool.
Represents a minimum error measurement for a Profile Line Tool.
k32u GoProfileGrooveZ_SelectIndex(GoProfileGrooveZ measurement)
Gets the current selected groove index.
Determines which groove to select when multiple are present.
Represents an Z measurement for a Profile Position tool.
Essential SDK declarations.
kStatus GoProfileGrooveZ_SetSelectType(GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
GoProfileGrooveLocation GoProfileStripHeight_Location(GoProfileStripHeight measurement)
Gets the groove location setting.
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 X measurement for a Profile Bounding Box tool.
kStatus GoProfileGrooveDepth_SetSelectIndex(GoProfileGrooveDepth measurement, k32u selectN)
Sets the selected groove index.
Represents a height value measurement for a Profile Dimension 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 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.
GoProfileGapAxis GoProfilePanelGap_Axis(GoProfilePanelGap measurement)
Gets the gap axis.
k32u GoProfileStripHeight_SelectIndex(GoProfileStripHeight measurement)
Gets the select index.
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...
Represents an X measurement for a Profile Strip Tool.
GoProfileGrooveSelectType GoProfileGrooveX_SelectType(GoProfileGrooveX measurement)
Gets the current groove selection type.
k64f GoProfileLinePercentile_Percent(GoProfileLinePercentile measurement)
Gets the percent threshold.
Represents a profile gap measurement axis.
Represents a the thickness measurement of a Range Thickness tool.
kStatus GoProfileStripZ_SetSelectType(GoProfileStripZ measurement, GoProfileGrooveSelectType selectType)
Sets the select type.
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.
k32u GoProfileStripWidth_SelectIndex(GoProfileStripWidth measurement)
Gets the select index.
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 an intersect angle measurement for a Profile Intersect Tool.
Represents a radius value measurement for a Profile Circle 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 an intersect Z measurement for a Profile Intersect Tool.
Represents an X measurement for a Profile Position tool.
kStatus GoProfileStripX_SetLocation(GoProfileStripX measurement, GoProfileGrooveLocation location)
Sets the groove location configuration value.
Represents a bridge value measurement for a Profile Bridge Value tool.
Represents a global X measurement for a Profile Bounding Box tool.
kStatus GoProfileGrooveDepth_SetSelectType(GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType)
Sets the groove selection type.
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.