Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoPartMatching.h
Go to the documentation of this file.
1 /**
2  * @file GoPartMatching.h
3  * @brief Declares the GoPartMatching class.
4  *
5  * @internal
6  * Copyright (C) 2016-2022 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_PART_MATCHING_H
11 #define GO_PART_MATCHING_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoPartMatching
17  * @extends kObject
18  * @note Supported with G2, G3
19  * @ingroup GoSdk-Surface
20  * @brief Represents the part matching parameters of the surface mode configuration.
21  */
22 typedef kObject GoPartMatching;
23 
24 /**
25  * Enables part matching.
26  *
27  * @public @memberof GoPartMatching
28  * @note Supported with G2, G3
29  * @version Introduced in firmware 4.2.4.7
30  * @param matching GoPartMatching object.
31  * @param enable kTRUE to enable, or kFALSE to disable.
32  * @return Operation status.
33  */
35 
36 /**
37  * Gets the current state of part matching.
38  *
39  * @public @memberof GoPartMatching
40  * @note Supported with G2, G3
41  * @version Introduced in firmware 4.2.4.7
42  * @param matching GoPartMatching object.
43  * @return kTRUE if enabled and kFALSE if disabled.
44  */
46 
47 /**
48  * Returns the state of whether or not the user specified part matching value is used.
49  *
50  * @public @memberof GoPartMatching
51  * @note Supported with G2, G3
52  * @version Introduced in firmware 4.2.4.7
53  * @param matching GoPartMatching object.
54  * @return kTRUE if used and kFALSE if not.
55  */
57 
58 /**
59  * Sets the desired part matching algorithm.
60  *
61  * @public @memberof GoPartMatching
62  * @note Supported with G2, G3
63  * @version Introduced in firmware 4.2.4.7
64  * @param matching GoPartMatching object.
65  * @param algorithm The algorithm to use for part matching.
66  * @return Operation status.
67  */
69 
70 /**
71  * Gets the currently selected part matching algorithm.
72  *
73  * @public @memberof GoPartMatching
74  * @note Supported with G2, G3
75  * @version Introduced in firmware 4.2.4.7
76  * @param matching GoPartMatching object.
77  * @return The currently selected part matching algorithm.
78  */
80 
81 /**
82  * Sets the current edge model name.
83  *
84  * @public @memberof GoPartMatching
85  * @note Supported with G2, G3
86  * @version Introduced in firmware 4.2.4.7
87  * @param matching GoPartMatching object.
88  * @param name The desired name to set for the edge model.
89  * @return Operation status.
90  */
91 GoFx(kStatus) GoPartMatching_SetEdgeModelName(GoPartMatching matching, const kChar* name);
92 
93 /**
94  * Gets the name of the currently selected part matching edge model.
95  *
96  * @public @memberof GoPartMatching
97  * @note Supported with G2, G3
98  * @version Introduced in firmware 4.2.4.7
99  * @param matching GoPartMatching object.
100  * @return The name of the current edge matching model.
101  */
102 GoFx(const kChar*) GoPartMatching_EdgeModelName(GoPartMatching matching);
103 
104 /**
105  * Sets the edge matching decision minimum quality value.
106  *
107  * @public @memberof GoPartMatching
108  * @note Supported with G2, G3
109  * @version Introduced in firmware 4.2.4.7
110  * @param matching GoPartMatching object.
111  * @param value The value to set.
112  * @return Operation status.
113  */
115 
116 /**
117  * Gets the minimum decision value for the edge part matching configuration.
118  *
119  * @public @memberof GoPartMatching
120  * @note Supported with G2, G3
121  * @version Introduced in firmware 4.2.4.7
122  * @param matching GoPartMatching object.
123  * @return The minimum decision value.
124  */
126 
127 /**
128  * Sets the ellipse match major decision maximum value.
129  *
130  * @public @memberof GoPartMatching
131  * @note Supported with G2, G3
132  * @version Introduced in firmware 4.2.4.7
133  * @param matching GoPartMatching object.
134  * @param value The value to set.(mm)
135  * @return Operation status.
136  */
138 
139 /**
140  * Gets the maximum major decision value for the ellipse part matching configuration.
141  *
142  * @public @memberof GoPartMatching
143  * @note Supported with G2, G3
144  * @version Introduced in firmware 4.2.4.7
145  * @param matching GoPartMatching object.
146  * @return The maximum major decision value.(mm)
147  */
149 
150 /**
151  * Sets the ellipse match major decision minimum value.
152  *
153  * @public @memberof GoPartMatching
154  * @note Supported with G2, G3
155  * @version Introduced in firmware 4.2.4.7
156  * @param matching GoPartMatching object.
157  * @param value The value to set.(mm)
158  * @return Operation status.
159  */
161 
162 /**
163  * Gets the minimum major decision value for the ellipse part matching configuration.
164  *
165  * @public @memberof GoPartMatching
166  * @note Supported with G2, G3
167  * @version Introduced in firmware 4.2.4.7
168  * @param matching GoPartMatching object.
169  * @return The minimum major decision value.(mm)
170  */
172 
173 /**
174  * Sets the ellipse match minor decision maximum value.
175  *
176  * @public @memberof GoPartMatching
177  * @note Supported with G2, G3
178  * @version Introduced in firmware 4.2.4.7
179  * @param matching GoPartMatching object.
180  * @param value The value to set.(mm)
181  * @return Operation status.
182  */
184 
185 /**
186  * Gets the maximum minor decision value for the ellipse part matching configuration.
187  *
188  * @public @memberof GoPartMatching
189  * @note Supported with G2, G3
190  * @version Introduced in firmware 4.2.4.7
191  * @param matching GoPartMatching object.
192  * @return The maximum minor decision value.(mm)
193  */
195 
196 /**
197  * Sets the ellipse match minor decision minimum value.
198  *
199  * @public @memberof GoPartMatching
200  * @note Supported with G2, G3
201  * @version Introduced in firmware 4.2.4.7
202  * @param matching GoPartMatching object.
203  * @param value The value to set.(mm)
204  * @return Operation status.
205  */
207 
208 /**
209  * Gets the minimum minor decision value for the ellipse part matching configuration.
210  *
211  * @public @memberof GoPartMatching
212  * @note Supported with G2, G3
213  * @version Introduced in firmware 4.2.4.7
214  * @param matching GoPartMatching object.
215  * @return The minimum minor decision value.(mm)
216  */
218 
219 /**
220  * Sets the ellipse match Z angle value.
221  *
222  * @public @memberof GoPartMatching
223  * @note Supported with G2, G3
224  * @version Introduced in firmware 4.2.4.7
225  * @param matching GoPartMatching object.
226  * @param value The value to set. (degrees)
227  * @return Operation status.
228  */
230 
231 /**
232  * Gets the ellipse Z angle value for the ellipse part matching configuration.
233  *
234  * @public @memberof GoPartMatching
235  * @note Supported with G2, G3
236  * @version Introduced in firmware 4.2.4.7
237  * @param matching GoPartMatching object.
238  * @return The Z angle value.(degrees)
239  */
241 
242 /**
243  * Sets the ellipse match decision asymmetry detection type.
244  *
245  * @public @memberof GoPartMatching
246  * @note Supported with G2, G3
247  * @version Introduced in firmware 4.4.4.14
248  * @param matching GoPartMatching object.
249  * @param value The value to set.
250  * @return Operation status.
251  */
253 
254 /**
255  * Gets the asymmetry detection type for the ellipse part matching configuration.
256  *
257  * @public @memberof GoPartMatching
258  * @note Supported with G2, G3
259  * @version Introduced in firmware 4.4.4.14
260  * @param matching GoPartMatching object.
261  * @return The asymmetry detection type.
262  */
264 
265 /**
266  * Sets the bounding box match decision maximum width value.
267  *
268  * @public @memberof GoPartMatching
269  * @note Supported with G2, G3
270  * @version Introduced in firmware 4.2.4.7
271  * @param matching GoPartMatching object.
272  * @param value The value to set.(mm)
273  * @return Operation status.
274  */
276 
277 /**
278  * Gets the maximum width decision value for the bounding box part matching configuration.
279  *
280  * @public @memberof GoPartMatching
281  * @note Supported with G2, G3
282  * @version Introduced in firmware 4.2.4.7
283  * @param matching GoPartMatching object.
284  * @return The maximum width decision value.(mm)
285  */
287 
288 /**
289  * Sets the bounding box match decision minimum width value.
290  *
291  * @public @memberof GoPartMatching
292  * @note Supported with G2, G3
293  * @version Introduced in firmware 4.2.4.7
294  * @param matching GoPartMatching object.
295  * @param value The value to set.(mm)
296  * @return Operation status.
297  */
299 
300 /**
301  * Gets the minimum width decision value for the bounding box part matching configuration.
302  *
303  * @public @memberof GoPartMatching
304  * @note Supported with G2, G3
305  * @version Introduced in firmware 4.2.4.7
306  * @param matching GoPartMatching object.
307  * @return The minimum width decision value.(mm)
308  */
310 
311 /**
312  * Sets the bounding box match decision maximum length value.
313  *
314  * @public @memberof GoPartMatching
315  * @note Supported with G2, G3
316  * @version Introduced in firmware 4.2.4.7
317  * @param matching GoPartMatching object.
318  * @param value The value to set.(mm)
319  * @return Operation status.
320  */
322 
323 /**
324  * Gets the maximum length decision value for the bounding box part matching configuration.
325  *
326  * @public @memberof GoPartMatching
327  * @note Supported with G2, G3
328  * @version Introduced in firmware 4.2.4.7
329  * @param matching GoPartMatching object.
330  * @return The maximum length decision value.(mm)
331  */
333 
334 /**
335  * Sets the bounding box match decision minimum length value.
336  *
337  * @public @memberof GoPartMatching
338  * @note Supported with G2, G3
339  * @version Introduced in firmware 4.2.4.7
340  * @param matching GoPartMatching object.
341  * @param value The value to set.(mm)
342  * @return Operation status.
343  */
345 
346 /**
347  * Gets the minimum length decision value for the bounding box part matching configuration.
348  *
349  * @public @memberof GoPartMatching
350  * @note Supported with G2, G3
351  * @version Introduced in firmware 4.2.4.7
352  * @param matching GoPartMatching object.
353  * @return The minimum length decision value.(mm)
354  */
356 
357 /**
358  * Sets the bounding box match decision Z angle value.
359  *
360  * @public @memberof GoPartMatching
361  * @note Supported with G2, G3
362  * @version Introduced in firmware 4.2.4.7
363  * @param matching GoPartMatching object.
364  * @param value The value to set.(mm)
365  * @return Operation status.
366  */
368 
369 /**
370  * Gets the Z angle value for the bounding box part matching configuration.
371  *
372  * @public @memberof GoPartMatching
373  * @note Supported with G2, G3
374  * @version Introduced in firmware 4.2.4.7
375  * @param matching GoPartMatching object.
376  * @return The Z angle value.(degrees)
377  */
379 
380 /**
381  * Sets the bounding box match decision asymmetry detection type.
382  *
383  * @public @memberof GoPartMatching
384  * @note Supported with G2, G3
385  * @version Introduced in firmware 4.4.4.14
386  * @param matching GoPartMatching object.
387  * @param value The value to set.(degrees)
388  * @return Operation status.
389  */
391 
392 /**
393  * Gets the asymmetry detection type for the bounding box part matching configuration.
394  *
395  * @public @memberof GoPartMatching
396  * @note Supported with G2, G3
397  * @version Introduced in firmware 4.4.4.14
398  * @param matching GoPartMatching object.
399  * @return The asymmetry detection type.
400  */
402 
403 #include <GoSdk/GoPartMatching.x.h>
404 
405 #endif
kStatus GoPartMatching_SetBoundingBoxWidthMin(GoPartMatching matching, k64f value)
Sets the bounding box match decision minimum width value.
kStatus GoPartMatching_EnablePartMatching(GoPartMatching matching, kBool enable)
Enables part matching.
k64f GoPartMatching_EllipseMajorMin(GoPartMatching matching)
Gets the minimum major decision value for the ellipse part matching configuration.
GoPartMatchAlgorithm GoParthMatching_Algorithm(GoPartMatching matching)
Gets the currently selected part matching algorithm.
GoBoxAsymmetryType GoPartMatching_BoundingBoxAsymmetryDetectionType(GoPartMatching matching)
Gets the asymmetry detection type for the bounding box part matching configuration.
Represents the bounding Ellipse part matching asymmetry detection type.
kStatus GoPartMatching_SetBoundingBoxLengthMin(GoPartMatching matching, k64f value)
Sets the bounding box match decision minimum length value.
kStatus GoPartMatching_SetEdgeModelName(GoPartMatching matching, const kChar *name)
Sets the current edge model name.
k64f GoPartMatching_EllipseMinorMax(GoPartMatching matching)
Gets the maximum minor decision value for the ellipse part matching configuration.
kStatus GoPartMatching_SetBoundingBoxLengthMax(GoPartMatching matching, k64f value)
Sets the bounding box match decision maximum length value.
k64f GoPartMatching_BoundingBoxWidthMin(GoPartMatching matching)
Gets the minimum width decision value for the bounding box part matching configuration.
Essential SDK declarations.
kStatus GoPartMatching_SetEllipseMinorMin(GoPartMatching matching, k64f value)
Sets the ellipse match minor decision minimum value.
kStatus GoPartMatching_SetEllipseMinorMax(GoPartMatching matching, k64f value)
Sets the ellipse match minor decision maximum value.
k64f GoPartMatching_EllipseMajorMax(GoPartMatching matching)
Gets the maximum major decision value for the ellipse part matching configuration.
kStatus GoPartMatching_SetEdgeQualityDecisionMin(GoPartMatching matching, k64f value)
Sets the edge matching decision minimum quality value.
k64f GoPartMatching_EdgeQualityDecisionMin(GoPartMatching matching)
Gets the minimum decision value for the edge part matching configuration.
kStatus GoPartMatching_SetBoundingBoxWidthMax(GoPartMatching matching, k64f value)
Sets the bounding box match decision maximum width value.
k64f GoPartMatching_BoundingBoxWidthMax(GoPartMatching matching)
Gets the maximum width decision value for the bounding box part matching configuration.
const kChar * GoPartMatching_EdgeModelName(GoPartMatching matching)
Gets the name of the currently selected part matching edge model.
k64f GoPartMatching_EllipseZAngle(GoPartMatching matching)
Gets the ellipse Z angle value for the ellipse part matching configuration.
kStatus GoPartMatching_SetBoundingBoxZAngle(GoPartMatching matching, k64f value)
Sets the bounding box match decision Z angle value.
kStatus GoPartMatching_SetEllipseAsymmetryDetectionType(GoPartMatching matching, GoEllipseAsymmetryType value)
Sets the ellipse match decision asymmetry detection type.
kBool GoPartMatching_EnablePartMatchingUsed(GoPartMatching matching)
Returns the state of whether or not the user specified part matching value is used.
kStatus GoPartMatching_SetEllipseMajorMax(GoPartMatching matching, k64f value)
Sets the ellipse match major decision maximum value.
kStatus GoPartMatching_SetAlgorithm(GoPartMatching matching, GoPartMatchAlgorithm algorithm)
Sets the desired part matching algorithm.
k64f GoPartMatching_BoundingBoxLengthMin(GoPartMatching matching)
Gets the minimum length decision value for the bounding box part matching configuration.
GoEllipseAsymmetryType GoPartMatching_EllipseAsymmetryDetectionType(GoPartMatching matching)
Gets the asymmetry detection type for the ellipse part matching configuration.
k64f GoPartMatching_BoundingBoxLengthMax(GoPartMatching matching)
Gets the maximum length decision value for the bounding box part matching configuration.
kStatus GoPartMatching_SetEllipseMajorMin(GoPartMatching matching, k64f value)
Sets the ellipse match major decision minimum value.
Represents the part matching parameters of the surface mode configuration.
kStatus GoPartMatching_SetBoundingBoxAsymmetryDetectionType(GoPartMatching matching, GoBoxAsymmetryType value)
Sets the bounding box match decision asymmetry detection type.
Represents the bounding box part matching asymmetry detection type.
k64f GoPartMatching_EllipseMinorMin(GoPartMatching matching)
Gets the minimum minor decision value for the ellipse part matching configuration.
kBool GoPartMatching_PartMatchingEnabled(GoPartMatching matching)
Gets the current state of part matching.
kStatus GoPartMatching_SetEllipseZAngle(GoPartMatching matching, k64f value)
Sets the ellipse match Z angle value.
k64f GoPartMatching_BoundingBoxZAngle(GoPartMatching matching)
Gets the Z angle value for the bounding box part matching configuration.
Represents a part matching algorithm.