Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoProfileTools.h
Go to the documentation of this file.
1 /**
2  * @file GoProfileTools.h
3  * @brief Declares all profile tools and their related classes.
4  *
5  * @internal
6  * Copyright (C) 2016-2018 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_PROFILE_TOOLS_H
11 #define GO_PROFILE_TOOLS_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/Tools/GoTool.h>
15 #include <GoSdk/Tools/GoProfileToolUtils.h>
16 #include <GoSdk/GoUtils.h>
17 
18 kBeginHeader()
19 
20 /**
21  * @class GoProfileTool
22  * @extends GoTool
23  * @ingroup GoSdk-ProfileTools
24  * @brief Represents a base profile tool.
25  */
26 typedef GoTool GoProfileTool;
27 
28 
29 /**
30  * Sets the data stream. Note that stream validation will only occur if tool
31  * is in the tool options list.
32  *
33  * @public @memberof GoProfileTool
34  * @version Introduced in firmware 4.4.4.14
35  * @param tool GoProfileTool object.
36  * @param stream GoDataStream value.
37  * @return Operation status.
38  * @see GoProfileTool_StreamOptionCount, GoProfileTool_StreamOptionAt
39  */
40 GoFx(kStatus) GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream);
41 
42 /**
43  * Gets the data stream.
44  *
45  * @public @memberof GoProfileTool
46  * @version Introduced in firmware 4.4.4.14
47  * @param tool GoProfileTool object.
48  * @return The current profile tool data stream value.
49  */
50 GoFx(GoDataStream) GoProfileTool_Stream(GoProfileTool tool);
51 
52 /**
53  * Gets the data stream option list count.
54  *
55  * @public @memberof GoProfileTool
56  * @version Introduced in firmware 4.4.4.14
57  * @param tool GoProfileTool object.
58  * @return The current profile tool data stream option list count.
59  */
60 GoFx(kSize) GoProfileTool_StreamOptionCount(GoProfileTool tool);
61 
62 /**
63  * Gets the data stream option at the given index.
64  *
65  * @public @memberof GoProfileTool
66  * @version Introduced in firmware 4.4.4.14
67  * @param tool GoProfileTool object.
68  * @param index The index of the option list to access.
69  * @return The profile tool data stream option at the given index, or k32U_MAX if an invalid index is given.
70  */
71 GoFx(GoDataStream) GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index);
72 
73 /**
74  * Sets the data source. Note that source validation will only occur if tool
75  * is in the tool options list.
76  *
77  * @public @memberof GoProfileTool
78  * @version Introduced in firmware 4.0.10.27
79  * @param tool GoProfileTool object.
80  * @param source GoDataSource object.
81  * @return Operation status.
82  * @see GoTools_ToolOptionCount, GoTools_ToolOptionAt
83  */
84 GoFx(kStatus) GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source);
85 
86 /**
87  * Gets the data source.
88  *
89  * @public @memberof GoProfileTool
90  * @version Introduced in firmware 4.0.10.27
91  * @param tool GoProfileTool object.
92  * @return The current profile tool data source.
93  */
94 GoFx(GoDataSource) GoProfileTool_Source(GoProfileTool tool);
95 
96 /**
97  * Gets the data source option list count.
98  *
99  * @public @memberof GoProfileTool
100  * @version Introduced in firmware 4.0.10.27
101  * @param tool GoProfileTool object.
102  * @return The current profile tool data source option list count.
103  */
104 GoFx(kSize) GoProfileTool_SourceOptionCount(GoProfileTool tool);
105 
106 /**
107  * Gets the data source option at the given index.
108  *
109  * @public @memberof GoProfileTool
110  * @version Introduced in firmware 4.0.10.27
111  * @param tool GoProfileTool object.
112  * @param index The index of the option list to access.
113  * @return The profile tool data source option at the given index, or k32U_MAX if an invalid index is given.
114  */
115 GoFx(GoDataSource) GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index);
116 
117 /**
118  * Gets the X-anchoring option list count.
119  *
120  * @public @memberof GoProfileTool
121  * @version Introduced in firmware 4.0.10.27
122  * @param tool GoProfileTool object.
123  * @return The X-anchoring option list count.
124  */
125 GoFx(kSize) GoProfileTool_XAnchorOptionCount(GoProfileTool tool);
126 
127 /**
128  * Gets the X-anchoring option at the given index.
129  *
130  * @public @memberof GoProfileTool
131  * @version Introduced in firmware 4.0.10.27
132  * @param tool GoProfileTool object.
133  * @param index The index of the option list to access.
134  * @return The X-anchoring option at the given index or k32U_MAX if invalid.
135  */
136 GoFx(k32u) GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index);
137 
138 /**
139  * Gets the current X-anchoring source.
140  *
141  * @public @memberof GoProfileTool
142  * @version Introduced in firmware 4.0.10.27
143  * @param tool GoProfileTool object.
144  * @return The X-anchoring source or -1 if no source is currently set.
145  */
146 GoFx(k32s) GoProfileTool_XAnchor(GoProfileTool tool);
147 
148 /**
149  * Sets the X-anchoring source.
150  *
151  * @public @memberof GoProfileTool
152  * @version Introduced in firmware 4.0.10.27
153  * @param tool GoProfileTool object.
154  * @param id The measurement ID of a valid X-anchoring source.
155  * @return Operation status.
156  */
157 GoFx(kStatus) GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id);
158 
159 /**
160  * Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anchoring.
161  *
162  * @public @memberof GoProfileTool
163  * @version Introduced in firmware 4.0.10.27
164  * @param tool GoProfileTool object.
165  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
166  */
167 GoFx(kBool) GoProfileTool_XAnchorEnabled(GoProfileTool tool);
168 
169 /**
170  * Gets the Z-anchoring option list count.
171  *
172  * @public @memberof GoProfileTool
173  * @version Introduced in firmware 4.0.10.27
174  * @param tool GoProfileTool object.
175  * @return The X-anchoring option list count.
176  */
177 GoFx(kSize) GoProfileTool_ZAnchorOptionCount(GoProfileTool tool);
178 
179 /**
180  * Gets the Z-anchoring option at the given index.
181  *
182  * @public @memberof GoProfileTool
183  * @version Introduced in firmware 4.0.10.27
184  * @param tool GoProfileTool object.
185  * @param index The index of the option list to access.
186  * @return The Z-anchoring option at the given index or k32U_MAX if invalid.
187  */
188 GoFx(k32u) GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index);
189 
190 /**
191  * Gets the current Z-anchoring source.
192  *
193  * @public @memberof GoProfileTool
194  * @version Introduced in firmware 4.0.10.27
195  * @param tool GoProfileTool object.
196  * @return The Z-anchoring source or -1 if no source is currently set.
197  */
198 GoFx(k32s) GoProfileTool_ZAnchor(GoProfileTool tool);
199 
200 /**
201  * Sets the Z-anchoring source.
202  *
203  * @public @memberof GoProfileTool
204  * @version Introduced in firmware 4.0.10.27
205  * @param tool GoProfileTool object.
206  * @param id The measurement ID of a valid Z-anchoring source.
207  * @return Operation status.
208  */
209 GoFx(kStatus) GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id);
210 
211 /**
212  * Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anchoring.
213  *
214  * @public @memberof GoProfileTool
215  * @version Introduced in firmware 4.0.10.27
216  * @param tool GoProfileTool object.
217  * @return kTRUE if a valid anchoring source is currently set and kFALSE otherwise.
218  */
219 GoFx(kBool) GoProfileTool_ZAnchorEnabled(GoProfileTool tool);
220 
221 
222 /**
223  * @class GoProfileArea
224  * @extends GoProfileTool
225  * @ingroup GoSdk-ProfileTools
226  * @brief Represents a profile area tool.
227  */
228 typedef GoProfileTool GoProfileArea;
229 
230 /**
231  * Gets the profile area baseline.
232  *
233  * @public @memberof GoProfileArea
234  * @version Introduced in firmware 4.0.10.27
235  * @param tool GoProfileArea object.
236  * @return The profile area baseline.
237  */
238 GoFx(GoProfileBaseline) GoProfileArea_Baseline(GoProfileArea tool);
239 
240 /**
241  * Sets the profile area type.
242  *
243  * @public @memberof GoProfileArea
244  * @version Introduced in firmware 4.0.10.27
245  * @param tool GoProfileArea object.
246  * @param type The baseline type to set.
247  * @return Operation status.
248  */
249 GoFx(kStatus) GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type);
250 
251 /**
252  * Returns a boolean representing whether the profile area baseline is used.
253  *
254  * @public @memberof GoProfileArea
255  * @version Introduced in firmware 4.0.10.27
256  * @param tool GoProfileArea object.
257  * @return kTRUE if the baseline is used; kFALSE otherwise.
258  */
259 GoFx(kBool) GoProfileArea_BaselineUsed(GoProfileArea tool);
260 
261 /**
262  * Gets the reference profile line.
263  *
264  * @public @memberof GoProfileArea
265  * @version Introduced in firmware 4.0.10.27
266  * @param tool GoProfileArea object.
267  * @return The reference profile line.
268  */
269 GoFx(GoProfileLineRegion) GoProfileArea_LineRegion(GoProfileArea tool);
270 
271 /**
272  * Gets the profile area type.
273  *
274  * @public @memberof GoProfileArea
275  * @version Introduced in firmware 4.0.10.27
276  * @param tool GoProfileArea object.
277  * @return The profile area type.
278  */
279 GoFx(GoProfileAreaType) GoProfileArea_Type(GoProfileArea tool);
280 
281 /**
282  * Gets the boolean representing whether the area type is used.
283  *
284  * @public @memberof GoProfileArea
285  * @version Introduced in firmware 4.0.10.27
286  * @param tool GoProfileArea object.
287  * @return kTRUE if profile area type is used; kFALSE otherwise.
288  */
289 GoFx(kBool) GoProfileArea_TypeUsed(GoProfileArea tool);
290 
291 /**
292  * Sets the profile area type.
293  *
294  * @public @memberof GoProfileArea
295  * @version Introduced in firmware 4.0.10.27
296  * @param tool GoProfileArea object.
297  * @param type GoProfileAreaType object.
298  * @return Operation status.
299  */
300 GoFx(kStatus) GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type);
301 
302 /**
303  * Gets the profile region.
304  *
305  * @public @memberof GoProfileArea
306  * @version Introduced in firmware 4.0.10.27
307  * @param tool GoProfileArea object.
308  * @return The profile region.
309  */
310 GoFx(GoProfileRegion) GoProfileArea_Region(GoProfileArea tool);
311 
312 /**
313  * Indicates whether the region is enabled.
314  *
315  * @public @memberof GoProfileArea
316  * @version Introduced in firmware 4.4.4.14
317  * @param tool GoProfileArea object.
318  * @return kTRUE if enabled and kFALSE otherwise.
319  */
320 GoFx(kBool) GoProfileArea_RegionEnabled(GoProfileArea tool);
321 
322 /**
323  * Enables or disables the region.
324  *
325  * @public @memberof GoProfileArea
326  * @version Introduced in firmware 4.4.4.14
327  * @param tool GoProfileArea object.
328  * @param enable kTRUE to enable the region and kFALSE to disable it.
329  * @return Operation status.
330  */
331 GoFx(kStatus) GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable);
332 
333 /**
334  * Returns a GoProfileArea Area measurement object.
335  *
336  * @public @memberof GoProfileArea
337  * @version Introduced in firmware 4.0.10.27
338  * @param tool GoProfileArea object.
339  * @return A GoProfileAreaArea measurement.
340  */
341 GoFx(GoProfileAreaArea) GoProfileArea_AreaMeasurement(GoProfileArea tool);
342 
343 /**
344  * Returns a GoProfileArea Centroid X measurement object.
345  *
346  * @public @memberof GoProfileArea
347  * @version Introduced in firmware 4.0.10.27
348  * @param tool GoProfileArea object.
349  * @return A GoProfileAreaCentroidX measurement.
350  */
352 
353 /**
354  * Returns a GoProfileArea Centroid Z measurement object.
355  *
356  * @public @memberof GoProfileArea
357  * @version Introduced in firmware 4.0.10.27
358  * @param tool GoProfileArea object.
359  * @return A GoProfileAreaCentroidZ measurement.
360  */
362 
363 /**
364 * Returns a GoProfileArea Center point feature object.
365 *
366 * @public @memberof GoProfileArea
367 * @version Introduced in firmware 4.6.4.9
368 * @param tool GoProfileArea object.
369 * @return A GoProfileAreaCenterPoint Center point feature.
370 */
371 GoFx(GoProfileAreaCenterPoint) GoProfileArea_CenterPoint(GoProfileArea tool);
372 
373 /**
374  * @class GoProfileBox
375  * @extends GoProfileTool
376  * @ingroup GoSdk-ProfileTools
377  * @brief Represents a profile bounding box tool.
378  */
379 typedef GoProfileTool GoProfileBox;
380 
381 /**
382  * Returns the enabled state of the tool region.
383  *
384  * @public @memberof GoProfileBox
385  * @version Introduced in firmware 4.2.4.7
386  * @param tool GoProfileBox object.
387  * @return kTRUE if enabled and kFALSE if disabled.
388  */
389 GoFx(kBool) GoProfileBox_RegionEnabled(GoProfileBox tool);
390 
391 /**
392  * Enables or disables the tool region.
393  *
394  * @public @memberof GoProfileBox
395  * @version Introduced in firmware 4.2.4.7
396  * @param tool GoProfileBox object.
397  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
398  * @return Operation status.
399  */
400 GoFx(kStatus) GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable);
401 
402 /**
403  * Gets the profile bounding box region.
404  *
405  * @public @memberof GoProfileBox
406  * @version Introduced in firmware 4.2.4.7
407  * @param tool GoProfileBox object.
408  * @return A GoRegion3d object.
409  */
410 GoFx(GoProfileRegion) GoProfileBox_Region(GoProfileBox tool);
411 
412 /**
413  * Returns a GoProfileBox X measurement object.
414  *
415  * @public @memberof GoProfileBox
416  * @version Introduced in firmware 4.2.4.7
417  * @param tool GoProfileBox object.
418  * @return A GoProfileBox X measurement. (mm)
419  */
420 GoFx(GoProfileBoxX) GoProfileBox_XMeasurement(GoProfileBox tool);
421 
422 /**
423  * Returns a GoProfileBox Z measurement object.
424  *
425  * @public @memberof GoProfileBox
426  * @version Introduced in firmware 4.2.4.7
427  * @param tool GoProfileBox object.
428  * @return A GoProfileBox Z measurement. (mm)
429  */
430 GoFx(GoProfileBoxZ) GoProfileBox_ZMeasurement(GoProfileBox tool);
431 
432 /**
433  * Returns a GoProfileBox Width measurement object.
434  *
435  * @public @memberof GoProfileBox
436  * @version Introduced in firmware 4.2.4.7
437  * @param tool GoProfileBox object.
438  * @return A GoProfileBox Width measurement. (mm)
439  */
440 GoFx(GoProfileBoxWidth) GoProfileBox_WidthMeasurement(GoProfileBox tool);
441 
442 /**
443  * Returns a GoProfileBox Height measurement object.
444  *
445  * @public @memberof GoProfileBox
446  * @version Introduced in firmware 4.2.4.7
447  * @param tool GoProfileBox object.
448  * @return A GoProfileBox Height measurement. (mm)
449  */
450 GoFx(GoProfileBoxHeight) GoProfileBox_HeightMeasurement(GoProfileBox tool);
451 
452 /**
453  * Returns a GoProfileBox global X measurement object.
454  *
455  * @public @memberof GoProfileBox
456  * @version Introduced in firmware 4.2.4.7
457  * @param tool GoProfileBox object.
458  * @return A GoProfileBox global X measurement. (mm)
459  */
461 
462 /**
463  * Returns a GoProfileBox global Y measurement object.
464  *
465  * @public @memberof GoProfileBox
466  * @version Introduced in firmware 4.4.4.14
467  * @param tool GoProfileBox object.
468  * @return A GoProfileBox global Y measurement. (mm)
469  */
471 
472 /**
473  * Returns a GoProfileBox global Angle measurement object.
474  *
475  * @public @memberof GoProfileBox
476  * @version Introduced in firmware 4.4.4.14
477  * @param tool GoProfileBox object.
478  * @return A GoProfileBox global angle measurement. (degrees)
479  */
481 
482 /**
483 * Returns a GoProfileBox corner point feature object.
484 *
485 * @public @memberof GoProfileBox
486 * @version Introduced in firmware 4.4.4.14
487 * @param tool GoProfileBox object.
488 * @return A GoProfileBoundingBoxCornerPoint global angle measurement. (degrees)
489 */
491 
492 /**
493 * Returns a GoProfileBox center point feature object.
494 *
495 * @public @memberof GoProfileBox
496 * @version Introduced in firmware 4.4.4.14
497 * @param tool GoProfileBox object.
498 * @return A GoProfileBoundingBoxCenterPoint center point feature.
499 */
501 
502 /**
503  * @class GoProfileBridgeValue
504  * @extends GoProfileTool
505  * @ingroup GoSdk-ProfileTools
506  * @brief Represents a profile bridge value tool.
507 */
508 typedef GoProfileTool GoProfileBridgeValue;
509 
510 /**
511  * Returns the enabled state of the tool region.
512  *
513  * @public @memberof GoProfileBridgeValue
514  * @version Introduced in firmware 4.3.3.124
515  * @param tool GoProfileBridgeValue object.
516  * @return kTRUE if enabled and kFALSE if disabled.
517  */
518 GoFx(kBool) GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool);
519 
520 /**
521  * Enables or disables the tool region.
522  *
523  * @public @memberof GoProfileBridgeValue
524  * @version Introduced in firmware 4.3.3.124
525  * @param tool GoProfileBridgeValue object.
526  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
527  * @return Operation status.
528  */
529 GoFx(kStatus) GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable);
530 
531 /**
532  * Gets the bridge value profile region.
533  *
534  * @public @memberof GoProfileBridgeValue
535  * @version Introduced in firmware 4.3.3.124
536  * @param tool GoProfileArea object.
537  * @return The profile region.
538  */
539 GoFx(GoProfileRegion) GoProfileBridgeValue_Region(GoProfileBridgeValue tool);
540 
541 
542 /**
543  * Returns the enabled state of normalization.
544  *
545  * @public @memberof GoProfileBridgeValue
546  * @version Introduced in firmware 4.3.3.124
547  * @param tool GoProfileBridgeValue object.
548  * @return kTRUE if enabled and kFALSE if disabled.
549  */
550 GoFx(kBool) GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool);
551 
552 /**
553  * Enables or disables normalization.
554  *
555  * @public @memberof GoProfileBridgeValue
556  * @version Introduced in firmware 4.3.3.124
557  * @param tool GoProfileBridgeValue object.
558  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
559  * @return Operation status.
560  */
561 GoFx(kStatus) GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable);
562 
563 /**
564  * Sets the profile X-Line tool window size percentage.
565  *
566  * @public @memberof GoProfileBridgeValue
567  * @version Introduced in firmware 4.3.3.124
568  * @param tool GoProfileBridgeValue object.
569  * @param value The value to set.
570  * @return Operation status.
571  */
572 GoFx(kStatus) GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value);
573 
574 /**
575  * Gets the profile X-Line tool window size percentage.
576  *
577  * @public @memberof GoProfileBridgeValue
578  * @version Introduced in firmware 4.3.3.124
579  * @param tool GoProfileBridgeValue object.
580  * @return The window size.
581  */
582 GoFx(k64f) GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool);
583 
584 /**
585  * Sets the profile X-Line tool window skip percentage.
586  *
587  * @public @memberof GoProfileBridgeValue
588  * @version Introduced in firmware 4.3.3.124
589  * @param tool GoProfileBridgeValue object.
590  * @param value The value to set.
591  * @return Operation status.
592  */
593 GoFx(kStatus) GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value);
594 
595 /**
596  * Gets the profile X-Line tool window skip percentage.
597  *
598  * @public @memberof GoProfileBridgeValue
599  * @version Introduced in firmware 4.3.3.124
600  * @param tool GoProfileBridgeValue object.
601  * @return The window size.
602  */
603 GoFx(k64f) GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool);
604 
605 /**
606  * Sets the profile X-Line tool max invalid percentage.
607  *
608  * @public @memberof GoProfileBridgeValue
609  * @version Introduced in firmware 4.3.3.124
610  * @param tool GoProfileBridgeValue object.
611  * @param value The value to set.
612  * @return Operation status.
613  */
614 GoFx(kStatus) GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value);
615 
616 /**
617  * Gets the profile X-Line tool max invalid percentage.
618  *
619  * @public @memberof GoProfileBridgeValue
620  * @version Introduced in firmware 4.3.3.124
621  * @param tool GoProfileBridgeValue object.
622  * @return The window size.
623  */
624 GoFx(k64f) GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool);
625 
626 /**
627  * Sets the profile X-Line tool max differential.
628  *
629  * @public @memberof GoProfileBridgeValue
630  * @version Introduced in firmware 4.3.3.124
631  * @param tool GoProfileBridgeValue object.
632  * @param value The value to set.
633  * @return Operation status.
634  */
635 GoFx(kStatus) GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value);
636 
637 /**
638  * Gets the profile X-Line tool max differential.
639  *
640  * @public @memberof GoProfileBridgeValue
641  * @version Introduced in firmware 4.3.3.124
642  * @param tool GoProfileBridgeValue object.
643  * @return The max differential.
644  */
645 GoFx(k64f) GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool);
646 
647 /**
648  * Gets the profile X-Line tool max differential maximum value limit.
649  *
650  * @public @memberof GoProfileBridgeValue
651  * @version Introduced in firmware 4.3.3.124
652  * @param tool GoProfileBridgeValue object.
653  * @return The max differential maximum value limit.
654  */
655 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool);
656 
657 /**
658  * Gets the profile X-Line tool max differential minimum value limit.
659  * NOTE: A value of 0 will result in an automated differential determination.
660  *
661  * @public @memberof GoProfileBridgeValue
662  * @version Introduced in firmware 4.3.3.124
663  * @param tool GoProfileBridgeValue object.
664  * @return The max differential minimum value limit.
665  */
666 GoFx(k64f) GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool);
667 
668 /**
669  * Returns a GoProfileBridgeValue bridge value measurement object.
670  *
671  * @public @memberof GoProfileBridgeValue
672  * @version Introduced in firmware 4.3.3.124
673  * @param tool GoProfileBridgeValue object.
674  * @return A GoProfileBridgeValue bridge value measurement.
675  */
677 
678 /**
679  * Returns a GoProfileBridgeValue angle measurement object.
680  *
681  * @public @memberof GoProfileBridgeValue
682  * @version Introduced in firmware 4.3.3.124
683  * @param tool GoProfileBridgeValue object.
684  * @return A GoProfileBridgeValue angle measurement. (degrees)
685  */
687 
688 /**
689 * Returns a GoProfileBridgeValue window measurement object.
690 *
691 * @public @memberof GoProfileBridgeValue
692 * @version Introduced in firmware 4.3.3.124
693 * @param tool GoProfileBridgeValue object.
694 * @return A GoProfileBridgeValue window measurement.
695 */
697 
698 /**
699 * Returns a GoProfileBridgeValue standard deviation measurement object.
700 *
701 * @public @memberof GoProfileBridgeValue
702 * @version Introduced in firmware 4.3.3.124
703 * @param tool GoProfileBridgeValue object.
704 * @return A GoProfileBridgeValue standard deviation measurement.
705 */
707 
708 
709 /**
710  * @class GoProfileCircle
711  * @extends GoProfileTool
712  * @ingroup GoSdk-ProfileTools
713  * @brief Represents a profile circle tool.
714  */
715 typedef GoProfileTool GoProfileCircle;
716 
717 /**
718  * Gets the profile region.
719  *
720  * @public @memberof GoProfileCircle
721  * @version Introduced in firmware 4.0.10.27
722  * @param tool GoProfileCircle object.
723  * @return The profile region.
724  */
725 GoFx(GoProfileRegion) GoProfileCircle_Region(GoProfileCircle tool);
726 
727 /**
728  * Indicates whether the region is enabled.
729  *
730  * @public @memberof GoProfileCircle
731  * @version Introduced in firmware 4.4.4.14
732  * @param tool GoProfileCircle object.
733  * @return kTRUE if enabled and kFALSE otherwise.
734  */
735 GoFx(kBool) GoProfileCircle_RegionEnabled(GoProfileCircle tool);
736 
737 /**
738  * Enables or disables the region.
739  *
740  * @public @memberof GoProfileCircle
741  * @version Introduced in firmware 4.4.4.14
742  * @param tool GoProfileCircle object.
743  * @param enable kTRUE to enable the region and kFALSE to disable it.
744  * @return Operation status.
745  */
746 GoFx(kStatus) GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable);
747 
748 /**
749  * Returns a GoProfileCircle X measurement object.
750  *
751  * @public @memberof GoProfileCircle
752  * @version Introduced in firmware 4.0.10.27
753  * @param tool GoProfileCircle object.
754  * @return A GoProfileCircleX measurement. (mm)
755  */
756 GoFx(GoProfileCircleX) GoProfileCircle_XMeasurement(GoProfileCircle tool);
757 
758 /**
759  * Returns a GoProfileCircle Z measurement object.
760  *
761  * @public @memberof GoProfileCircle
762  * @version Introduced in firmware 4.0.10.27
763  * @param tool GoProfileCircle object.
764  * @return A GoProfileCircleZ measurement. (mm)
765  */
766 GoFx(GoProfileCircleZ) GoProfileCircle_ZMeasurement(GoProfileCircle tool);
767 
768 /**
769  * Returns a GoProfileCircle Radius measurement object.
770  *
771  * @public @memberof GoProfileCircle
772  * @version Introduced in firmware 4.0.10.27
773  * @param tool GoProfileCircle object.
774  * @return A GoProfileCircleRadius Radius measurement.(mm)
775  */
776 GoFx(GoProfileCircleRadius) GoProfileCircle_RadiusMeasurement(GoProfileCircle tool);
777 
778 /**
779 * Returns a GoProfileCircle center point feature object.
780 *
781 * @public @memberof GoProfileCircle
782 * @version Introduced in firmware 4.0.10.27
783 * @param tool GoProfileCircle object.
784 * @return A GoProfileCircleCenterPoint center point feature .
785 */
786 GoFx(GoProfileCircleCenterPoint) GoProfileCircle_CenterPoint(GoProfileCircle tool);
787 
788 /**
789  * @class GoProfileDim
790  * @extends GoProfileTool
791  * @ingroup GoSdk-ProfileTools
792  * @brief Represents a profile dimension tool.
793  */
794 typedef GoProfileTool GoProfileDim;
795 
796 
797 /**
798  * Gets the reference profile feature.
799  *
800  * @public @memberof GoProfileDim
801  * @version Introduced in firmware 4.0.10.27
802  * @param tool GoProfileDim object.
803  * @return The reference profile feature object.
804  */
805 GoFx(GoProfileFeature) GoProfileDim_RefFeature(GoProfileDim tool);
806 
807 /**
808  * Gets the non-reference profile feature.
809  *
810  * @public @memberof GoProfileDim
811  * @version Introduced in firmware 4.0.10.27
812  * @param tool GoProfileDim object.
813  * @return The profile feature object.
814  */
815 GoFx(GoProfileFeature) GoProfileDim_Feature(GoProfileDim tool);
816 
817 /**
818  * Returns a GoProfileDim Width measurement object.
819  *
820  * @public @memberof GoProfileDim
821  * @version Introduced in firmware 4.0.10.27
822  * @param tool GoProfileDim object.
823  * @return A GoProfileDimWidth measurement.(mm)
824  */
825 GoFx(GoProfileDimWidth) GoProfileDim_WidthMeasurement(GoProfileDim tool);
826 
827 /**
828  * Returns a GoProfileDim Height measurement object.
829  *
830  * @public @memberof GoProfileDim
831  * @version Introduced in firmware 4.0.10.27
832  * @param tool GoProfileDim object.
833  * @return A GoProfileDimHeight measurement.(mm)
834  */
835 GoFx(GoProfileDimHeight) GoProfileDim_HeightMeasurement(GoProfileDim tool);
836 
837 /**
838  * Returns a GoProfileDim Distance measurement object.
839  *
840  * @public @memberof GoProfileDim
841  * @version Introduced in firmware 4.0.10.27
842  * @param tool GoProfileDim object.
843  * @return A GoProfileDimDistance measurement.(mm)
844  */
846 
847 /**
848  * Returns a GoProfileDim Center X measurement object.
849  *
850  * @public @memberof GoProfileDim
851  * @version Introduced in firmware 4.0.10.27
852  * @param tool GoProfileDim object.
853  * @return A GoProfileDimCenterX measurement.
854  */
856 
857 /**
858  * Returns a GoProfileDim Center Z measurement object.
859  *
860  * @public @memberof GoProfileDim
861  * @version Introduced in firmware 4.0.10.27
862  * @param tool GoProfileDim object.
863  * @return A GoProfileDimCenterZ measurement.
864  */
866 
867 /**
868 * Returns a GoProfileDim Center point feature object.
869 *
870 * @public @memberof GoProfileDim
871 * @version Introduced in firmware 4.0.10.27
872 * @param tool GoProfileDim object.
873 * @return A GoProfileDimensionCenterPoint Center point feature.
874 */
876 
877 /**
878  * @class GoProfileGroove
879  * @extends GoProfileTool
880  * @ingroup GoSdk-ProfileTools
881  * @brief Represents a profile groove tool.
882  */
883 typedef GoProfileTool GoProfileGroove;
884 
885 /**
886  * Adds an additional profile groove tool measurement.
887  *
888  * @public @memberof GoProfileGroove
889  * @version Introduced in firmware 4.0.10.27
890  * @param tool GoProfileGroove object.
891  * @param type The measurement type to add. It must be a valid profile groove tool type.
892  * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
893  * @return Operation status.
894  */
895 GoFx(kStatus) GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement* measurement);
896 
897 /**
898  * Removes a measurement from the tool at the given index.
899  *
900  * @public @memberof GoProfileGroove
901  * @version Introduced in firmware 4.0.10.27
902  * @param tool GoProfileGroove object.
903  * @param index The index with which to remove a measurement.
904  * @return Operation status.
905  */
906 GoFx(kStatus) GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index);
907 
908 /**
909  * Returns the measurement count for the given tool.
910  *
911  * @public @memberof GoProfileGroove
912  * @version Introduced in firmware 4.0.10.27
913  * @param tool GoProfileGroove object.
914  * @return Tool measurement count.
915  */
916 GoFx(kSize) GoProfileGroove_MeasurementCount(GoProfileGroove tool);
917 
918 /**
919  * Returns a measurement object at the given index.
920  *
921  * @public @memberof GoProfileGroove
922  * @version Introduced in firmware 4.0.10.27
923  * @param tool GoProfileGroove object.
924  * @param index The index with which to return a measurement object.
925  * @return A profile groove tool measurement or kNULL if the index is invalid.
926  */
927 GoFx(GoMeasurement) GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index);
928 
929 /**
930  * Gets the current groove determination shape.
931  *
932  * @public @memberof GoProfileGroove
933  * @version Introduced in firmware 4.0.10.27
934  * @param tool GoProfileGroove object.
935  * @return The profile groove shape.
936  */
937 GoFx(GoProfileGrooveShape) GoProfileGroove_Shape(GoProfileGroove tool);
938 
939 /**
940  * Sets the groove determination shape.
941  *
942  * @public @memberof GoProfileGroove
943  * @version Introduced in firmware 4.0.10.27
944  * @param tool GoProfileGroove object.
945  * @param shape The intended profile groove shape.
946  * @return Operation status.
947  */
948 GoFx(kStatus) GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape);
949 
950 /**
951  * Gets the groove depth minimum.
952  *
953  * @public @memberof GoProfileGroove
954  * @version Introduced in firmware 4.0.10.27
955  * @param tool GoProfileGroove object.
956  * @return The groove depth minimum value.(mm)
957  */
958 GoFx(k64f) GoProfileGroove_MinDepth(GoProfileGroove tool);
959 
960 /**
961  * Sets the groove depth minimum.
962  *
963  * @public @memberof GoProfileGroove
964  * @version Introduced in firmware 4.0.10.27
965  * @param tool GoProfileGroove object.
966  * @param depth The minimum groove depth value to set.(mm)
967  * @return Operation status.
968  */
969 GoFx(kStatus) GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth);
970 
971 /**
972  * Gets the groove width maximum.
973  *
974  * @public @memberof GoProfileGroove
975  * @version Introduced in firmware 4.0.10.27
976  * @param tool GoProfileGroove object.
977  * @return The groove width maximum value.(mm)
978  */
979 GoFx(k64f) GoProfileGroove_MaxWidth(GoProfileGroove tool);
980 
981 /**
982  * Sets the groove width maximum.
983  *
984  * @public @memberof GoProfileGroove
985  * @version Introduced in firmware 4.0.10.27
986  * @param tool GoProfileGroove object.
987  * @param width The maximum groove width value to set.(mm)
988  * @return Operation status.
989  */
990 GoFx(kStatus) GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width);
991 
992 /**
993  * Gets the groove width minimum value.
994  *
995  * @public @memberof GoProfileGroove
996  * @version Introduced in firmware 4.0.10.27
997  * @param tool GoProfileGroove object.
998  * @return The groove width minimum.(mm)
999  */
1000 GoFx(k64f) GoProfileGroove_MinWidth(GoProfileGroove tool);
1001 
1002 /**
1003  * Sets the groove width minimum.
1004  *
1005  * @public @memberof GoProfileGroove
1006  * @version Introduced in firmware 4.0.10.27
1007  * @param tool GoProfileGroove object.
1008  * @param width The minimum groove width value to set.(mm)
1009  * @return Operation status.
1010  */
1011 GoFx(kStatus) GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width);
1012 
1013 /**
1014  * Gets the profile region.
1015  *
1016  * @public @memberof GoProfileGroove
1017  * @version Introduced in firmware 4.0.10.27
1018  * @param tool GoProfileGroove object.
1019  * @return The profile region.
1020  */
1021 GoFx(GoProfileRegion) GoProfileGroove_Region(GoProfileGroove tool);
1022 
1023 /**
1024  * Indicates whether the region is enabled.
1025  *
1026  * @public @memberof GoProfileGroove
1027  * @version Introduced in firmware 4.4.4.14
1028  * @param tool GoProfileGroove object.
1029  * @return kTRUE if enabled and kFALSE otherwise.
1030  */
1031 GoFx(kBool) GoProfileGroove_RegionEnabled(GoProfileGroove tool);
1032 
1033 /**
1034  * Enables or disables the region.
1035  *
1036  * @public @memberof GoProfileGroove
1037  * @version Introduced in firmware 4.4.4.14
1038  * @param tool GoProfileGroove object.
1039  * @param enable kTRUE to enable the region and kFALSE to disable it.
1040  * @return Operation status.
1041  */
1042 GoFx(kStatus) GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable);
1043 
1044 
1045 /**
1046  * @class GoProfileIntersect
1047  * @extends GoProfileTool
1048  * @ingroup GoSdk-ProfileTools
1049  * @brief Represents a profile intersect tool.
1050  */
1051 typedef GoProfileTool GoProfileIntersect;
1052 
1053 
1054 /**
1055  * Gets the reference profile line type.
1056  *
1057  * @public @memberof GoProfileIntersect
1058  * @version Introduced in firmware 4.0.10.27
1059  * @param tool GoProfileIntersect object.
1060  * @return The profile line type.
1061  */
1062 GoFx(GoProfileBaseline) GoProfileIntersect_RefLineType(GoProfileIntersect tool);
1063 
1064 /**
1065  * Sets the reference line type.
1066  *
1067  * @public @memberof GoProfileIntersect
1068  * @version Introduced in firmware 4.0.10.27
1069  * @param tool GoProfileIntersect object.
1070  * @param type The line type to set.
1071  * @return
1072  */
1073 GoFx(kStatus) GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type);
1074 
1075 /**
1076  * Gets the reference profile line.
1077  *
1078  * @public @memberof GoProfileIntersect
1079  * @version Introduced in firmware 4.0.10.27
1080  * @param tool GoProfileIntersect object.
1081  * @return The reference profile line.
1082  */
1083 GoFx(GoProfileLineRegion) GoProfileIntersect_RefLine(GoProfileIntersect tool);
1084 
1085 /**
1086  * Gets the non-reference profile line.
1087  *
1088  * @public @memberof GoProfileIntersect
1089  * @version Introduced in firmware 4.0.10.27
1090  * @param tool GoProfileIntersect object.
1091  * @return The non-reference profile line.
1092  */
1093 GoFx(GoProfileLineRegion) GoProfileIntersect_Line(GoProfileIntersect tool);
1094 
1095 /**
1096  * Returns a GoProfileIntersect X measurement object.
1097  *
1098  * @public @memberof GoProfileIntersect
1099  * @version Introduced in firmware 4.0.10.27
1100  * @param tool GoProfileIntersect object.
1101  * @return A GoProfileIntersect X measurement. (mm)
1102  */
1103 GoFx(GoProfileIntersectX) GoProfileIntersect_XMeasurement(GoProfileIntersect tool);
1104 
1105 /**
1106  * Returns a GoProfileIntersect Z measurement object.
1107  *
1108  * @public @memberof GoProfileIntersect
1109  * @version Introduced in firmware 4.0.10.27
1110  * @param tool GoProfileIntersect object.
1111  * @return A GoProfileIntersect Z measurement.(mm)
1112  */
1113 GoFx(GoProfileIntersectZ) GoProfileIntersect_ZMeasurement(GoProfileIntersect tool);
1114 
1115 /**
1116  * Returns a GoProfileIntersect Angle measurement object.
1117  *
1118  * @public @memberof GoProfileIntersect
1119  * @version Introduced in firmware 4.0.10.27
1120  * @param tool GoProfileIntersect object.
1121  * @return A GoProfileIntersect Angle measurement.(degrees)
1122  */
1123 GoFx(GoProfileIntersectAngle) GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool);
1124 
1125 /**
1126 * Returns a GoProfileIntersect Angle measurement object.
1127 *
1128 * @public @memberof GoProfileIntersect
1129 * @version Introduced in firmware 4.0.10.27
1130 * @param tool GoProfileIntersect object.
1131 * @return A GoProfileIntersect Angle measurement.(degrees)
1132 */
1134 
1135 /**
1136 * Returns a GoProfileIntersectLine Feature object.
1137 *
1138 * @public @memberof GoProfileIntersect
1139 * @version Introduced in firmware 4.6.4.10
1140 * @param tool GoProfileIntersect object.
1141 * @return A GoProfileIntersectLine feature object.
1142 */
1143 GoFx(GoProfileIntersectLine) GoProfileIntersect_LineFeature(GoProfileIntersect tool);
1144 
1145 /**
1146 * Returns a GoProfileIntersectBaseLine Feature object.
1147 *
1148 * @public @memberof GoProfileIntersect
1149 * @version Introduced in firmware 4.6.4.10
1150 * @param tool GoProfileIntersect object.
1151 * @return A GoProfileIntersectBaseLine feature object.
1152 */
1153 GoFx(GoProfileIntersectBaseLine) GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool);
1154 
1155 
1156 /**
1157  * @class GoProfileLine
1158  * @extends GoProfileTool
1159  * @ingroup GoSdk-ProfileTools
1160  * @brief Represents a profile line tool.
1161  */
1162 typedef GoProfileTool GoProfileLine;
1163 
1164 /**
1165  * Gets the measurement region.
1166  *
1167  * @public @memberof GoProfileDev
1168  * @version Introduced in firmware 4.0.10.27
1169  * @param tool GoProfileDev object.
1170  * @return The profile Line Measurement region.
1171  */
1172 GoFx(GoProfileRegion) GoProfileLine_Region(GoProfileLine tool);
1173 
1174 /**
1175  * Indicates whether the region is enabled.
1176  *
1177  * @public @memberof GoProfileLine
1178  * @version Introduced in firmware 4.4.4.14
1179  * @param tool GoProfileLine object.
1180  * @return kTRUE if enabled and kFALSE otherwise.
1181  */
1182 GoFx(kBool) GoProfileLine_RegionEnabled(GoProfileLine tool);
1183 
1184 /**
1185  * Enables or disables the region.
1186  *
1187  * @public @memberof GoProfileLine
1188  * @version Introduced in firmware 4.4.4.14
1189  * @param tool GoProfileLine object.
1190  * @param enable kTRUE to enable the region and kFALSE to disable it.
1191  * @return Operation status.
1192  */
1193 GoFx(kStatus) GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable);
1194 
1195 /**
1196 * Gets the fitting regions.
1197 *
1198 * @public @memberof GoProfileDev
1199 * @version Introduced in firmware 4.6.0.95
1200 * @param tool GoProfileLine object.
1201 * @return The profile Line fitting regions.
1202 */
1203 GoFx(GoProfileLineRegion) GoProfileLine_FittingRegions(GoProfileLine tool);
1204 
1205 /**
1206 * Indicates whether the fitting regions are enabled.
1207 *
1208 * @public @memberof GoProfileLine
1209 * @version Introduced in firmware 4.6.0.147
1210 * @param tool GoProfileLine object.
1211 * @return kTRUE if enabled and kFALSE otherwise.
1212 */
1213 GoFx(kBool) GoProfileLine_FittingRegionsEnabled(GoProfileLine tool);
1214 
1215 /**
1216 * Enables or disables the fitting regions.
1217 *
1218 * @public @memberof GoProfileLine
1219 * @version Introduced in firmware 4.6.0.147
1220 * @param tool GoProfileLine object.
1221 * @param enable Boolean enable or disable fitting regions.
1222 * @return kTRUE if enabled and kFALSE otherwise.
1223 */
1224 GoFx(kStatus) GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable);
1225 
1226 /**
1227  * Returns a GoProfileLine Standard Deviation measurement object.
1228  *
1229  * @public @memberof GoProfileLine
1230  * @version Introduced in firmware 4.0.10.27
1231  * @param tool GoProfileLine object.
1232  * @return A GoProfileLine Standard Deviation measurement.
1233  */
1234 GoFx(GoProfileLineStdDev) GoProfileLine_StdDevMeasurement(GoProfileLine tool);
1235 
1236 /**
1237  * Returns a GoProfileLine Maximum Error measurement object.
1238  *
1239  * @public @memberof GoProfileLine
1240  * @version Introduced in firmware 4.0.10.27
1241  * @param tool GoProfileLine object.
1242  * @return A GoProfileLine Maximum Error measurement.
1243  */
1245 
1246 /**
1247  * Returns a GoProfileLine Minimum Error measurement object.
1248  *
1249  * @public @memberof GoProfileLine
1250  * @version Introduced in firmware 4.0.10.27
1251  * @param tool GoProfileLine object.
1252  * @return A GoProfileLine Minimum Error measurement.
1253  */
1255 
1256 /**
1257  * Returns a GoProfileLine Percentile measurement object.
1258  *
1259  * @public @memberof GoProfileLine
1260  * @version Introduced in firmware 4.0.10.27
1261  * @param tool GoProfileLine object.
1262  * @return A GoProfileLine Percentile measurement.
1263  */
1265 
1266 /**
1267  * Returns a GoProfileLine Offset measurement object.
1268  *
1269  * @public @memberof GoProfileLine
1270  * @version Introduced in firmware 4.6.0.49
1271  * @param tool GoProfileLine object.
1272  * @return A GoProfileLine Offset measurement.
1273  */
1274 GoFx(GoProfileLineOffset) GoProfileLine_OffsetMeasurement(GoProfileLine tool);
1275 
1276 /**
1277  * Returns a GoProfileLine Angle measurement object.
1278  *
1279  * @public @memberof GoProfileLine
1280  * @version Introduced in firmware 4.6.0.49
1281  * @param tool GoProfileLine object.
1282  * @return A GoProfileLine Angle measurement.
1283  */
1284 GoFx(GoProfileLineAngle) GoProfileLine_AngleMeasurement(GoProfileLine tool);
1285 
1286 /**
1287  * Returns a GoProfileLine Minimum X Error measurement object.
1288  *
1289  * @public @memberof GoProfileLine
1290  * @version Introduced in firmware 4.6.0.49
1291  * @param tool GoProfileLine object.
1292  * @return A GoProfileLine Minimum X Error measurement.
1293  */
1295 
1296 /**
1297  * Returns a GoProfileLine Minimum Z Error measurement object.
1298  *
1299  * @public @memberof GoProfileLine
1300  * @version Introduced in firmware 4.6.0.49
1301  * @param tool GoProfileLine object.
1302  * @return A GoProfileLine Minimum Z Error measurement.
1303  */
1305 
1306 /**
1307  * Returns a GoProfileLine Maximum X Error measurement object.
1308  *
1309  * @public @memberof GoProfileLine
1310  * @version Introduced in firmware 4.6.0.49
1311  * @param tool GoProfileLine object.
1312  * @return A GoProfileLine Maximum X Error measurement.
1313  */
1315 
1316 /**
1317  * Returns a GoProfileLine Maximum Z Error measurement object.
1318  *
1319  * @public @memberof GoProfileLine
1320  * @version Introduced in firmware 4.6.0.49
1321  * @param tool GoProfileLine object.
1322  * @return A GoProfileLine Maximum Z Error measurement.
1323  */
1325 
1326 /**
1327 * Returns a GoProfileLine line feature object.
1328 *
1329 * @public @memberof GoProfileLine
1330 * @version Introduced in firmware 4.6.0.49
1331 * @param tool GoProfileLine object.
1332 * @return A GoProfileLineLine line feature.
1333 */
1334 GoFx(GoProfileLineLine) GoProfileLine_Line(GoProfileLine tool);
1335 
1336 /**
1337 * Returns a GoProfileLine Maximum Z Error measurement object.
1338 *
1339 * @public @memberof GoProfileLine
1340 * @version Introduced in firmware 4.6.0.49
1341 * @param tool GoProfileLineMinErrorPoint object.
1342 * @return A GoProfileLineMinErrorPoint min error point feature.
1343 */
1345 
1346 /**
1347 * Returns a GoProfileLine min error point feature object.
1348 *
1349 * @public @memberof GoProfileLine
1350 * @version Introduced in firmware 4.6.0.49
1351 * @param tool GoProfileLineMaxErrorPoint object.
1352 * @return A GoProfileLineMaxErrorPoint min error point feature.
1353 */
1355 
1356 /**
1357  * @class GoProfilePanel
1358  * @extends GoProfileTool
1359  * @ingroup GoSdk-ProfileTools
1360  * @brief Represents a profile panel tool.
1361  */
1362 typedef GoProfileTool GoProfilePanel;
1363 
1364 /**
1365  * Gets the maximum gap width.
1366  *
1367  * @public @memberof GoProfilePanel
1368  * @version Introduced in firmware 4.0.10.27
1369  * @param tool GoProfilePanel object.
1370  * @return The maximum gap width.(mm)
1371  */
1372 GoFx(k64f) GoProfilePanel_MaxGapWidth(GoProfilePanel tool);
1373 
1374 /**
1375  * Sets the maximum gap width.
1376  *
1377  * @public @memberof GoProfilePanel
1378  * @version Introduced in firmware 4.0.10.27
1379  * @param tool GoProfilePanel object.
1380  * @param width The maximum gap width value to set.(mm)
1381  * @return Operation status.
1382  */
1383 GoFx(kStatus) GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width);
1384 
1385 /**
1386  * Gets the reference edge side.
1387  *
1388  * @public @memberof GoProfilePanel
1389  * @version Introduced in firmware 4.0.10.27
1390  * @param tool GoProfilePanel object.
1391  * @return The reference edge side.
1392  */
1393 GoFx(GoProfilePanelSide) GoProfilePanel_RefEdgeSide(GoProfilePanel tool);
1394 
1395 /**
1396  * Sets the reference edge side.
1397  *
1398  * @public @memberof GoProfilePanel
1399  * @version Introduced in firmware 4.0.10.27
1400  * @param tool GoProfilePanel object.
1401  * @param side The reference edge side.
1402  * @return Operation status.
1403  */
1404 GoFx(kStatus) GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side);
1405 
1406 /**
1407  * Gets the left profile edge.
1408  *
1409  * @public @memberof GoProfilePanel
1410  * @version Introduced in firmware 4.0.10.27
1411  * @param tool GoProfilePanel object.
1412  * @return The left profile edge.
1413  */
1414 GoFx(GoProfileEdge) GoProfilePanel_LeftEdge(GoProfilePanel tool);
1415 
1416 /**
1417  * Gets the right profile edge.
1418  *
1419  * @public @memberof GoProfilePanel
1420  * @version Introduced in firmware 4.0.10.27
1421  * @param tool GoProfilePanel object.
1422  * @return The right profile edge.
1423  */
1424 GoFx(GoProfileEdge) GoProfilePanel_RightEdge(GoProfilePanel tool);
1425 
1426 /**
1427  * Returns a GoProfilePanel Gap measurement object.
1428  *
1429  * @public @memberof GoProfilePanel
1430  * @version Introduced in firmware 4.0.10.27
1431  * @param tool GoProfilePanel object.
1432  * @return A GoProfilePanel Gap measurement.
1433  */
1434 GoFx(GoProfilePanelGap) GoProfilePanel_GapMeasurement(GoProfilePanel tool);
1435 
1436 /**
1437  * Returns a GoProfilePanel Flush measurement object.
1438  *
1439  * @public @memberof GoProfilePanel
1440  * @version Introduced in firmware 4.0.10.27
1441  * @param tool GoProfilePanel object.
1442  * @return A GoProfilePanel Flush measurement.
1443  */
1444 GoFx(GoProfilePanelFlush) GoProfilePanel_FlushMeasurement(GoProfilePanel tool);
1445 
1446 /**
1447 * Returns a GoProfilePanel Left Gap X measurement object.
1448 *
1449 * @public @memberof GoProfilePanel
1450 * @version Introduced in firmware 4.0.10.27
1451 * @param tool GoProfilePanel object.
1452 * @return A GoProfilePanel Left Gap X measurement.
1453 */
1454 GoFx(GoProfilePanelGap) GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool);
1455 
1456 /**
1457 * Returns a GoProfilePanel Left Gap Z measurement object.
1458 *
1459 * @public @memberof GoProfilePanel
1460 * @version Introduced in firmware 4.0.10.27
1461 * @param tool GoProfilePanel object.
1462 * @return A GoProfilePanel Left Gap Z measurement.
1463 */
1464 GoFx(GoProfilePanelGap) GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool);
1465 
1466 /**
1467 * Returns a GoProfilePanel Left Flush X measurement object.
1468 *
1469 * @public @memberof GoProfilePanel
1470 * @version Introduced in firmware 4.0.10.27
1471 * @param tool GoProfilePanel object.
1472 * @return A GoProfilePanel Left Flush X measurement.
1473 */
1474 GoFx(GoProfilePanelGap) GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool);
1475 
1476 /**
1477 * Returns a GoProfilePanel Left Flush Z measurement object.
1478 *
1479 * @public @memberof GoProfilePanel
1480 * @version Introduced in firmware 4.0.10.27
1481 * @param tool GoProfilePanel object.
1482 * @return A GoProfilePanel Left Flush Z measurement.
1483 */
1484 GoFx(GoProfilePanelGap) GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool);
1485 
1486 /**
1487 * Returns a GoProfilePanel Left Surface Angle measurement object.
1488 *
1489 * @public @memberof GoProfilePanel
1490 * @version Introduced in firmware 4.0.10.27
1491 * @param tool GoProfilePanel object.
1492 * @return A GoProfilePanel Left Surface Angle measurement.
1493 */
1495 
1496 /**
1497 * Returns a GoProfilePanel Right Gap X measurement object.
1498 *
1499 * @public @memberof GoProfilePanel
1500 * @version Introduced in firmware 4.0.10.27
1501 * @param tool GoProfilePanel object.
1502 * @return A GoProfilePanel Right Gap X measurement.
1503 */
1504 GoFx(GoProfilePanelGap) GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool);
1505 
1506 /**
1507 * Returns a GoProfilePanel Right Gap Z measurement object.
1508 *
1509 * @public @memberof GoProfilePanel
1510 * @version Introduced in firmware 4.0.10.27
1511 * @param tool GoProfilePanel object.
1512 * @return A GoProfilePanel Right Gap Z measurement.
1513 */
1514 GoFx(GoProfilePanelGap) GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool);
1515 
1516 /**
1517 * Returns a GoProfilePanel Right Flush X measurement object.
1518 *
1519 * @public @memberof GoProfilePanel
1520 * @version Introduced in firmware 4.0.10.27
1521 * @param tool GoProfilePanel object.
1522 * @return A GoProfilePanel Right Flush X measurement.
1523 */
1524 GoFx(GoProfilePanelGap) GoProfilePanel_GapPoint(GoProfilePanel tool);
1525 
1526 /**
1527 * Returns a GoProfilePanel Right Flush Z measurement object.
1528 *
1529 * @public @memberof GoProfilePanel
1530 * @version Introduced in firmware 4.0.10.27
1531 * @param tool GoProfilePanel object.
1532 * @return A GoProfilePanel Right Flush Z measurement.
1533 */
1534 GoFx(GoProfilePanelGap) GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool);
1535 
1536 /**
1537 * Returns a GoProfilePanel Right Surface Angle measurement object.
1538 *
1539 * @public @memberof GoProfilePanel
1540 * @version Introduced in firmware 4.0.10.27
1541 * @param tool GoProfilePanel object.
1542 * @return A GoProfilePanel Right Surface Angle measurement.
1543 */
1545 
1546 /**
1547 * Returns a GoProfilePanel Left gap point featuret object.
1548 *
1549 * @public @memberof GoProfilePanel
1550 * @version Introduced in firmware 4.0.10.27
1551 * @param tool GoProfilePanel object.
1552 * @return A GoProfilePanel Left gap point featuret.
1553 */
1554 GoFx(GoProfilePanelLeftGapPoint) GoProfilePanel_LeftGapPoint(GoProfilePanel tool);
1555 
1556 /**
1557 * Returns a GoProfilePanel left flush point feature object.
1558 *
1559 * @public @memberof GoProfilePanel
1560 * @version Introduced in firmware 4.0.10.27
1561 * @param tool GoProfilePanel object.
1562 * @return A GoProfilePanelLeftFlushPoint Right Surface Angle measurement.
1563 */
1565 
1566 /**
1567 * Returns a GoProfilePanel right gap point feature object.
1568 *
1569 * @public @memberof GoProfilePanel
1570 * @version Introduced in firmware 4.0.10.27
1571 * @param tool GoProfilePanel object.
1572 * @return A GoProfilePanelRightGapPoint right gap point feature object.
1573 */
1575 
1576 /**
1577 * Returns a GoProfilePanel right flush point feature object.
1578 *
1579 * @public @memberof GoProfilePanel
1580 * @version Introduced in firmware 4.0.10.27
1581 * @param tool GoProfilePanel object.
1582 * @return A GoProfilePanelRightGapPoint right flush point feature.
1583 */
1585 
1586 /**
1587  * @class GoProfilePosition
1588  * @extends GoProfileTool
1589  * @ingroup GoSdk-ProfileTools
1590  * @brief Represents a profile position tool.
1591  */
1592 typedef GoProfileTool GoProfilePosition;
1593 
1594 /**
1595 * Indicates whether the region is enabled.
1596 *
1597 * @public @memberof GoProfilePosition
1598  * @version Introduced in firmware 4.8.2.76
1599 * @param tool GoProfilePosition object.
1600 * @return kTRUE if enabled and kFALSE otherwise.
1601 */
1602 GoFx(kBool) GoProfilePosition_RegionEnabled(GoProfilePosition tool);
1603 
1604 /**
1605 * Enables or disables the region.
1606 *
1607 * @public @memberof GoProfilePosition
1608  * @version Introduced in firmware 4.8.2.76
1609 * @param tool GoProfilePosition object.
1610 * @param enable kTRUE to enable the region and kFALSE to disable it.
1611 * @return Operation status.
1612 */
1613 GoFx(kStatus) GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable);
1614 /**
1615  * Gets the profile feature.
1616  *
1617  * @public @memberof GoProfilePosition
1618  * @version Introduced in firmware 4.0.10.27
1619  * @param tool GoProfilePos object.
1620  * @return The profile feature.
1621  */
1622 GoFx(GoProfileFeature) GoProfilePosition_Feature(GoProfilePosition tool);
1623 
1624 /**
1625  * Returns a GoProfilePosition X measurement object.
1626  *
1627  * @public @memberof GoProfilePosition
1628  * @version Introduced in firmware 4.0.10.27
1629  * @param tool GoProfilePosition object.
1630  * @return A GoProfilePosition X measurement.(mm)
1631  */
1632 GoFx(GoProfilePositionX) GoProfilePosition_XMeasurement(GoProfilePosition tool);
1633 
1634 /**
1635  * Returns a GoProfilePosition Z measurement object.
1636  *
1637  * @public @memberof GoProfilePosition
1638  * @version Introduced in firmware 4.0.10.27
1639  * @param tool GoProfilePosition object.
1640  * @return A GoProfilePosition Z measurement.(mm)
1641  */
1642 GoFx(GoProfilePositionZ) GoProfilePosition_ZMeasurement(GoProfilePosition tool);
1643 
1644 /**
1645 * Returns a GoProfilePosition point feature object.
1646 *
1647 * @public @memberof GoProfilePosition
1648 * @version Introduced in firmware 4.0.10.27
1649 * @param tool GoProfilePosition object.
1650 * @return A GoProfilePosition point feature.
1651 */
1652 GoFx(GoProfilePositionPoint) GoProfilePosition_Point(GoProfilePosition tool);
1653 
1654 /**
1655  * @class GoProfileStrip
1656  * @extends GoProfileTool
1657  * @ingroup GoSdk-ProfileTools
1658  * @brief Represents a profile strip tool.
1659  */
1660 typedef GoProfileTool GoProfileStrip;
1661 
1662 /**
1663  * Sets the strip base type.
1664  *
1665  * @public @memberof GoProfileStrip
1666  * @version Introduced in firmware 4.0.10.27
1667  * @param tool GoProfileStrip object.
1668  * @param type The strip base type.
1669  * @return Operation status.
1670  */
1671 GoFx(kStatus) GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type);
1672 
1673 /**
1674  * Gets the strip base type.
1675  *
1676  * @public @memberof GoProfileStrip
1677  * @version Introduced in firmware 4.0.10.27
1678  * @param tool GoProfileStrip object.
1679  * @return The strip base type.
1680  */
1681 GoFx(GoProfileStripBaseType) GoProfileStrip_BaseType(GoProfileStrip tool);
1682 
1683 /**
1684  * Gets the left edge value.
1685  *
1686  * @public @memberof GoProfileStrip
1687  * @version Introduced in firmware 4.0.10.27
1688  * @param tool GoProfileStrip object.
1689  * @return The left edge value.
1690  */
1691 GoFx(GoProfileStripEdgeType) GoProfileStrip_LeftEdge(GoProfileStrip tool);
1692 
1693 /**
1694  * Sets the left edge.
1695  *
1696  * @public @memberof GoProfileStrip
1697  * @version Introduced in firmware 4.0.10.27
1698  * @param tool GoProfileStrip object.
1699  * @param leftEdge Left edge value.
1700  * @return Operation status.
1701  */
1702 GoFx(kStatus) GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge);
1703 
1704 /**
1705  * Gets the right edge value.
1706  *
1707  * @public @memberof GoProfileStrip
1708  * @version Introduced in firmware 4.0.10.27
1709  * @param tool GoProfileStrip object.
1710  * @return The right edge value.
1711  */
1712 GoFx(GoProfileStripEdgeType) GoProfileStrip_RightEdge(GoProfileStrip tool);
1713 
1714 /**
1715  * Sets the right edge.
1716  *
1717  * @public @memberof GoProfileStrip
1718  * @version Introduced in firmware 4.0.10.27
1719  * @param tool GoProfileStrip object.
1720  * @param rightEdge Right edge value.
1721  * @return Operation status.
1722  */
1723 GoFx(kStatus) GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge);
1724 
1725 /**
1726  * Gets the tilt enabled state.
1727  *
1728  * @public @memberof GoProfileStrip
1729  * @version Introduced in firmware 4.0.10.27
1730  * @param tool GoProfileStrip object.
1731  * @return kTRUE if tilt is enabled, kFALSE otherwise.
1732  */
1733 GoFx(kBool) GoProfileStrip_TiltEnabled(GoProfileStrip tool);
1734 
1735 /**
1736  * Enables or disables tilt.
1737  *
1738  * @public @memberof GoProfileStrip
1739  * @version Introduced in firmware 4.0.10.27
1740  * @param tool GoProfileStrip object.
1741  * @param enable kTRUE to enable tilt, kFALSE to disable it.
1742  * @return Operation status.
1743  */
1744 GoFx(kStatus) GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable);
1745 
1746 
1747 /**
1748  * Gets the support width.
1749  *
1750  * @public @memberof GoProfileStrip
1751  * @version Introduced in firmware 4.5.3.57
1752  * @param tool GoProfileStrip object.
1753  * @return The support width (in mm).
1754  */
1755 GoFx(k64f) GoProfileStrip_SupportWidth(GoProfileStrip tool);
1756 
1757 /**
1758  * Sets the support width.
1759  *
1760  * @public @memberof GoProfileStrip
1761  * @version Introduced in firmware 4.5.3.57
1762  * @param tool GoProfileStrip object.
1763  * @param value The support width (in mm).
1764  * @return Operation status.
1765  */
1766 GoFx(kStatus) GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value);
1767 
1768 
1769 /**
1770  * Gets the transition width limit minimum.
1771  *
1772  * @public @memberof GoProfileStrip
1773  * @version Introduced in firmware 4.5.3.57
1774  * @param tool GoProfileStrip object.
1775  * @return The minimum permissible transition width (in mm).
1776  */
1777 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool);
1778 
1779 /**
1780  * Gets the transition width limit maximum.
1781  *
1782  * @public @memberof GoProfileStrip
1783  * @version Introduced in firmware 4.5.3.57
1784  * @param tool GoProfileStrip object.
1785  * @return The maximum permissible transition width (in mm).
1786  */
1787 GoFx(k64f) GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool);
1788 
1789 /**
1790  * Gets the transition width.
1791  *
1792  * @public @memberof GoProfileStrip
1793  * @version Introduced in firmware 4.0.10.27
1794  * @param tool GoProfileStrip object.
1795  * @return The transition width (in mm).
1796  */
1797 GoFx(k64f) GoProfileStrip_TransitionWidth(GoProfileStrip tool);
1798 
1799 /**
1800  * Sets the transition width.
1801  *
1802  * @public @memberof GoProfileStrip
1803  * @version Introduced in firmware 4.0.10.27
1804  * @param tool GoProfileStrip object.
1805  * @param value The transition width (in mm).
1806  * @return Operation status.
1807  */
1808 GoFx(kStatus) GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value);
1809 
1810 /**
1811  * Gets the minimum width.
1812  *
1813  * @public @memberof GoProfileStrip
1814  * @version Introduced in firmware 4.0.10.27
1815  * @param tool GoProfileStrip object.
1816  * @return The minimum width (in mm).
1817  */
1818 GoFx(k64f) GoProfileStrip_MinWidth(GoProfileStrip tool);
1819 
1820 /**
1821  * Sets the minimum width.
1822  *
1823  * @public @memberof GoProfileStrip
1824  * @version Introduced in firmware 4.0.10.27
1825  * @param tool GoProfileStrip object.
1826  * @param value The minimum width (in mm).
1827  * @return Operation status.
1828  */
1829 GoFx(kStatus) GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value);
1830 
1831 /**
1832  * Gets the minimum height.
1833  *
1834  * @public @memberof GoProfileStrip
1835  * @version Introduced in firmware 4.0.10.27
1836  * @param tool GoProfileStrip object.
1837  * @return The minimum height (in mm).
1838  */
1839 GoFx(k64f) GoProfileStrip_MinHeight(GoProfileStrip tool);
1840 
1841 /**
1842  * Sets the transition height.
1843  *
1844  * @public @memberof GoProfileStrip
1845  * @version Introduced in firmware 4.0.10.27
1846  * @param tool GoProfileStrip object.
1847  * @param value The minimum height (in mm).
1848  * @return Operation status.
1849  */
1850 GoFx(kStatus) GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value);
1851 
1852 /**
1853  * Gets the maximum void width.
1854  *
1855  * @public @memberof GoProfileStrip
1856  * @version Introduced in firmware 4.0.10.27
1857  * @param tool GoProfileStrip object.
1858  * @return The maximum void width (in mm).
1859  */
1860 GoFx(k64f) GoProfileStrip_MaxVoidWidth(GoProfileStrip tool);
1861 
1862 /**
1863  * Sets the maximum void width.
1864  *
1865  * @public @memberof GoProfileStrip
1866  * @version Introduced in firmware 4.0.10.27
1867  * @param tool GoProfileStrip object.
1868  * @param value The maximum void width (in mm).
1869  * @return Operation status.
1870  */
1871 GoFx(kStatus) GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value);
1872 
1873 /**
1874  * Gets the profile strip tool region.
1875  *
1876  * @public @memberof GoProfileStrip
1877  * @version Introduced in firmware 4.0.10.27
1878  * @param tool GoProfileStrip object.
1879  * @return A GoProfileRegion object.
1880  */
1881 GoFx(GoProfileRegion) GoProfileStrip_Region(GoProfileStrip tool);
1882 
1883 /**
1884  * Indicates whether the region is enabled.
1885  *
1886  * @public @memberof GoProfileStrip
1887  * @version Introduced in firmware 4.4.4.14
1888  * @param tool GoProfileStrip object.
1889  * @return kTRUE if enabled and kFALSE otherwise.
1890  */
1891 GoFx(kBool) GoProfileStrip_RegionEnabled(GoProfileStrip tool);
1892 
1893 /**
1894  * Enables or disables the region.
1895  *
1896  * @public @memberof GoProfileStrip
1897  * @version Introduced in firmware 4.4.4.14
1898  * @param tool GoProfileStrip object.
1899  * @param enable kTRUE to enable the region and kFALSE to disable it.
1900  * @return Operation status.
1901  */
1902 GoFx(kStatus) GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable);
1903 
1904 /**
1905  * Adds an additional profile strip tool measurement.
1906  *
1907  * @public @memberof GoProfileStrip
1908  * @version Introduced in firmware 4.0.10.27
1909  * @param tool GoProfileStrip object.
1910  * @param type The measurement type to add. It must be a valid profile strip tool type.
1911  * @param measurement A reference to the new GoMeasurement handle. Can be kNULL if you do not wish to do anything immediate with the new measurement.
1912  * @return Operation status.
1913  */
1914 GoFx(kStatus) GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement* measurement);
1915 
1916 /**
1917  * Removes a measurement from the tool at the given index.
1918  *
1919  * @public @memberof GoProfileStrip
1920  * @version Introduced in firmware 4.0.10.27
1921  * @param tool GoProfileStrip object.
1922  * @param index The index with which to remove a measurement.
1923  * @return Operation status.
1924  */
1925 GoFx(kStatus) GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index);
1926 
1927 /**
1928  * Returns the measurement count for the given tool.
1929  *
1930  * @public @memberof GoProfileStrip
1931  * @version Introduced in firmware 4.0.10.27
1932  * @param tool GoProfileStrip object.
1933  * @return Tool measurement count.
1934  */
1935 GoFx(kSize) GoProfileStrip_MeasurementCount(GoProfileStrip tool);
1936 
1937 /**
1938  * Returns a measurement object at the given index.
1939  *
1940  * @public @memberof GoProfileStrip
1941  * @version Introduced in firmware 4.0.10.27
1942  * @param tool GoProfileStrip object.
1943  * @param index The index with which to return a measurement object.
1944  * @return A profile strip tool measurement or kNULL if the index is invalid.
1945  */
1946 GoFx(GoMeasurement) GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index);
1947 
1948 
1949 /**
1950  * @class GoProfileXLine
1951  * @extends GoProfileTool
1952  * @ingroup GoSdk-ProfileTools
1953  * @brief Represents a profile X-Line tool.
1954 */
1955 typedef GoProfileTool GoProfileXLine;
1956 
1957 /**
1958  * Returns the enabled state of the tool region.
1959  *
1960  * @public @memberof GoProfileXLine
1961  * @version Introduced in firmware 4.3.3.124
1962  * @param tool GoProfileXLine object.
1963  * @return kTRUE if enabled and kFALSE if disabled.
1964  */
1965 GoFx(kBool) GoProfileXLine_RegionEnabled(GoProfileXLine tool);
1966 
1967 /**
1968  * Enables or disables the tool region.
1969  *
1970  * @public @memberof GoProfileXLine
1971  * @version Introduced in firmware 4.3.3.124
1972  * @param tool GoProfileXLine object.
1973  * @param enable kTRUE to enable the tool region, kFALSE to disable it.
1974  * @return Operation status.
1975  */
1976 GoFx(kStatus) GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable);
1977 
1978 /**
1979  * Gets the profile X-Line tool region.
1980  *
1981  * @public @memberof GoProfileXLine
1982  * @version Introduced in firmware 4.3.3.124
1983  * @param tool GoProfileXLine object.
1984  * @return A GoRegion3d object.
1985  */
1986 GoFx(GoProfileRegion) GoProfileXLine_Region(GoProfileXLine tool);
1987 
1988 /**
1989  * Sets the profile X-Line tool maximum tracking speed.
1990  *
1991  * @public @memberof GoProfileXLine
1992  * @version Introduced in firmware 4.3.3.124
1993  * @param tool GoProfileXLine object.
1994  * @param value The value to set.
1995  * @return Operation status.
1996  */
1997 GoFx(kStatus) GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value);
1998 
1999 /**
2000  * Gets the profile X-Line tool maximum tracking speed.
2001  *
2002  * @public @memberof GoProfileXLine
2003  * @version Introduced in firmware 4.3.3.124
2004  * @param tool GoProfileXLine object.
2005  * @return The maximum tracking speed.(mm/s)
2006  */
2007 GoFx(k64f) GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool);
2008 
2009 /**
2010  * Returns a GoProfileXLine Z measurement object.
2011  *
2012  * @public @memberof GoProfileXLine
2013  * @version Introduced in firmware 4.3.3.124
2014  * @param tool GoProfileXLine object.
2015  * @return A GoProfileXLine Z measurement. (mm)
2016  */
2017 GoFx(GoProfileXLineZ) GoProfileXLine_ZMeasurement(GoProfileXLine tool);
2018 
2019 /**
2020  * Returns a GoProfileXLine Validity measurement object.
2021  *
2022  * @public @memberof GoProfileXLine
2023  * @version Introduced in firmware 4.3.3.124
2024  * @param tool GoProfileXLine object.
2025  * @return A GoProfileXLine Validity measurement.
2026  */
2027 GoFx(GoProfileXLineZ) GoProfileXLine_ValidityMeasurement(GoProfileXLine tool);
2028 
2029 
2030 
2031 /**
2032  * @class GoProfileRoundCorner
2033  * @extends GoProfileTool
2034  * @ingroup GoSdk-ProfileTools
2035  * @brief Represents a profile round corner tool.
2036  */
2037 typedef GoProfileTool GoProfileRoundCorner;
2038 
2039 /**
2040  * Returns a GoProfileRoundCorner X measurement object.
2041  *
2042  * @public @memberof GoProfileRoundCorner
2043  * @version Introduced in firmware 4.0.10.27
2044  * @param tool GoProfileRoundCorner object.
2045  * @return A GoProfileRoundCorner X measurement.(mm)
2046  */
2047 GoFx(GoProfileRoundCornerX) GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool);
2048 
2049 /**
2050  * Returns a GoProfileRoundCorner Z measurement object.
2051  *
2052  * @public @memberof GoProfileRoundCorner
2053  * @version Introduced in firmware 4.0.10.27
2054  * @param tool GoProfileRoundCorner object.
2055  * @return A GoProfileRoundCorner Z measurement.(mm)
2056  */
2057 GoFx(GoProfileRoundCornerZ) GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool);
2058 
2059 /**
2060  * Returns a GoProfileRoundCorner Angle measurement object.
2061  *
2062  * @public @memberof GoProfileRoundCorner
2063  * @version Introduced in firmware 4.0.10.27
2064  * @param tool GoProfileRoundCorner object.
2065  * @return A GoProfileRoundCorner Angle measurement.(degrees)
2066  */
2067 GoFx(GoProfileRoundCornerAngle) GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool);
2068 
2069 /**
2070  * Gets the edge.
2071  *
2072  * @public @memberof GoProfileRoundCorner
2073  * @version Introduced in firmware 4.0.10.27
2074  * @param tool GoProfileRoundCorner object.
2075  * @return The edge.
2076  */
2077 GoFx(GoProfileEdge) GoProfileRoundCorner_Edge(GoProfileRoundCorner tool);
2078 
2079 /**
2080  * Sets the edge.
2081  *
2082  * @public @memberof GoProfileRoundCorner
2083  * @version Introduced in firmware 4.0.10.27
2084  * @param tool GoProfileRoundCorner object.
2085  * @param edge The edge.
2086  * @return Operation status.
2087  */
2088 GoFx(kStatus) GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge);
2089 
2090 /**
2091  * Gets the reference direction.
2092  *
2093  * @public @memberof GoProfileRoundCorner
2094  * @version Introduced in firmware 4.0.10.27
2095  * @param tool GoProfileRoundCorner object.
2096  * @return The reference direction.
2097  */
2098 GoFx(GoProfileRoundCornerDirection) GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool);
2099 
2100 /**
2101  * Sets the reference direction.
2102  *
2103  * @public @memberof GoProfileRoundCorner
2104  * @version Introduced in firmware 4.0.10.27
2105  * @param tool GoProfileRoundCorner object.
2106  * @param direction The reference direction.
2107  * @return Operation status.
2108  */
2109 GoFx(kStatus) GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction);
2110 
2111 /**
2112 * gets the round corner point
2113 *
2114 * @public @memberof GoProfileRoundCorner
2115 * @version Introduced in firmware 4.0.10.27
2116 * @param tool GoProfileRoundCorner object.
2117 * @return A GoProfileRoundCornerPoint point feature
2118 */
2119 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_Point(GoProfileRoundCorner tool);
2120 
2121 /**
2122 * gets the round corner edge point
2123 *
2124 * @public @memberof GoProfileRoundCorner
2125 * @version Introduced in firmware 4.8.1.80
2126 * @param tool GoProfileRoundCorner object.
2127 * @return A GoProfileRoundCornerEdgePoint point feature
2128 */
2129 GoFx(GoProfileRoundCornerPoint) GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool);
2130 
2131 /**
2132 * gets the round corner center point
2133 *
2134 * @public @memberof GoProfileRoundCorner
2135 * @version Introduced in firmware 4.8.1.80
2136 * @param tool GoProfileRoundCorner object.
2137 * @return A GoProfileRoundCornerCenterPoint point feature
2138 */
2139 GoFx(GoProfileRoundCornerCenterPoint) GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool);
2140 
2141 kEndHeader()
2142 #include <GoSdk/Tools/GoProfileTools.x.h>
2143 
2144 #endif
GoProfileBoxWidth GoProfileBox_WidthMeasurement(GoProfileBox tool)
Returns a GoProfileBox Width measurement object.
GoProfileLineMinErrorZ GoProfileLine_MinErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Z Error measurement object.
Represents a round corner point of a Profile Round tool.
kBool GoProfileTool_ZAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid Z-anchoring source has been set for Z-anc...
GoProfilePositionPoint GoProfilePosition_Point(GoProfilePosition tool)
Returns a GoProfilePosition point feature object.
kStatus GoProfileXLine_EnableRegion(GoProfileXLine tool, kBool enable)
Enables or disables the tool region.
GoProfilePanelRightGapPoint GoProfilePanel_RightGapPoint(GoProfilePanel tool)
Returns a GoProfilePanel right gap point feature object.
Represents a profile line tool.
kStatus GoProfileStrip_SetMinHeight(GoProfileStrip tool, k64f value)
Sets the transition height.
Declares the base GoTool class.
GoProfileRegion GoProfileStrip_Region(GoProfileStrip tool)
Gets the profile strip tool region.
kStatus GoProfileStrip_SetRightEdge(GoProfileStrip tool, GoProfileStripEdgeType rightEdge)
Sets the right edge.
Represents an X value measurement for a Profile Circle Tool.
GoProfileBoxHeight GoProfileBox_HeightMeasurement(GoProfileBox tool)
Returns a GoProfileBox Height measurement object.
GoProfileIntersectZ GoProfileIntersect_ZMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Z measurement object.
GoProfileBridgeValueBridgeValue GoProfileBridgeValue_BridgeValueMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue bridge value measurement object.
GoProfileBoundingBoxCenterPoint GoProfileBox_CenterPoint(GoProfileBox tool)
Returns a GoProfileBox center point feature object.
Represents the base class for a tool measurement or script output.
Represents a corner point for a Profile Bounding Box tool.
GoProfileLineAngle GoProfileLine_AngleMeasurement(GoProfileLine tool)
Returns a GoProfileLine Angle measurement object.
kBool GoProfileBox_RegionEnabled(GoProfileBox tool)
Returns the enabled state of the tool region.
Represents a right flush point of a Profile Panel tool.
GoProfilePanelGap GoProfilePanel_LeftSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Surface Angle measurement object.
kBool GoProfilePosition_RegionEnabled(GoProfilePosition tool)
Indicates whether the region is enabled.
Represents a Z measurement for a Profile Bounding Box tool.
kStatus GoProfileIntersect_SetRefLineType(GoProfileIntersect tool, GoProfileBaseline type)
Sets the reference line type.
Represents a left flush point of a Profile Panel tool.
Represents a round corner circle center point of a Profile Round tool.
kStatus GoProfileStrip_EnableRegion(GoProfileStrip tool, kBool enable)
Enables or disables the region.
GoProfileRegion GoProfileGroove_Region(GoProfileGroove tool)
Gets the profile region.
kStatus GoProfileLine_EnableFittingRegions(GoProfileLine tool, kBool enable)
Enables or disables the fitting regions.
GoProfileLineLine GoProfileLine_Line(GoProfileLine tool)
Returns a GoProfileLine line feature object.
GoProfileIntersectBaseLine GoProfileIntersect_BaseLineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectBaseLine Feature object.
GoProfileCircleRadius GoProfileCircle_RadiusMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Radius measurement object.
GoProfileLineRegion GoProfileIntersect_RefLine(GoProfileIntersect tool)
Gets the reference profile line.
GoProfileBoxX GoProfileBox_XMeasurement(GoProfileBox tool)
Returns a GoProfileBox X measurement object.
kStatus GoProfileBridgeValue_SetMaxInvalid(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max invalid percentage.
k64f GoProfileGroove_MaxWidth(GoProfileGroove tool)
Gets the groove width maximum.
kStatus GoProfileGroove_SetMaxWidth(GoProfileGroove tool, k64f width)
Sets the groove width maximum.
GoProfileRoundCornerPoint GoProfileRoundCorner_Point(GoProfileRoundCorner tool)
gets the round corner point
GoProfileEdge GoProfileRoundCorner_Edge(GoProfileRoundCorner tool)
Gets the edge.
kStatus GoProfileGroove_SetMinDepth(GoProfileGroove tool, k64f depth)
Sets the groove depth minimum.
GoProfilePanelGap GoProfilePanel_RightGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap Z measurement object.
Represents a gap measurement for a Profile Panel Tool.
kStatus GoProfileBridgeValue_EnableRegion(GoProfileBridgeValue tool, kBool enable)
Enables or disables the tool region.
kSize GoProfileTool_XAnchorOptionCount(GoProfileTool tool)
Gets the X-anchoring option list count.
Lists all measurement types.
kStatus GoProfileGroove_AddMeasurement(GoProfileGroove tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile groove tool measurement.
Represents a profile dimension tool.
GoProfileLineRegion GoProfileArea_LineRegion(GoProfileArea tool)
Gets the reference profile line.
kStatus GoProfileXLine_SetMaxTrackingSpeed(GoProfileXLine tool, k64f value)
Sets the profile X-Line tool maximum tracking speed.
Represents a right gap point of a Profile Panel tool.
GoDataStream GoProfileTool_StreamOptionAt(GoProfileTool tool, kSize index)
Gets the data stream option at the given index.
Represents a center X value measurement for a Profile Dimension Tool.
Represents a flush measurement for a Profile Panel Tool.
GoProfileRegion GoProfileBridgeValue_Region(GoProfileBridgeValue tool)
Gets the bridge value profile region.
Represents a profile bounding box tool.
GoProfileLineMaxErrorPoint GoProfileLine_MaxErrorPoint(GoProfileLine tool)
Returns a GoProfileLine min error point feature object.
GoProfileLineMinError GoProfileLine_MinErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum Error measurement object.
Represents a point of a Profile Line tool.
kStatus GoProfileGroove_EnableRegion(GoProfileGroove tool, kBool enable)
Enables or disables the region.
GoProfileFeature GoProfilePosition_Feature(GoProfilePosition tool)
Gets the profile feature.
ReprRepresents a center point for a Profile Bounding Box tool.
GoProfileBoundingBoxCornerPoint GoProfileBox_CornerPoint(GoProfileBox tool)
Returns a GoProfileBox corner point feature object.
kStatus GoProfileGroove_SetShape(GoProfileGroove tool, GoProfileGrooveShape shape)
Sets the groove determination shape.
kStatus GoProfileArea_EnableRegion(GoProfileArea tool, kBool enable)
Enables or disables the region.
Represents a Maximum Z Error measurement for a Profile Line Tool.
GoProfileLineMaxErrorZ GoProfileLine_MaxErrorZMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
kStatus GoProfilePanel_SetRefEdgeSide(GoProfilePanel tool, GoProfilePanelSide side)
Sets the reference edge side.
Represents a point of intersection for a Profile Intersect tool.
Represents an standard deviation measurement for a Profile Bridge Value tool.
k64f GoProfileStrip_MinWidth(GoProfileStrip tool)
Gets the minimum width.
GoProfileRegion GoProfileCircle_Region(GoProfileCircle tool)
Gets the profile region.
k64f GoProfileBridgeValue_WindowSkip(GoProfileBridgeValue tool)
Gets the profile X-Line tool window skip percentage.
GoMeasurement GoProfileGroove_MeasurementAt(GoProfileGroove tool, kSize index)
Returns a measurement object at the given index.
kStatus GoProfileStrip_RemoveMeasurement(GoProfileStrip tool, kSize index)
Removes a measurement from the tool at the given index.
GoProfileStripEdgeType GoProfileStrip_RightEdge(GoProfileStrip tool)
Gets the right edge value.
kStatus GoProfileArea_SetType(GoProfileArea tool, GoProfileAreaType type)
Sets the profile area type.
GoProfileRegion GoProfileBox_Region(GoProfileBox tool)
Gets the profile bounding box region.
k32s GoProfileTool_ZAnchor(GoProfileTool tool)
Gets the current Z-anchoring source.
kSize GoProfileStrip_MeasurementCount(GoProfileStrip tool)
Returns the measurement count for the given tool.
Represents a profile intersect tool.
Represents an Z measurement for a Profile Round Corner tool.
Represents a Minimum Z Error measurement for a Profile Line Tool.
GoProfileIntersectLine GoProfileIntersect_LineFeature(GoProfileIntersect tool)
Returns a GoProfileIntersectLine Feature object.
kStatus GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source)
Sets the data source.
GoProfileBoxGlobalX GoProfileBox_GlobalXMeasurement(GoProfileBox tool)
Returns a GoProfileBox global X measurement object.
Represents a width value measurement for a Profile Dimension Tool.
kSize GoProfileTool_StreamOptionCount(GoProfileTool tool)
Gets the data stream option list count.
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:1145
Represents a data source.
GoProfilePanelGap GoProfilePanel_LeftGapZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap Z measurement object.
Represents an angle measurement for a Profile Bridge Value tool.
Represents a profile area tool.
kStatus GoProfileStrip_SetTransitionWidth(GoProfileStrip tool, k64f value)
Sets the transition width.
k64f GoProfileGroove_MinDepth(GoProfileGroove tool)
Gets the groove depth minimum.
GoProfilePanelFlush GoProfilePanel_FlushMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Flush measurement object.
GoProfileAreaCenterPoint GoProfileArea_CenterPoint(GoProfileArea tool)
Returns a GoProfileArea Center point feature object.
kBool GoProfileStrip_TiltEnabled(GoProfileStrip tool)
Gets the tilt enabled state.
Contains various helper functions.
GoProfilePanelGap GoProfilePanel_LeftFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush Z measurement object.
GoProfileRoundCornerDirection GoProfileRoundCorner_RefDirection(GoProfileRoundCorner tool)
Gets the reference direction.
Represents an intersect X measurement for a Profile Intersect Tool.
Represents a profile panel tool.
GoProfileLineRegion GoProfileIntersect_Line(GoProfileIntersect tool)
Gets the non-reference profile line.
kBool GoProfileBridgeValue_NormalizeEnabled(GoProfileBridgeValue tool)
Returns the enabled state of normalization.
Represents a maximum error measurement for a Profile Line Tool.
GoProfileAreaType GoProfileArea_Type(GoProfileArea tool)
Gets the profile area type.
Represents a left gap point of a Profile Panel tool.
Represents a profile groove tool.
kBool GoProfileXLine_RegionEnabled(GoProfileXLine tool)
Returns the enabled state of the tool region.
GoProfileStripEdgeType GoProfileStrip_LeftEdge(GoProfileStrip tool)
Gets the left edge value.
k64f GoProfileBridgeValue_MaxDifferentialLimitMax(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential maximum value limit.
Represents a centroid Z measurement for a Profile Area Tool.
GoProfileRoundCornerCenterPoint GoProfileRoundCorner_CenterPoint(GoProfileRoundCorner tool)
gets the round corner center point
kStatus GoProfileStrip_SetMaxVoidWidth(GoProfileStrip tool, k64f value)
Sets the maximum void width.
GoProfileAreaArea GoProfileArea_AreaMeasurement(GoProfileArea tool)
Returns a GoProfileArea Area measurement object.
k64f GoProfileBridgeValue_MaxDifferentialLimitMin(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential minimum value limit.
GoProfileLineMinErrorPoint GoProfileLine_MinErrorPoint(GoProfileLine tool)
Returns a GoProfileLine Maximum Z Error measurement object.
kStatus GoProfileBridgeValue_EnableNormalize(GoProfileBridgeValue tool, kBool enable)
Enables or disables normalization.
kBool GoProfileTool_XAnchorEnabled(GoProfileTool tool)
Returns a boolean value representing whether or not a valid X-anchoring source has been set for X-anc...
Represents a profile circle tool.
GoProfileDimensionCenterPoint GoProfileDim_CenterPoint(GoProfileDim tool)
Returns a GoProfileDim Center point feature object.
GoProfilePanelGap GoProfilePanel_GapPoint(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush X measurement object.
GoProfileAreaCentroidX GoProfileArea_CentroidXMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid X measurement object.
k32s GoProfileTool_XAnchor(GoProfileTool tool)
Gets the current X-anchoring source.
Represents an area measurement for a Profile Area tool.
GoProfileEdge GoProfilePanel_RightEdge(GoProfilePanel tool)
Gets the right profile edge.
Represents a height measurement for a Profile Bounding Box tool.
GoProfileIntersectIntersectPoint GoProfileIntersect_PointFeature(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
Represents a global angle measurement for a Profile Bounding Box tool.
Represents a minimum error measurement for a Profile Line Tool.
kBool GoProfileGroove_RegionEnabled(GoProfileGroove tool)
Indicates whether the region is enabled.
kStatus GoProfilePosition_EnableRegion(GoProfilePosition tool, kBool enable)
Enables or disables the region.
Represents an Z measurement for a Profile Position tool.
Essential SDK declarations.
GoProfileRoundCornerX GoProfileRoundCorner_XMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner X measurement object.
GoProfileBaseline GoProfileArea_Baseline(GoProfileArea tool)
Gets the profile area baseline.
kStatus GoProfileRoundCorner_SetRefDirection(GoProfileRoundCorner tool, GoProfileRoundCornerDirection direction)
Sets the reference direction.
GoProfileDimCenterX GoProfileDim_CenterXMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center X measurement object.
k32u GoProfileTool_ZAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the Z-anchoring option at the given index.
GoProfileIntersectX GoProfileIntersect_XMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect X measurement object.
GoProfilePositionZ GoProfilePosition_ZMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition Z measurement object.
kStatus GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id)
Sets the Z-anchoring source.
GoProfileBoxGlobalAngle GoProfileBox_GlobalAngleMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Angle measurement object.
k64f GoProfileBridgeValue_MaxDifferential(GoProfileBridgeValue tool)
Gets the profile X-Line tool max differential.
Represents a percentile measurement for a Profile Line Tool.
GoProfilePanelSide GoProfilePanel_RefEdgeSide(GoProfilePanel tool)
Gets the reference edge side.
GoProfilePanelGap GoProfilePanel_LeftGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Gap X measurement object.
Represents a profile strip tool.
kStatus GoProfileCircle_EnableRegion(GoProfileCircle tool, kBool enable)
Enables or disables the region.
GoProfileLineStdDev GoProfileLine_StdDevMeasurement(GoProfileLine tool)
Returns a GoProfileLine Standard Deviation measurement object.
GoProfileStripBaseType GoProfileStrip_BaseType(GoProfileStrip tool)
Gets the strip base type.
GoProfileBridgeValueWindow GoProfileBridgeValue_WindowMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue window measurement object.
Represents a center point of a Profile Area tool.
Represents the base tool class.
Represents a point of a Profile Position tool.
GoProfileDimWidth GoProfileDim_WidthMeasurement(GoProfileDim tool)
Returns a GoProfileDim Width measurement object.
Represents an X measurement for a Profile Bounding Box tool.
GoDataStream GoProfileTool_Stream(GoProfileTool tool)
Gets the data stream.
kStatus GoProfileBox_EnableRegion(GoProfileBox tool, kBool enable)
Enables or disables the tool region.
GoProfileAreaCentroidZ GoProfileArea_CentroidZMeasurement(GoProfileArea tool)
Returns a GoProfileArea Centroid Z measurement object.
kBool GoProfileLine_FittingRegionsEnabled(GoProfileLine tool)
Indicates whether the fitting regions are enabled.
Represents a profile bridge value tool.
Represents a height value measurement for a Profile Dimension Tool.
Represents a center point of a Profile Circle tool.
GoProfilePanelRightFlushPoint GoProfilePanel_RightFlushPoint(GoProfilePanel tool)
Returns a GoProfilePanel right flush point feature object.
k64f GoProfileStrip_MaxVoidWidth(GoProfileStrip tool)
Gets the maximum void width.
GoProfileBaseline GoProfileIntersect_RefLineType(GoProfileIntersect tool)
Gets the reference profile line type.
GoProfileLinePercentile GoProfileLine_PercentileMeasurement(GoProfileLine tool)
Returns a GoProfileLine Percentile measurement object.
kBool GoProfileStrip_RegionEnabled(GoProfileStrip tool)
Indicates whether the region is enabled.
Represents a Z value measurement for a Profile Circle Tool.
GoProfileEdge GoProfilePanel_LeftEdge(GoProfilePanel tool)
Gets the left profile edge.
k32u GoProfileTool_XAnchorOptionAt(GoProfileTool tool, kSize index)
Gets the X-anchoring option at the given index.
Represents a global Y measurement for a Profile Bounding Box tool.
k64f GoProfileStrip_SupportWidth(GoProfileStrip tool)
Gets the support width.
GoProfileFeature GoProfileDim_Feature(GoProfileDim tool)
Gets the non-reference profile feature.
GoProfileRoundCornerZ GoProfileRoundCorner_ZMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Z measurement object.
kBool GoProfileArea_BaselineUsed(GoProfileArea tool)
Returns a boolean representing whether the profile area baseline is used.
GoDataSource GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index)
Gets the data source option at the given index.
GoProfileFeature GoProfileDim_RefFeature(GoProfileDim tool)
Gets the reference profile feature.
GoProfileRegion GoProfileArea_Region(GoProfileArea tool)
Gets the profile region.
k64f GoProfileStrip_MinHeight(GoProfileStrip tool)
Gets the minimum height.
k64f GoProfileBridgeValue_WindowSize(GoProfileBridgeValue tool)
Gets the profile X-Line tool window size percentage.
kStatus GoProfileStrip_AddMeasurement(GoProfileStrip tool, GoMeasurementType type, GoMeasurement *measurement)
Adds an additional profile strip tool measurement.
GoMeasurement GoProfileStrip_MeasurementAt(GoProfileStrip tool, kSize index)
Returns a measurement object at the given index.
kStatus GoProfileBridgeValue_SetMaxDifferential(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool max differential.
GoProfileLineOffset GoProfileLine_OffsetMeasurement(GoProfileLine tool)
Returns a GoProfileLine Offset measurement object.
kStatus GoProfileStrip_SetBaseType(GoProfileStrip tool, GoProfileStripBaseType type)
Sets the strip base type.
Represents a base line feature of a Profile Intersect tool tool.
Represents an Angle measurement for a Profile Line Tool.
GoProfilePanelGap GoProfilePanel_GapMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Gap measurement object.
Represents a profile X-Line tool.
kBool GoProfileBridgeValue_RegionEnabled(GoProfileBridgeValue tool)
Returns the enabled state of the tool region.
GoProfileGrooveShape GoProfileGroove_Shape(GoProfileGroove tool)
Gets the current groove determination shape.
GoProfilePanelLeftGapPoint GoProfilePanel_LeftGapPoint(GoProfilePanel tool)
Returns a GoProfilePanel Left gap point featuret object.
Represents an X measurement for a Profile Round Corner tool.
Represents a point of maximum error for a Profile Line tool.
k64f GoProfileStrip_TransitionWidthLimitMin(GoProfileStrip tool)
Gets the transition width limit minimum.
GoProfilePanelLeftFlushPoint GoProfilePanel_LeftFlushPoint(GoProfilePanel tool)
Returns a GoProfilePanel left flush point feature object.
kStatus GoProfileStrip_SetMinWidth(GoProfileStrip tool, k64f value)
Sets the minimum width.
GoProfileCircleCenterPoint GoProfileCircle_CenterPoint(GoProfileCircle tool)
Returns a GoProfileCircle center point feature object.
GoProfileRoundCornerPoint GoProfileRoundCorner_EdgePoint(GoProfileRoundCorner tool)
gets the round corner edge point
GoProfileRegion GoProfileXLine_Region(GoProfileXLine tool)
Gets the profile X-Line tool region.
kSize GoProfileTool_SourceOptionCount(GoProfileTool tool)
Gets the data source option list count.
GoProfilePositionX GoProfilePosition_XMeasurement(GoProfilePosition tool)
Returns a GoProfilePosition X measurement object.
Represents a standard deviation measurement for a Profile Line Tool.
Represents a center Z value measurement for a Profile Dimension Tool.
GoProfilePanelGap GoProfilePanel_RightFlushZMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Flush Z measurement object.
GoProfileBridgeValueAngle GoProfileBridgeValue_AngleMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue angle measurement object.
kStatus GoProfileGroove_RemoveMeasurement(GoProfileGroove tool, kSize index)
Removes a measurement from the tool at the given index.
kStatus GoProfileBridgeValue_SetWindowSkip(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window skip percentage.
GoProfileXLineZ GoProfileXLine_ZMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Z measurement object.
GoProfileIntersectAngle GoProfileIntersect_AngleMeasurement(GoProfileIntersect tool)
Returns a GoProfileIntersect Angle measurement object.
Represents a centroid X measurement for a Profile Area Tool.
kBool GoProfileArea_TypeUsed(GoProfileArea tool)
Gets the boolean representing whether the area type is used.
GoProfileLineMaxError GoProfileLine_MaxErrorMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum Error measurement object.
k64f GoProfileBridgeValue_MaxInvalid(GoProfileBridgeValue tool)
Gets the profile X-Line tool max invalid percentage.
kStatus GoProfileLine_EnableRegion(GoProfileLine tool, kBool enable)
Enables or disables the region.
Represents a Maximum X Error measurement for a Profile Line Tool.
kStatus GoProfileRoundCorner_SetEdge(GoProfileRoundCorner tool, GoProfileEdge edge)
Sets the edge.
kStatus GoProfileGroove_SetMinWidth(GoProfileGroove tool, k64f width)
Sets the groove width minimum.
GoProfileBoxZ GoProfileBox_ZMeasurement(GoProfileBox tool)
Returns a GoProfileBox Z measurement object.
kStatus GoProfileTool_SetStream(GoProfileTool tool, GoDataStream stream)
Sets the data stream.
kStatus GoProfileStrip_SetLeftEdge(GoProfileStrip tool, GoProfileStripEdgeType leftEdge)
Sets the left edge.
GoProfileLineMinErrorX GoProfileLine_MinErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Minimum X Error measurement object.
kBool GoProfileArea_RegionEnabled(GoProfileArea tool)
Indicates whether the region is enabled.
GoDataSource GoProfileTool_Source(GoProfileTool tool)
Gets the data source.
Represents an intersect angle measurement for a Profile Intersect Tool.
k64f GoProfileStrip_TransitionWidth(GoProfileStrip tool)
Gets the transition width.
Represents a radius value measurement for a Profile Circle Tool.
Represents an Minimum X Error measurement for a Profile Line Tool.
GoProfilePanelGap GoProfilePanel_RightSurfaceAngleMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Surface Angle measurement object.
Represents an Z measurement for a Profile X-Line tool.
Represents a width measurement for a Profile Bounding Box tool.
GoProfileDimHeight GoProfileDim_HeightMeasurement(GoProfileDim tool)
Returns a GoProfileDim Height measurement object.
GoProfileBoxGlobalY GoProfileBox_GlobalYMeasurement(GoProfileBox tool)
Returns a GoProfileBox global Y measurement object.
k64f GoProfileStrip_TransitionWidthLimitMax(GoProfileStrip tool)
Gets the transition width limit maximum.
kStatus GoProfilePanel_SetMaxGapWidth(GoProfilePanel tool, k64f width)
Sets the maximum gap width.
GoProfileRoundCornerAngle GoProfileRoundCorner_AngleMeasurement(GoProfileRoundCorner tool)
Returns a GoProfileRoundCorner Angle measurement object.
GoProfileBridgeValueStdDev GoProfileBridgeValue_StdDevMeasurement(GoProfileBridgeValue tool)
Returns a GoProfileBridgeValue standard deviation measurement object.
k64f GoProfileXLine_MaxTrackingSpeed(GoProfileXLine tool)
Gets the profile X-Line tool maximum tracking speed.
Represents an offset measurement for a Profile Line Tool.
kStatus GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id)
Sets the X-anchoring source.
GoProfileDimDistance GoProfileDim_DistanceMeasurement(GoProfileDim tool)
Returns a GoProfileDim Distance measurement object.
Represents an intersect Z measurement for a Profile Intersect Tool.
Represents an X measurement for a Profile Position tool.
GoProfileLineMaxErrorX GoProfileLine_MaxErrorXMeasurement(GoProfileLine tool)
Returns a GoProfileLine Maximum X Error measurement object.
Represents an window measurement for a Profile Bridge Value tool.
GoProfileCircleX GoProfileCircle_XMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle X measurement object.
GoProfileCircleZ GoProfileCircle_ZMeasurement(GoProfileCircle tool)
Returns a GoProfileCircle Z measurement object.
kBool GoProfileLine_RegionEnabled(GoProfileLine tool)
Indicates whether the region is enabled.
k64f GoProfilePanel_MaxGapWidth(GoProfilePanel tool)
Gets the maximum gap width.
kSize GoProfileGroove_MeasurementCount(GoProfileGroove tool)
Returns the measurement count for the given tool.
GoProfileDimCenterZ GoProfileDim_CenterZMeasurement(GoProfileDim tool)
Returns a GoProfileDim Center Z measurement object.
Represents a bridge value measurement for a Profile Bridge Value tool.
kStatus GoProfileStrip_EnableTilt(GoProfileStrip tool, kBool enable)
Enables or disables tilt.
GoProfilePanelGap GoProfilePanel_LeftFlushXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Left Flush X measurement object.
Represents a line for a Profile Intersect tool.
Represents a point of minimum error for a Profile Line tool.
kBool GoProfileCircle_RegionEnabled(GoProfileCircle tool)
Indicates whether the region is enabled.
Represents a base profile tool.
kStatus GoProfileArea_SetBaseline(GoProfileArea tool, GoProfileBaseline type)
Sets the profile area type.
kStatus GoProfileStrip_SetSupportWidth(GoProfileStrip tool, k64f value)
Sets the support width.
kSize GoProfileTool_ZAnchorOptionCount(GoProfileTool tool)
Gets the Z-anchoring option list count.
Represents a global X measurement for a Profile Bounding Box tool.
Represents a profile round corner tool.
kStatus GoProfileBridgeValue_SetWindowSize(GoProfileBridgeValue tool, k64f value)
Sets the profile X-Line tool window size percentage.
k64f GoProfileGroove_MinWidth(GoProfileGroove tool)
Gets the groove width minimum value.
Represents an Angle measurement for a Profile Round Corner tool.
Represents a center point of a Profile Dimension tool.
Represents a profile position tool.
GoProfilePanelGap GoProfilePanel_RightGapXMeasurement(GoProfilePanel tool)
Returns a GoProfilePanel Right Gap X measurement object.
Represents a distance value measurement for a Profile Dimension Tool.
GoProfileXLineZ GoProfileXLine_ValidityMeasurement(GoProfileXLine tool)
Returns a GoProfileXLine Validity measurement object.