Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoPartDetection.h
1 /// @cond (Gocator_2x00 || Gocator_3x00)
2
3 /**
4 * @file GoPartDetection.h
5 * @brief Declares the GoPartDetection class.
6 *
7 * @internal
8 * Copyright (C) 2014 by LMI Technologies Inc.
9 * Licensed under the MIT License.
10 * Redistributed files must retain the above copyright notice.
11 */
12 #ifndef GO_PART_DETECTION_H
13 #define GO_PART_DETECTION_H
14
15 #include <GoSdk/GoSdkDef.h>
16 kBeginHeader()
17
18 /**
19 * @class GoPartDetection
20 * @extends kObject
21 * @ingroup GoSdk-Surface
22 * @brief Represents the part detection parameters of the surface mode configuration.
23 */
24 typedef kObject GoPartDetection;
25
26 /**
27 * Enables part detection.
28 *
29 * @public @memberof GoPartDetection
30 * @param detection GoPartDetection object.
31 * @param enable kTRUE to enable, or kFALSE to disable.
32 * @return Operation status.
33 */
34 GoFx(kStatus) GoPartDetection_EnablePartDetection(GoPartDetection detection, kBool enable);
35
36 /**
37 * Gets the current state of part detection.
38 *
39 * @public @memberof GoPartDetection
40 * @param detection GoPartDetection object.
41 * @return kTRUE if enabled and kFALSE if disabled.
42 */
43 GoFx(kBool) GoPartDetection_PartDetectionEnabled(GoPartDetection detection);
44
45 /**
46 * Returns the state of whether or not the user specified part detection value is used.
47 *
48 * @public @memberof GoPartDetection
49 * @param detection GoPartDetection object.
50 * @return kTRUE if used and kFALSE if not.
51 */
52 GoFx(kBool) GoPartDetection_EnablePartDetectionUsed(GoPartDetection detection);
53
54 /**
55 * Gets the current part detection system state.
56 *
57 * @public @memberof GoPartDetection
58 * @param detection GoPartDetection object.
59 * @return kTRUE if enabled and kFALSE if disabled.
60 */
61 GoFx(kBool) GoPartDetection_PartDetectionEnabledSystemValue(GoPartDetection detection);
62
63
64 /**
65 * Gets the part detection minimum threshold value.
66 *
67 * @public @memberof GoPartDetection
68 * @param detection GoPartDetection object.
69 * @return Part detection minimum threshold value.
70 */
71 GoFx(k64f) GoPartDetection_ThresholdLimitMin(GoPartDetection detection);
72
73 /**
74 * Gets the part detection maximum threshold value.
75 *
76 * @public @memberof GoPartDetection
77 * @param detection GoPartDetection object.
78 * @return Part detection maximum threshold value.
79 */
80 GoFx(k64f) GoPartDetection_ThresholdLimitMax(GoPartDetection detection);
81
82 /**
83 * Sets the part detection height threshold.
84 *
85 * @public @memberof GoPartDetection
86 * @param detection GoPartDetection object.
87 * @param height The part detection height threshold value to set.
88 * @return Operation status.
89 */
90 GoFx(kStatus) GoPartDetection_SetThreshold(GoPartDetection detection, k64f height);
91
92 /**
93 * Gets the part detection threshold value.
94 *
95 * @public @memberof GoPartDetection
96 * @param detection GoPartDetection object.
97 * @return Part detection threshold value.
98 */
99 GoFx(k64f) GoPartDetection_Threshold(GoPartDetection detection);
100
101 /**
102 * Sets the part detection height threshold direction.
103 *
104 * @public @memberof GoPartDetection
105 * @param detection GoPartDetection object.
106 * @param direction The part detection height threshold direction value to set.
107 * @return Operation status.
108 */
109 GoFx(kStatus) GoPartDetection_SetThresholdDirection(GoPartDetection detection, GoPartHeightThresholdDirection direction);
110
111 /**
112 * Gets the part detection threshold direction.
113 *
114 * @public @memberof GoPartDetection
115 * @param detection GoPartDetection object.
116 * @return Part detection threshold direction.
117 */
118 GoFx(GoPartHeightThresholdDirection) GoPartDetection_ThresholdDirection(GoPartDetection detection);
119
120 /**
121 * Sets the part detection frame of reference.
122 *
123 * @public @memberof GoPartDetection
124 * @param detection GoPartDetection object.
125 * @param frameOfRef The part detection frame of reference value to set.
126 * @return Operation status.
127 */
128 GoFx(kStatus) GoPartDetection_SetFrameOfReference(GoPartDetection detection, GoPartFrameOfReference frameOfRef);
129
130 /**
131 * Gets the part detection frame of reference.
132 *
133 * @public @memberof GoPartDetection
134 * @param detection GoPartDetection object.
135 * @return Part detection frame of reference.
136 */
137 GoFx(GoPartFrameOfReference) GoPartDetection_FrameOfReference(GoPartDetection detection);
138
139 /**
140 * Gets the part detection gap width minimum limit value.
141 *
142 * @public @memberof GoPartDetection
143 * @param detection GoPartDetection object.
144 * @return Part detection gap width minimum value.
145 */
146 GoFx(k64f) GoPartDetection_GapWidthLimitMin(GoPartDetection detection);
147
148 /**
149 * Gets the part detection gap width maximum limit value.
150 *
151 * @public @memberof GoPartDetection
152 * @param detection GoPartDetection object.
153 * @return Part detection gap width maximum value.
154 */
155 GoFx(k64f) GoPartDetection_GapWidthLimitMax(GoPartDetection detection);
156
157 /**
158 * Sets the part detection gap width.
159 *
160 * @public @memberof GoPartDetection
161 * @param detection GoPartDetection object.
162 * @param gap The part detection gap width value to set.
163 * @return Operation status.
164 */
165 GoFx(kStatus) GoPartDetection_SetGapWidth(GoPartDetection detection, k64f gap);
166
167 /**
168 * Gets the part detection gap width value.
169 *
170 * @public @memberof GoPartDetection
171 * @param detection GoPartDetection object.
172 * @return Part detection gap width value.
173 */
174 GoFx(k64f) GoPartDetection_GapWidth(GoPartDetection detection);
175
176 /**
177 * Gets the part detection gap width minimum limit value.
178 *
179 * @public @memberof GoPartDetection
180 * @param detection GoPartDetection object.
181 * @return Part detection gap width minimum value.
182 */
183 GoFx(k64f) GoPartDetection_GapLengthLimitMin(GoPartDetection detection);
184
185 /**
186 * Gets the part detection gap length maximum limit value.
187 *
188 * @public @memberof GoPartDetection
189 * @param detection GoPartDetection object.
190 * @return Part detection gap length maximum value.
191 */
192 GoFx(k64f) GoPartDetection_GapLengthLimitMax(GoPartDetection detection);
193
194 /**
195 * Sets the part detection gap length.
196 *
197 * @public @memberof GoPartDetection
198 * @param detection GoPartDetection object.
199 * @param gap The part detection gap length value to set.
200 * @return Operation status.
201 */
202 GoFx(kStatus) GoPartDetection_SetGapLength(GoPartDetection detection, k64f gap);
203
204 /**
205 * Gets the part detection gap length value.
206 *
207 * @public @memberof GoPartDetection
208 * @param detection GoPartDetection object.
209 * @return Part detection gap length value.
210 */
211 GoFx(k64f) GoPartDetection_GapLength(GoPartDetection detection);
212
213 /**
214 * Gets the part detection padding width minimum limit value.
215 *
216 * @public @memberof GoPartDetection
217 * @param detection GoPartDetection object.
218 * @return Part detection padding width minimum value.
219 */
220 GoFx(k64f) GoPartDetection_PaddingWidthLimitMin(GoPartDetection detection);
221
222 /**
223 * Gets the part detection padding width maximum limit value.
224 *
225 * @public @memberof GoPartDetection
226 * @param detection GoPartDetection object.
227 * @return Part detection padding width maximum value.
228 */
229 GoFx(k64f) GoPartDetection_PaddingWidthLimitMax(GoPartDetection detection);
230
231 /**
232 * Sets the part detection padding width.
233 *
234 * @public @memberof GoPartDetection
235 * @param detection GoPartDetection object.
236 * @param padding The part detection padding width value to set.
237 * @return Operation status.
238 */
239 GoFx(kStatus) GoPartDetection_SetPaddingWidth(GoPartDetection detection, k64f padding);
240
241 /**
242 * Gets the part detection padding width value.
243 *
244 * @public @memberof GoPartDetection
245 * @param detection GoPartDetection object.
246 * @return Part detection padding width value.
247 */
248 GoFx(k64f) GoPartDetection_PaddingWidth(GoPartDetection detection);
249
250 /**
251 * Gets the part detection padding length minimum limit value.
252 *
253 * @public @memberof GoPartDetection
254 * @param detection GoPartDetection object.
255 * @return Part detection padding length minimum value.
256 */
257 GoFx(k64f) GoPartDetection_PaddingLengthLimitMin(GoPartDetection detection);
258
259 /**
260 * Gets the part detection padding length maximum limit value.
261 *
262 * @public @memberof GoPartDetection
263 * @param detection GoPartDetection object.
264 * @return Part detection padding length maximum value.
265 */
266 GoFx(k64f) GoPartDetection_PaddingLengthLimitMax(GoPartDetection detection);
267
268 /**
269 * Sets the part detection padding length.
270 *
271 * @public @memberof GoPartDetection
272 * @param detection GoPartDetection object.
273 * @param padding The part detection padding length value to set.
274 * @return Operation status.
275 */
276 GoFx(kStatus) GoPartDetection_SetPaddingLength(GoPartDetection detection, k64f padding);
277
278 /**
279 * Gets the part detection padding length value.
280 *
281 * @public @memberof GoPartDetection
282 * @param detection GoPartDetection object.
283 * @return Part detection padding length value.
284 */
285 GoFx(k64f) GoPartDetection_PaddingLength(GoPartDetection detection);
286
287 /**
288 * Gets the part detection maximum length range minimum value.
289 *
290 * @public @memberof GoPartDetection
291 * @param detection GoPartDetection object.
292 * @return Part detection maximum length range minimum value.
293 */
294 GoFx(k64f) GoPartDetection_MaxLengthLimitMin(GoPartDetection detection);
295
296 /**
297 * Gets the part detection maximum length range maximum value.
298 *
299 * @public @memberof GoPartDetection
300 * @param detection GoPartDetection object.
301 * @return Part detection maximum length range maximum value.
302 */
303 GoFx(k64f) GoPartDetection_MaxLengthLimitMax(GoPartDetection detection);
304
305 /**
306 * Sets the part detection maximum length.
307 *
308 * @public @memberof GoPartDetection
309 * @param detection GoPartDetection object.
310 * @param length The part detection maximum length value to set.
311 * @return Operation status.
312 */
313 GoFx(kStatus) GoPartDetection_SetMaxLength(GoPartDetection detection, k64f length);
314
315 /**
316 * Gets the part detection max length value.
317 *
318 * @public @memberof GoPartDetection
319 * @param detection GoPartDetection object.
320 * @return Part detection max length value.
321 */
322 GoFx(k64f) GoPartDetection_MaxLength(GoPartDetection detection);
323
324 /**
325 * Sets the part detection minimum area.
326 *
327 * @public @memberof GoPartDetection
328 * @param detection GoPartDetection object.
329 * @param area The part detection minimum area value to set.
330 * @return Operation status.
331 */
332 GoFx(kStatus) GoPartDetection_SetMinArea(GoPartDetection detection, k64f area);
333
334 /**
335 * Gets the part detection minimum area value.
336 *
337 * @public @memberof GoPartDetection
338 * @param detection GoPartDetection object.
339 * @return Part detection minimum area value.
340 */
341 GoFx(k64f) GoPartDetection_MinArea(GoPartDetection detection);
342
343 /**
344 * Gets the part detection minimum area range maximum value.
345 *
346 * @public @memberof GoPartDetection
347 * @param detection GoPartDetection object.
348 * @return Part detection minimum area range maximum value.
349 */
350 GoFx(k64f) GoPartDetection_MinAreaLimitMin(GoPartDetection detection);
351
352 /**
353 * Gets the part detection maximum area range maximum value.
354 *
355 * @public @memberof GoPartDetection
356 * @param detection GoPartDetection object.
357 * @return Part detection maximum area range maximum value.
358 */
359 GoFx(k64f) GoPartDetection_MinAreaLimitMax(GoPartDetection detection);
360
361
362 kEndHeader()
363 #include <GoSdk/GoPartDetection.x.h>
364
365 #endif
366
367 /// @endcond
GoSdkDef.h
Essential SDK declarations.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.