GoWebScan API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
GoWebScanSettings.h
Go to the documentation of this file.
1 /**
2 * @file GoWebScanSettings.h
3 * @brief Declares a GoWebScanProcess object.
4 *
5 * @internal
6 * Copyright (C) 2017-2018 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 
11 #ifndef GO_WEB_SCAN_SETTINGS_H
12 #define GO_WEB_SCAN_SETTINGS_H
13 
16 #include <kApi/Data/kXml.h>
17 #include <kApi/Data/kArrayList.h>
18 #include <kApi/Data/kString.h>
19 
20 kBeginHeader()
21 
22 /**
23 * @class GoWebScanSettings
24 * @extends kObject
25 * @ingroup GoWebScanSdk-Config
26 * @brief Represents a container for user-configurable settings of the system. The class
27 * reads and writes the settings from/to an XML. These settings describe the
28 * configuration and orientation of the system, processing parameters, and desired
29 * outputs. The format of the XML is similar to the chroma+scan 3x00 station settings
30 * but is not directly equivalent as additional parameters have been added. However,
31 * for any fields that exist in both formats, the chroma+scan 3x00 values can be reused.
32 * The settings are divided into system-level settings (GoWebScanSettings),
33 * group settings (GoWebScanSettingsGroup), and sensor settings
34 * (GoWebScanSettingsSensor).
35 * @see GoWebScanSettingsGroup, GoWebScanSettingsSensor
36 */
38 
39 /**
40 * @class GoWebScanSettingsGroup
41 * @extends kObject
42 * @ingroup GoWebScanSdk-Config
43 * @brief Represents a container for user-configurable settings of a group within the
44 * system. Groups represent planes (top or bottom).
45 */
47 
48 /**
49 * @class GoWebScanSettingsSensor
50 * @extends kObject
51 * @ingroup GoWebScanSdk-Config
52 * @brief Represents a container for user-configurable settings of a sensor within the
53 * system. For systems with vision, a GoWebScanSettingsSensor object represents
54 * a pair of vision and profile sensors (sensor mounted together).
55 */
57 
58 /*
59 * GoWebScanSettings
60 */
61 
62 /**
63  * Constructs a GoWebScanSettings object.
64  *
65  * @public @memberof GoWebScanSettings
66  * @param settings Receives the constructed GoWebScanSettings object.
67  * @param allocator Memory allocator (or kNULL for default).
68  * @return Operation status.
69  */
70 GoWebScanFx(kStatus) GoWebScanSettings_Construct(GoWebScanSettings* settings, kAlloc allocator);
71 
72 /**
73  * Loads the settings XML from a specified path and constructs and initializes a
74  * GoWebScanSettings object with the values read from the XML.
75  *
76  * @public @memberof GoWebScanSettings
77  * @param settings Receives the loaded GoWebScanSettings object.
78  * @param fileName Path of the settings file.
79  * @param alloc Memory allocator (or kNULL for default).
80  * @return Operation status.
81  */
82 GoWebScanFx(kStatus) GoWebScanSettings_Load(GoWebScanSettings* settings, const kChar* fileName, kAlloc alloc);
83 
84 /**
85  * Stores the settings XML to a specified path.
86  *
87  * @public @memberof GoWebScanSettings
88  * @param settings GoWebScanSettings object.
89  * @param fileName Path of the settings file.
90  * @return Operation status.
91  */
92 GoWebScanFx(kStatus) GoWebScanSettings_Store(GoWebScanSettings settings, const kChar* fileName);
93 
94 /**
95  * Enables vision data in the system. If enabled, and if vision sensors are connected, the
96  * system will output vision system messages if a section is defined.
97  *
98  * @public @memberof GoWebScanSettings
99  * @param settings GoWebScanSettings object.
100  * @param enable Boolean to enable vision.
101  * @return Operation status.
102  */
103 GoWebScanFx(kStatus) GoWebScanSettings_EnableVision(GoWebScanSettings settings, kBool enable);
104 
105 /**
106  * Gets the flag for whether vision data is enabled. Refer to GoWebScanSettings_EnableVision().
107  *
108  * @public @memberof GoWebScanSettings
109  * @param settings GoWebScanSettings object.
110  * @return Boolean for whether vision is enabled.
111  */
112 GoWebScanFx(kBool) GoWebScanSettings_VisionEnabled(GoWebScanSettings settings);
113 
114 /**
115  * Enables tracheid data in the system. If enabled, and if tracheid-capable sensors are
116  * connected, the system will output tracheid system messages if a section is defined.
117  *
118  * @public @memberof GoWebScanSettings
119  * @param settings GoWebScanSettings object.
120  * @param enable Boolean to enable tracheid.
121  * @return Operation status.
122  */
123 GoWebScanFx(kStatus) GoWebScanSettings_EnableTracheid(GoWebScanSettings settings, kBool enable);
124 
125 /**
126 * Gets the flag for whether tracheid data is enabled.
127 *
128 * @public @memberof GoWebScanSettings
129 * @param settings GoWebScanSettings object.
130 * @return Boolean for whether tracheid is enabled.
131 */
132 GoWebScanFx(kBool) GoWebScanSettings_TracheidEnabled(GoWebScanSettings settings);
133 
134 /**
135  * Sets the thread count for processing tasks concurrently. This field is optional; if not set,
136  * the thread count will be maximized to the number of CPU cores by default. Note that system
137  * calibration processing is not concurrent.
138  *
139  * @public @memberof GoWebScanSettings
140  * @param settings GoWebScanSettings object.
141  * @param value Number of threads.
142  * @return Operation status.
143  */
144 GoWebScanFx(kStatus) GoWebScanSettings_SetConcurrency(GoWebScanSettings settings, k32s value);
145 
146 /**
147  * Gets the thread count for processing tasks concurrently.
148  *
149  * @public @memberof GoWebScanSettings
150  * @param settings GoWebScanSettings object.
151  * @return Number of threads.
152  */
153 GoWebScanFx(k32s) GoWebScanSettings_Concurrency(GoWebScanSettings settings);
154 
155 /**
156  * Sets the encoder resolution in mils/tick. Represents the distance (mils) per encoder pulse.
157  * This value will be positive if the encoder count increases when the board travels in the
158  * forward direction. 4x quadrature decoding is assumed.
159  *
160  * @public @memberof GoWebScanSettings
161  * @param settings GoWebScanSettings object.
162  * @param value Encoder resolution (mils/tick).
163  * @return Operation status.
164  */
165 GoWebScanFx(kStatus) GoWebScanSettings_SetEncoderResolution(GoWebScanSettings settings, k64f value);
166 
167 /**
168  * Gets the encoder resolution in mils/tick. Refer to GoWebScanSettings_SetEncoderResolution().
169  *
170  * @public @memberof GoWebScanSettings
171  * @param settings GoWebScanSettings object.
172  * @return Encoder resolution (mils/tick).
173  */
174 GoWebScanFx(k64f) GoWebScanSettings_EncoderResolution(GoWebScanSettings settings);
175 
176 /**
177  * Enables simulating forward motion by overriding encoder values in data messages with
178  * simulated values. The simulated speed is set by GoWebScanSettings_SetSimulatedSpeed.
179  *
180  * @public @memberof GoWebScanSettings
181  * @param settings GoWebScanSettings object.
182  * @param value Enables an internal encoder simulator.
183  * @return Operation status.
184  */
185 GoWebScanFx(kStatus) GoWebScanSettings_SetEncoderSimulated(GoWebScanSettings settings, kBool value);
186 
187 /**
188  * Gets the flag for whether the encoder simulator is enabled. Refer to GoWebScanSettings_SetEncoderSimulated().
189  *
190  * @public @memberof GoWebScanSettings
191  * @param settings GoWebScanSettings object.
192  * @return Boolean for whether the encoder simulator is enabled.
193  */
194 GoWebScanFx(kBool) GoWebScanSettings_EncoderSimulated(GoWebScanSettings settings);
195 
196 /**
197  * Sets the simulated encoder speed. This is an optional field that can be used to simulate
198  * forward motion (mils/second). When this property is present in the settings file, GoWebScan
199  * will override the encoder values in data messages with simulated values that are based on
200  * time.
201  *
202  * @public @memberof GoWebScanSettings
203  * @param settings GoWebScanSettings object.
204  * @param value Simulated encoder speed (mils/second).
205  * @return Operation status.
206  */
207 GoWebScanFx(kStatus) GoWebScanSettings_SetSimulatedSpeed(GoWebScanSettings settings, k64f value);
208 
209 /**
210 * Gets the simulated encoder speed. Refer to GoWebScanSettings_SetSimulatedSpeed().
211 *
212 * @public @memberof GoWebScanSettings
213 * @param settings GoWebScanSettings object.
214 * @return Simulated encoder speed (mils/second).
215 */
216 GoWebScanFx(k64f) GoWebScanSettings_SimulatedSpeed(GoWebScanSettings settings);
217 
218 /**
219  * Sets the travel orientation which specifies the direction of conveyor movement: Moving Toward
220  * (1) or Moving Away (0). Moving Toward implies that objects on the conveyor are moving toward
221  * the observer when the system is viewed from the front.
222  *
223  * @public @memberof GoWebScanSettings
224  * @param settings GoWebScanSettings object.
225  * @param value Travel orientation.
226  * @return Operation status.
227  */
228 GoWebScanFx(kStatus) GoWebScanSettings_SetTravelOrientation(GoWebScanSettings settings, k32s value);
229 
230 /**
231  * Gets the travel orientation which specifies the direction of conveyor movement: Moving Toward
232  * (1) or Moving Away (0). Moving Toward implies that objects on the conveyor are moving toward
233  * the observer when the system is viewed from the front.
234  *
235  * @public @memberof GoWebScanSettings
236  * @param settings GoWebScanSettings object.
237  * @return Travel orientation.
238  */
239 GoWebScanFx(k32s) GoWebScanSettings_TravelOrientation(GoWebScanSettings settings);
240 
241 /**
242  * Sets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). The
243  * sensor logo and labels are visible when sensors are facing toward.
244  *
245  * @public @memberof GoWebScanSettings
246  * @param settings GoWebScanSettings object.
247  * @param plane System plane (top or bottom).
248  * @param value Sensor Y orientation.
249  * @return Operation status.
250  */
251 GoWebScanFx(kStatus) GoWebScanSettings_SetSensorYOrientation(GoWebScanSettings settings, GoWebScanSystemPlane plane, k32s value);
252 
253 /**
254  * Gets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0). The
255  * sensor logo and labels are visible when sensors are facing toward.
256  *
257  * @public @memberof GoWebScanSettings
258  * @param settings GoWebScanSettings object.
259  * @param plane System plane (top or bottom).
260  * @return Sensor Y orientation.
261  */
262 GoWebScanFx(k32s) GoWebScanSettings_SensorYOrientation(GoWebScanSettings settings, k32s plane);
263 
264 /**
265  * Sets the sensor X orientation which represents whether the X-axis (length) increasing from
266  * left-to-right (1) or right-to-left (0). In a left-to-right system (as viewed from the front),
267  * the zero reference is on the left and sensor indices increase left-to-right. In a right-to-
268  * left system, the zero reference is on the right and sensor indices increase right-to-left.
269  *
270  * @public @memberof GoWebScanSettings
271  * @param settings GoWebScanSettings object.
272  * @param value Sensor X orientation.
273  * @return Operation status.
274  */
275 GoWebScanFx(kStatus) GoWebScanSettings_SetXOrientation(GoWebScanSettings settings, k32s value);
276 
277 /**
278  * Gets the sensor X orientation. Refer to GoWebScanSettings_SetXOrientation().
279  *
280  * @public @memberof GoWebScanSettings
281  * @param settings GoWebScanSettings object.
282  * @return Sensor X orientation.
283  * @see GoWebScanSettings_SetXOrientation
284  */
285 GoWebScanFx(k32s) GoWebScanSettings_XOrientation(GoWebScanSettings settings);
286 
287 /**
288  * Sets whether GoWebScan should use the per-sensor X-center values provided in the settings
289  * file, or calculate them from sensor indices (e.g. 0:12000, 1:36000, 2:60000, ...).
290  *
291  * @public @memberof GoWebScanSettings
292  * @param settings GoWebScanSettings object.
293  * @param value Boolean to use X-centers.
294  * @return Operation status.
295  */
296 GoWebScanFx(kStatus) GoWebScanSettings_SetUseXCenters(GoWebScanSettings settings, kBool value);
297 
298 /**
299  * Gets the flag for whether GoWebScan uses user-defined X-centers.
300  *
301  * @public @memberof GoWebScanSettings
302  * @param settings GoWebScanSettings object.
303  * @return Boolean to use X-centers.
304  */
305 GoWebScanFx(kBool) GoWebScanSettings_UseXCenters(GoWebScanSettings settings);
306 
307 /**
308  * Sets the frame rate to configure profile sensors to, in Hz. Note that the vision frame
309  * rate will be calculated from the profile frame rate to ensure no gaps in vision coverage
310  * occur and that the vision sensors do not interfere with profile sensors.
311  *
312  * @public @memberof GoWebScanSettings
313  * @param settings GoWebScanSettings object.
314  * @param value Frame rate (Hz).
315  * @return Operation status.
316  */
317 GoWebScanFx(kStatus) GoWebScanSettings_SetProfileFrameRate(GoWebScanSettings settings, k32u value);
318 
319 /**
320  * Gets the profile frame rate in Hz.
321  *
322  * @public @memberof GoWebScanSettings
323  * @param settings GoWebScanSettings object.
324  * @return Frame rate (Hz).
325  */
326 GoWebScanFx(k32u) GoWebScanSettings_ProfileFrameRate(GoWebScanSettings settings);
327 
328 /**
329  * Sets the profile exposure in microseconds.
330  *
331  * @public @memberof GoWebScanSettings
332  * @param settings GoWebScanSettings object.
333  * @param value Profile exposure (microseconds).
334  * @return Operation status.
335  */
336 GoWebScanFx(kStatus) GoWebScanSettings_SetProfileExposure(GoWebScanSettings settings, k32u value);
337 
338 /**
339  * Gets the profile exposure in microseconds.
340  *
341  * @public @memberof GoWebScanSettings
342  * @param settings GoWebScanSettings object.
343  * @return Profile exposure (microseconds).
344  */
345 GoWebScanFx(k32u) GoWebScanSettings_ProfileExposure(GoWebScanSettings settings);
346 
347 /**
348 * Sets the vision exposure in microseconds.
349 *
350 * @public @memberof GoWebScanSettings
351 * @param settings GoWebScanSettings object.
352 * @param value Vision exposure (microseconds).
353 * @return Operation status.
354 */
355 GoWebScanFx(kStatus) GoWebScanSettings_SetVisionExposure(GoWebScanSettings settings, k32u value);
356 
357 /**
358 * Gets the vision exposure in microseconds.
359 *
360 * @public @memberof GoWebScanSettings
361 * @param settings GoWebScanSettings object.
362 * @return Vision exposure (microseconds).
363 */
364 GoWebScanFx(k32u) GoWebScanSettings_VisionExposure(GoWebScanSettings settings);
365 
366 /**
367 * Sets the tracheid exposure in microseconds.
368 *
369 * @public @memberof GoWebScanSettings
370 * @param settings GoWebScanSettings object.
371 * @param value Tracheid exposure (microseconds).
372 * @return Operation status.
373 */
374 GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidExposure(GoWebScanSettings settings, k32u value);
375 
376 /**
377 * Gets the tracheid exposure in microseconds.
378 *
379 * @public @memberof GoWebScanSettings
380 * @param settings GoWebScanSettings object.
381 * @return Tracheid exposure (microseconds).
382 */
383 GoWebScanFx(k32u) GoWebScanSettings_TracheidExposure(GoWebScanSettings settings);
384 
385 /**
386 * Sets the profile X resolution (mils per profile pixel, along board length). Output data will be
387 * resampled to this resolution.
388 *
389 * @public @memberof GoWebScanSettings
390 * @param settings GoWebScanSettings object.
391 * @param value Profile X resolution (mils/pixel).
392 * @return Operation status.
393 */
394 GoWebScanFx(kStatus) GoWebScanSettings_SetProfileXResolution(GoWebScanSettings settings, k32s value);
395 
396 /**
397 * Gets the profile X resolution (mils per profile pixel, along board length). Output data will be
398 * resampled to this resolution.
399 *
400 * @public @memberof GoWebScanSettings
401 * @param settings GoWebScanSettings object.
402 * @return Profile X resolution (mils/pixel).
403 */
404 GoWebScanFx(k32s) GoWebScanSettings_ProfileXResolution(GoWebScanSettings settings);
405 
406 /**
407 * Sets the profile Y resolution (mils per profile pixel, across board width). Output data will be
408 * resampled to this resolution.
409 *
410 * @public @memberof GoWebScanSettings
411 * @param settings GoWebScanSettings object.
412 * @param value Profile Y resolution (mils/pixel).
413 * @return Operation status.
414 */
415 GoWebScanFx(kStatus) GoWebScanSettings_SetProfileYResolution(GoWebScanSettings settings, k32s value);
416 
417 /**
418 * Gets the profile Y resolution (mils per profile pixel, across board width). Output data will be
419 * resampled to this resolution.
420 *
421 * @public @memberof GoWebScanSettings
422 * @param settings GoWebScanSettings object.
423 * @return Profile Y resolution (mils/pixel).
424 */
425 GoWebScanFx(k32s) GoWebScanSettings_ProfileYResolution(GoWebScanSettings settings);
426 
427 /**
428 * Sets the vision X resolution (mils per vision pixel, along board length).
429 *
430 * @public @memberof GoWebScanSettings
431 * @param settings GoWebScanSettings object.
432 * @param value Vision X resolution (mils/pixel).
433 * @return Operation status.
434 */
435 GoWebScanFx(kStatus) GoWebScanSettings_SetVisionXResolution(GoWebScanSettings settings, k32s value);
436 
437 /**
438 * Gets the vision X resolution (mils per vision pixel, along board length). Output data will be
439 * resampled to this resolution.
440 *
441 * @public @memberof GoWebScanSettings
442 * @param settings GoWebScanSettings object.
443 * @return Vision X resolution (mils/pixel).
444 */
445 GoWebScanFx(k32s) GoWebScanSettings_VisionXResolution(GoWebScanSettings settings);
446 
447 /**
448 * Sets the vision Y resolution (mils per vision pixel, across board width). Output data will be
449 * resampled to this resolution.
450 *
451 * @public @memberof GoWebScanSettings
452 * @param settings GoWebScanSettings object.
453 * @param value Vision Y resolution (mils/pixel).
454 * @return Operation status.
455 */
456 GoWebScanFx(kStatus) GoWebScanSettings_SetVisionYResolution(GoWebScanSettings settings, k32s value);
457 
458 /**
459 * Gets the vision Y resolution (mils per vision pixel, across board width). Output data will be
460 * resampled to this resolution.
461 *
462 * @public @memberof GoWebScanSettings
463 * @param settings GoWebScanSettings object.
464 * @return Vision Y resolution (mils/pixel).
465 */
466 GoWebScanFx(k32s) GoWebScanSettings_VisionYResolution(GoWebScanSettings settings);
467 
468 /**
469 * Sets the tracheid X resolution (mils per tracheid pixel, along board length). Output data will be
470 * resampled to this resolution.
471 *
472 * @public @memberof GoWebScanSettings
473 * @param settings GoWebScanSettings object.
474 * @param value Tracheid X resolution (mils/pixel).
475 * @return Operation status.
476 */
477 GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidXResolution(GoWebScanSettings settings, k32s value);
478 
479 /**
480 * Gets the tracheid X resolution (mils per tracheid pixel, along board length). Output data will be
481 * resampled to this resolution.
482 *
483 * @public @memberof GoWebScanSettings
484 * @param settings GoWebScanSettings object.
485 * @return Tracheid X resolution (mils/pixel).
486 */
487 GoWebScanFx(k32s) GoWebScanSettings_TracheidXResolution(GoWebScanSettings settings);
488 
489 /**
490 * Sets the tracheid Y resolution (mils per tracheid value, across board width). Output data will be
491 * resampled to this resolution.
492 *
493 * @public @memberof GoWebScanSettings
494 * @param settings GoWebScanSettings object.
495 * @param value Tracheid Y resolution (mils/pixel).
496 * @return Operation status.
497 */
498 GoWebScanFx(kStatus) GoWebScanSettings_SetTracheidYResolution(GoWebScanSettings settings, k32s value);
499 
500 /**
501 * Gets the tracheid Y resolution (mils per tracheid value, across board width). Output data will be
502 * resampled to this resolution.
503 *
504 * @public @memberof GoWebScanSettings
505 * @param settings GoWebScanSettings object.
506 * @return Tracheid Y resolution (mils/pixel).
507 */
508 GoWebScanFx(k32s) GoWebScanSettings_TracheidYResolution(GoWebScanSettings settings);
509 
510 /**
511  * Sets the width of the data (mils) included in each profile, vision, or tracheid output tile.
512  *
513  * @public @memberof GoWebScanSettings
514  * @param settings GoWebScanSettings object.
515  * @param value Tile width (mils).
516  * @return Operation status.
517  */
518 GoWebScanFx(kStatus) GoWebScanSettings_SetTileWidth(GoWebScanSettings settings, k32s value);
519 
520 /**
521  * Gets the width of the data (mils) included in each profile, vision, or tracheid output tile.
522  * @public @memberof GoWebScanSettings
523  * @param settings GoWebScanSettings object.
524  * @return Tile width (mils).
525  */
526 GoWebScanFx(k32s) GoWebScanSettings_TileWidth(GoWebScanSettings settings);
527 
528 /**
529  * Sets the maximum distance to fill gaps in data along the X-axis (mils). For all data types
530  * (profile, tracheid, vision), this value determines the maximum gap between cameras that will
531  * be filled by connecting the data from adjacent cameras. Gaps can occur when target objects
532  * are close to the sensors, or when sensors are mounted with space between each device. For
533  * profile and tracheid cameras, this value also determines the maximum x-distance for
534  * interpolation between two valid laser spots when resampling data within a single camera.
535  *
536  * @public @memberof GoWebScanSettings
537  * @param settings GoWebScanSettings object.
538  * @param value Gap fill distance (mils).
539  * @return Operation status.
540  */
541 GoWebScanFx(kStatus) GoWebScanSettings_SetGapFill(GoWebScanSettings settings, k32s value);
542 
543 /**
544 * Gets the maximum distance to fill gaps in data along the X-axis (mils). Refer to GoWebScanSettings_SetGapFill().
545 *
546 * @public @memberof GoWebScanSettings
547 * @param settings GoWebScanSettings object.
548 * @return Gap fill distance (mils).
549 */
550 GoWebScanFx(k32s) GoWebScanSettings_GapFill(GoWebScanSettings settings);
551 
552 /**
553  * Sets the maximum amount of redundant camera information that can be blended together at the x-
554  * boundary between two cameras (mils). Blending occurs only when the fields-of-view between
555  * adjacent cameras have non-zero overlap.
556  *
557  * @public @memberof GoWebScanSettings
558  * @param settings GoWebScanSettings object.
559  * @param value Blending distance (mils).
560  * @return Operation status.
561  */
562 GoWebScanFx(kStatus) GoWebScanSettings_SetOverlapBlend(GoWebScanSettings settings, k32s value);
563 
564 /**
565 * Gets the overlap blend distance in mils. Refer to GoWebScanSettings_SetOverlapBlend().
566 *
567 * @public @memberof GoWebScanSettings
568 * @param settings GoWebScanSettings object.
569 * @return Blending distance (mils).
570 */
571 GoWebScanFx(k32s) GoWebScanSettings_OverlapBlend(GoWebScanSettings settings);
572 
573 /**
574  * Sets the method used to resample profile points along the X-axis: Nearest Neighbor (0), or
575  * Linear Interpolation (1).
576  *
577  * @public @memberof GoWebScanSettings
578  * @param settings GoWebScanSettings object.
579  * @param value Interpolation method.
580  * @return Operation status.
581  */
582 GoWebScanFx(kStatus) GoWebScanSettings_SetProfileInterpolation(GoWebScanSettings settings, GoWebScanInterpolation value);
583 
584 /**
585  * Gets the profile interpolation method: Nearest Neighbor (0), or Linear Interpolation (1).
586  *
587  * @public @memberof GoWebScanSettings
588  * @param settings GoWebScanSettings object.
589  * @return Interpolation method.
590  */
591 GoWebScanFx(GoWebScanInterpolation) GoWebScanSettings_ProfileInterpolation(GoWebScanSettings settings);
592 
593 /**
594  * Sets whether GoWebScan should remove profile points contained within obstruction regions from
595  * output data (1) or include all profile points output data (0).
596  *
597  * @public @memberof GoWebScanSettings
598  * @param settings GoWebScanSettings object.
599  * @param value Boolean to enable obstruction filter.
600  * @return Operation status.
601  */
602 GoWebScanFx(kStatus) GoWebScanSettings_SetObstructionFilter(GoWebScanSettings settings, kBool value);
603 
604 /**
605  * Gets flag for whether the obstruction filter is enabled.
606  *
607  * @public @memberof GoWebScanSettings
608  * @param settings GoWebScanSettings object.
609  * @return Boolean if obstruction filter is enabled.
610  */
611 GoWebScanFx(kBool) GoWebScanSettings_ObstructionFilter(GoWebScanSettings settings);
612 
613 /**
614  * Sets whether GoWebScan should remove tracheid and vision data where there is no corresponding
615  * profile data (1) or include all data in detection output (0).
616  *
617  * @public @memberof GoWebScanSettings
618  * @param settings GoWebScanSettings object.
619  * @param value Boolean to enable the background filter.
620  * @return Operation status.
621  */
622 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectBackgroundFilter(GoWebScanSettings settings, kBool value);
623 
624 /**
625 * Gets flag for whether the background filter is enabled. Refer to GoWebScanSettings_SetDetectBackgroundFilter().
626 *
627 * @public @memberof GoWebScanSettings
628 * @param settings GoWebScanSettings object.
629 * @return Boolean if background filter is enabled.
630 */
631 GoWebScanFx(kBool) GoWebScanSettings_DetectBackgroundFilter(GoWebScanSettings settings);
632 
633 /**
634  * Sets whether profile points which are along the board side edge and report an offset range from
635  * neighbouring spots should be corrected. Side edge spots are modified to report the range of the
636  * adjacent spot that is on the board, giving the board edge a 90 degree angle and more accurate
637  * length instead of a curved edge.
638  *
639  * @public @memberof GoWebScanSettings
640  * @param settings GoWebScanSettings object.
641  * @param value Boolean to enable side extension of the board.
642  * @return Operation status.
643  */
644 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectSideExtension(GoWebScanSettings settings, kBool value);
645 
646 /**
647  * Gets flag for whether extending the board side edge to correct for distortions is enabled.
648  * Refer to GoWebScanSettings_SetDetectSideExtension().
649  *
650  * @public @memberof GoWebScanSettings
651  * @param settings GoWebScanSettings object.
652  * @return Boolean if side extension is enabled.
653  */
654 GoWebScanFx(kBool) GoWebScanSettings_DetectSideExtension(GoWebScanSettings settings);
655 
656 /**
657  * Sets the type of object detection trigger: Global (0) or Local (1). An object is
658  * detected when the amount of visible target material (measured along the X-axis) exceeds the
659  * TriggerLength threshold. With a local trigger, the visible target material must be connected
660  * (contiguous). With a global trigger, the total amount of visible target material in the
661  * system field-of-view is considered.
662  *
663  * @public @memberof GoWebScanSettings
664  * @param settings GoWebScanSettings object.
665  * @param value Detection trigger style.
666  * @return Operation status.
667  */
668 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectTriggerStyle(GoWebScanSettings settings, GoWebScanDetectionStyle value);
669 
670 /**
671  * Gets the detection trigger style. Refer to GoWebScanSettings_SetDetectTriggerStyle().
672  *
673  * @public @memberof GoWebScanSettings
674  * @param settings GoWebScanSettings object.
675  * @return Detection trigger style.
676  */
677 GoWebScanFx(GoWebScanDetectionStyle) GoWebScanSettings_DetectTriggerStyle(GoWebScanSettings settings);
678 
679 /**
680  * Sets the length (mils) of material used to trigger object on/off events, not including
681  * material inside obstruction regions.
682  *
683  * @public @memberof GoWebScanSettings
684  * @param settings GoWebScanSettings object.
685  * @param value Detection trigger length (mils).
686  * @return Operation status.
687  */
688 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectTriggerLength(GoWebScanSettings settings, k32s value);
689 
690 /**
691  * Gets the detection trigger length in mils. Refer to GoWebScanSettings_SetDetectTriggerLength().
692  *
693  * @public @memberof GoWebScanSettings
694  * @param settings GoWebScanSettings object.
695  * @return Detection trigger length (mils).
696  */
697 GoWebScanFx(k32s) GoWebScanSettings_DetectTriggerLength(GoWebScanSettings settings);
698 
699 /**
700  * Sets the size of the margins (mils) that will be added to the leading and trailing edge of
701  * each detected object.
702  *
703  * @public @memberof GoWebScanSettings
704  * @param settings GoWebScanSettings object.
705  * @param value Detection edge margin (mils).
706  * @return Operation status.
707  */
708 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectEdgeMargin(GoWebScanSettings settings, k32s value);
709 
710 /**
711  * Gets the detection edge margin in mils. Refer to GoWebScanSettings_SetDetectEdgeMargin().
712  *
713  * @public @memberof GoWebScanSettings
714  * @param settings GoWebScanSettings object.
715  * @return Detection edge margin (mils).
716  */
717 GoWebScanFx(k32s) GoWebScanSettings_DetectEdgeMargin(GoWebScanSettings settings);
718 
719 /**
720  * Sets the maximum width of a detection output (mils), including edge margins. When objects
721  * exceed this width, they will be segmented into multiple output messages.
722  *
723  * @public @memberof GoWebScanSettings
724  * @param settings GoWebScanSettings object.
725  * @param value Detection maximum width (mils).
726  * @return Operation status.
727  */
728 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectMaxWidth(GoWebScanSettings settings, k32s value);
729 
730 /**
731 * Gets the detection maximum width in mils. Refer to GoWebScanSettings_SetDetectMaxWidth().
732 *
733 * @public @memberof GoWebScanSettings
734 * @param settings GoWebScanSettings object.
735 * @return Detection maximum width (mils).
736 */
737 GoWebScanFx(k32s) GoWebScanSettings_DetectMaxWidth(GoWebScanSettings settings);
738 
739 /**
740  * Sets whether GoWebScan should attempt to remove or correct edge measurement anomalies (1) or
741  * leave them unaltered (0).
742  *
743  * @public @memberof GoWebScanSettings
744  * @param settings GoWebScanSettings object.
745  * @param value Boolean for whether the edge filter is enabled.
746  * @return Operation status.
747  */
748 GoWebScanFx(kStatus) GoWebScanSettings_SetDetectEdgeFilter(GoWebScanSettings settings, kBool value);
749 
750 /**
751 * Gets a flag for whether the detection edge filter is enabled. Refer to GoWebScanSettings_SetDetectEdgeFilter().
752 *
753 * @public @memberof GoWebScanSettings
754 * @param settings GoWebScanSettings object.
755 * @return Boolean for whether the edge filter is enabled.
756 */
757 GoWebScanFx(kBool) GoWebScanSettings_DetectEdgeFilter(GoWebScanSettings settings);
758 
759 /**
760  * Sets whether GoWebScan should attempt to detect calibration reference holes (1),
761  * or assume that sensors are mounted at their nominal locations along the X-axis (0). This
762  * setting applies to vision-enabled systems only and is used during system calibration.
763  *
764  * @public @memberof GoWebScanSettings
765  * @param settings GoWebScanSettings object.
766  * @param value Boolean for whether the detection of calibration locators is enabled.
767  * @return Operation status.
768  */
769 GoWebScanFx(kStatus) GoWebScanSettings_SetCalDetectLocators(GoWebScanSettings settings, kBool value);
770 
771 /**
772 * Gets a flag for whether the detection of calibration locators is enabled.
773 * Refer to GoWebScanSettings_SetCalDetectLocators().
774 *
775 * @public @memberof GoWebScanSettings
776 * @param settings GoWebScanSettings object.
777 * @return Calibration locator detection enabled.
778 */
779 GoWebScanFx(kBool) GoWebScanSettings_CalDetectLocators(GoWebScanSettings settings);
780 
781 /**
782 * Sets whether GoWebScan enables (1) or disables (0) the use of target intensities
783 * for each color channel during vision system calibration.
784 *
785 * @public @memberof GoWebScanSettings
786 * @param settings GoWebScanSettings object.
787 * @param value Boolean to enable target vision intensities.
788 * @return Operation status.
789 */
790 GoWebScanFx(kStatus) GoWebScanSettings_SetCalUseVisionIntensity(GoWebScanSettings settings, kBool value);
791 
792 /**
793  * Gets a flag for whether the use of target intensities for each color channel during vision
794  * system calibration is enabled.
795  *
796  * @public @memberof GoWebScanSettings
797  * @param settings GoWebScanSettings object.
798  * @return Boolean for whether target vision intensities are enabled.
799  */
800 GoWebScanFx(kBool) GoWebScanSettings_CalUseVisionIntensity(GoWebScanSettings settings);
801 
802 /**
803 * Sets the desired red intensity level for the calibration target (1 - 255). This is used
804 * during vision system calibration.
805 *
806 * @public @memberof GoWebScanSettings
807 * @param settings GoWebScanSettings object.
808 * @param value Red target intensity level.
809 * @return Operation status.
810 */
811 GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityR(GoWebScanSettings settings, k8u value);
812 
813 /**
814 * Gets the target red intensity level for vision system calibration.
815 *
816 * @public @memberof GoWebScanSettings
817 * @param settings GoWebScanSettings object.
818 * @return Red target intensity level.
819 */
820 GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityR(GoWebScanSettings settings);
821 
822 /**
823 * Sets the desired green intensity level for the calibration target (1 - 255). This is used
824 * during vision system calibration.
825 *
826 * @public @memberof GoWebScanSettings
827 * @param settings GoWebScanSettings object.
828 * @param value Green target intensity level.
829 * @return Operation status.
830 */
831 GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityG(GoWebScanSettings settings, k8u value);
832 
833 /**
834 * Gets the target green intensity level for vision system calibration.
835 *
836 * @public @memberof GoWebScanSettings
837 * @param settings GoWebScanSettings object.
838 * @return Green target intensity level.
839 */
840 GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityG(GoWebScanSettings settings);
841 
842 /**
843 * Sets the desired blue intensity level for the calibration target (1 - 255). This is used
844 * during vision system calibration.
845 *
846 * @public @memberof GoWebScanSettings
847 * @param settings GoWebScanSettings object.
848 * @param value Blue target intensity level.
849 * @return Operation status.
850 */
851 GoWebScanFx(kStatus) GoWebScanSettings_SetCalVisionIntensityB(GoWebScanSettings settings, k8u value);
852 
853 /**
854 * Gets the target blue intensity level for vision system calibration.
855 *
856 * @public @memberof GoWebScanSettings
857 * @param settings GoWebScanSettings object.
858 * @return Blue target intensity level.
859 */
860 GoWebScanFx(k8u) GoWebScanSettings_CalVisionIntensityB(GoWebScanSettings settings);
861 
862 /**
863  * Sets the offset applied to the X-coordinates of all data (profile, vision, tracheid) in Web
864  * or Detection mode (mils). This setting is used for X-alignment between multiple servers, and
865  * should be written by the user application at the end of system calibration. The X-reference
866  * for a single server is calculated during system calibration and available through
867  * GoWebScanCal_SystemXRef. The user application should calculate the overall X bias, which is
868  * done by averaging the X-references from all servers, and set the X-adjustment for each server
869  * as the X bias minus the server's own X-reference.
870  *
871  * @public @memberof GoWebScanSettings
872  * @param settings GoWebScanSettings object.
873  * @param value X adjustment offset (mils).
874  * @return Operation status.
875  */
876 GoWebScanFx(kStatus) GoWebScanSettings_SetCalXAdjustment(GoWebScanSettings settings, k32s value);
877 
878 /**
879 * Gets the X adjustment offset in mils. Refer to GoWebScanSettings_SetCalXAdjustment() for details.
880 *
881 * @public @memberof GoWebScanSettings
882 * @param settings GoWebScanSettings object.
883 * @return X adjustment offset (mils).
884 */
885 GoWebScanFx(k32s) GoWebScanSettings_CalXAdjustment(GoWebScanSettings settings);
886 
887 /**
888 * Sets the offset applied to the Y-coordinates of all data (profile, vision, tracheid) in Web
889 * or Detection mode (mils). This setting is used for Y-alignment between multiple servers, and
890 * should be written by the user application at the end of system calibration. The Y-reference
891 * for a single server is calculated during system calibration and available through
892 * GoWebScanCal_SystemYRef. The user application should calculate the overall Y bias, which is
893 * done by averaging the X-references from all servers, and set the Y-adjustment for each server
894 * as the Y bias minus the server's own Y-reference.
895 *
896 * @public @memberof GoWebScanSettings
897 * @param settings GoWebScanSettings object.
898 * @param value Y adjustment offset (mils).
899 * @return Operation status.
900 */
901 GoWebScanFx(kStatus) GoWebScanSettings_SetCalYAdjustment(GoWebScanSettings settings, k32s value);
902 
903 /**
904 * Gets the Y adjustment offset in mils. Refer to GoWebScanSettings_SetCalYAdjustment() for details.
905 *
906 * @public @memberof GoWebScanSettings
907 * @param settings GoWebScanSettings object.
908 * @return Y adjustment offset (mils).
909 */
910 GoWebScanFx(k32s) GoWebScanSettings_CalYAdjustment(GoWebScanSettings settings);
911 
912 /**
913  * Sets the divisor to use when calculating minimum Y-interval for retained data during
914  * calibration data collection
915  *
916  * @public @memberof GoWebScanSettings
917  * @param settings GoWebScanSettings object.
918  * @param value Y internal divisor.
919  * @return Operation status.
920  */
921 GoWebScanFx(kStatus) GoWebScanSettings_SetCalYIntervalDivisor(GoWebScanSettings settings, k64f value);
922 
923 /**
924  * Gets the Y interval divisor which is used when calculating minimum Y-interval for retained
925  * data during calibration data collection
926  *
927  * @public @memberof GoWebScanSettings
928  * @param settings GoWebScanSettings object.
929  * @return Y internal divisor.
930  */
931 GoWebScanFx(k64f) GoWebScanSettings_CalYIntervalDivisor(GoWebScanSettings settings);
932 
933 /**
934  * Sets whether to manually remove regions from the calibration input data via user-defined
935  * obstructions (1) or to automatically detect conveyor hardware regions (0).These regions are
936  * specified via sensor obstructions (GoWebScanSettingsSensor_AddObstruction()) and typically
937  * represent conveyor hardware regions. When this field is disabled, the calibration will
938  * automatically detect conveyor hardware regions to remove from the input data.
939  *
940  * @public @memberof GoWebScanSettings
941  * @param settings GoWebScanSettings object.
942  * @param value Boolean to enable using user-defined obstructions during calibration.
943  * @return Operation status.
944  * @see GoWebScanSettingsSensor_AddObstruction
945  */
946 GoWebScanFx(kStatus) GoWebScanSettings_SetUseObstructions(GoWebScanSettings settings, kBool value);
947 
948 /**
949 * Gets a flag for whether to manually remove regions from the calibration input data via
950 * user-defined obstructions (1) or to automatically detect conveyor hardware regions (0).
951 *
952 * @public @memberof GoWebScanSettings
953 * @param settings GoWebScanSettings object.
954 * @return Boolean to enable using user-defined obstructions during calibration.
955 */
956 GoWebScanFx(kBool) GoWebScanSettings_CalUseObstructions(GoWebScanSettings settings);
957 
958 /**
959  * Gets the number of groups (representing planes) in the system.
960  *
961  * @public @memberof GoWebScanSettings
962  * @param settings GoWebScanSettings object.
963  * @return Number of groups.
964  */
965 GoWebScanFx(kSize) GoWebScanSettings_GroupCount(GoWebScanSettings settings);
966 
967 /**
968  * Gets the GoWebScanSettingsGroup object representing a group at a specified index.
969  *
970  * @public @memberof GoWebScanSettings
971  * @param settings GoWebScanSettings object.
972  * @param index Group index.
973  * @return GoWebScanSettingsGroup object representing group.
974  */
975 GoWebScanFx(GoWebScanSettingsGroup) GoWebScanSettings_GroupAt(GoWebScanSettings settings, kSize index);
976 
977 /**
978  * Gets the number of sensors in the system.
979  *
980  * @public @memberof GoWebScanSettings
981  * @param settings GoWebScanSettings object.
982  * @return Number of sensors.
983  */
984 GoWebScanFx(kSize) GoWebScanSettings_SensorCount(GoWebScanSettings settings);
985 
986 /**
987  * Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the system.
988  *
989  * @public @memberof GoWebScanSettings
990  * @param settings GoWebScanSettings object.
991  * @param index Sensor index.
992  * @return GoWebScanSettingsSensor object representing sensor.
993  */
994 GoWebScanFx(GoWebScanSettingsSensor) GoWebScanSettings_SensorAt(GoWebScanSettings settings, kSSize index);
995 
996 /*
997 * GoWebScanSettingsGroup
998 */
999 
1000 /**
1001  * Constructs a GoWebScanSettingsGroup object.
1002  *
1003  * @public @memberof GoWebScanSettingsGroup
1004  * @param group Receives the constructed GoWebScanSettingsGroup object.
1005  * @param parent Settings for the system the group is part of.
1006  * @param allocator Memory allocator (or kNULL for default).
1007  * @return Operation status.
1008  */
1009 GoWebScanFx(kStatus) GoWebScanSettingsGroup_Construct(GoWebScanSettingsGroup* group, GoWebScanSettings parent, kAlloc allocator);
1010 
1011 /**
1012  * Sets the system plane for the group.
1013  *
1014  * @public @memberof GoWebScanSettingsGroup
1015  * @param group GoWebScanSettingsGroup object.
1016  * @param plane System plane
1017  * @return Operation status.
1018  */
1019 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetPlane(GoWebScanSettingsGroup group, GoWebScanSystemPlane plane);
1020 
1021 /**
1022  * Sets the number of sensors in the group.
1023  *
1024  * @public @memberof GoWebScanSettingsGroup
1025  * @param group GoWebScanSettingsGroup object.
1026  * @param count Number of sensors.
1027  * @return Operation status.
1028  */
1029 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSensorCount(GoWebScanSettingsGroup group, kSize count);
1030 
1031 /**
1032  * Adds a section to the group. Sections are used to outputs of a specified plane and data type
1033  * spanning a specified region in X.
1034  *
1035  * @public @memberof GoWebScanSettingsGroup
1036  * @param group GoWebScanSettingsGroup object.
1037  * @param section Section to add to the group.
1038  * @return Operation status.
1039  */
1040 GoWebScanFx(kStatus) GoWebScanSettingsGroup_AddSection(GoWebScanSettingsGroup group, const GoWebScanSection* section);
1041 
1042 /**
1043  * Removes a section from the group. Sections are used to outputs of a specified plane and data type
1044  * spanning a specified region in X.
1045  *
1046  * @public @memberof GoWebScanSettingsGroup
1047  * @param group GoWebScanSettingsGroup object.
1048  * @param index Index of the section to remove.
1049  * @return Operation status.
1050  */
1051 GoWebScanFx(kStatus) GoWebScanSettingsGroup_RemoveSection(GoWebScanSettingsGroup group, kSize index);
1052 
1053 /**
1054  * Clears all sections from the list.
1055  *
1056  * @public @memberof GoWebScanSettingsGroup
1057  * @param group GoWebScanSettingsGroup object.
1058  * @return Operation status.
1059  */
1060 GoWebScanFx(kStatus) GoWebScanSettingsGroup_ClearSections(GoWebScanSettingsGroup group);
1061 
1062 /**
1063  * Adds a sensor, as defined by a GoWebScanSettingsSensor object, to the group.
1064  * @public @memberof GoWebScanSettingsGroup
1065  * @param group GoWebScanSettingsGroup object.
1066  * @param sensor Sensor to add to the group.
1067  * @return Operation status.
1068  */
1069 GoWebScanFx(kStatus) GoWebScanSettingsGroup_AddSensor(GoWebScanSettingsGroup group, GoWebScanSettingsSensor sensor);
1070 
1071 /**
1072 * Clears and disposes all sensors from the group.
1073 * @public @memberof GoWebScanSettingsGroup
1074 * @param group GoWebScanSettingsGroup object.
1075 * @return Operation status.
1076 */
1077 GoWebScanFx(kStatus) GoWebScanSettingsGroup_ClearSensors(GoWebScanSettingsGroup group);
1078 
1079 /**
1080  * Gets the number of sensors in the group.
1081  *
1082  * @public @memberof GoWebScanSettingsGroup
1083  * @param group GoWebScanSettingsGroup object.
1084  * @return Number of sensors in group.
1085  */
1086 GoWebScanFx(kSize) GoWebScanSettingsGroup_SensorCount(GoWebScanSettingsGroup group);
1087 
1088 /**
1089  * Gets the GoWebScanSettingsSensor object representing a sensor at a specified index
1090  * in the group.
1091  *
1092  * @public @memberof GoWebScanSettingsGroup
1093  * @param group GoWebScanSettingsGroup object.
1094  * @param index Zero-based index of the.
1095  * @return Sensor at the specified index.
1096  */
1097 GoWebScanFx(GoWebScanSettingsSensor) GoWebScanSettingsGroup_SensorAt(GoWebScanSettingsGroup group, kSize index);
1098 
1099 /**
1100  * Gets the settings of the system the group is in.
1101  *
1102  * @public @memberof GoWebScanSettingsGroup
1103  * @param group GoWebScanSettingsGroup object.
1104  * @return System settings.
1105  */
1106 GoWebScanFx(GoWebScanSettings) GoWebScanSettingsGroup_Parent(GoWebScanSettingsGroup group);
1107 
1108 /**
1109  * Gets the system plane of a group.
1110  *
1111  * @public @memberof GoWebScanSettingsGroup
1112  * @param group GoWebScanSettingsGroup object.
1113  * @return System plane.
1114  */
1115 GoWebScanFx(GoWebScanSystemPlane) GoWebScanSettingsGroup_Plane(GoWebScanSettingsGroup group);
1116 
1117 /**
1118  * Gets the number of sections defined for the group.
1119  *
1120  * @public @memberof GoWebScanSettingsGroup
1121  * @param group GoWebScanSettingsGroup object.
1122  * @return Number of sections in group.
1123  */
1124 GoWebScanFx(kSize) GoWebScanSettingsGroup_SectionCount(GoWebScanSettingsGroup group);
1125 
1126 /**
1127  * Gets a pointer to the section at a specified index.
1128  *
1129  * @public @memberof GoWebScanSettingsGroup
1130  * @param group GoWebScanSettingsGroup object.
1131  * @param index Section index.
1132  * @return Pointer to the section.
1133  */
1134 GoWebScanFx(GoWebScanSection*) GoWebScanSettingsGroup_SectionAt(GoWebScanSettingsGroup group, kSize index);
1135 
1136 /**
1137  * Sets the section ID.
1138  *
1139  * @public @memberof GoWebScanSettingsGroup
1140  * @param group GoWebScanSettingsGroup object.
1141  * @param index Section index.
1142  * @param value Section ID.
1143  * @return Operation status.
1144  */
1145 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionId(GoWebScanSettingsGroup group, kSize index, k32s value);
1146 
1147 /**
1148 * Gets the section ID.
1149 *
1150 * @public @memberof GoWebScanSettingsGroup
1151 * @param group GoWebScanSettingsGroup object.
1152 * @param index Section index.
1153 * @return Section ID
1154 */
1155 GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionId(GoWebScanSettingsGroup group, kSize index);
1156 
1157 /**
1158  * Sets the section type. Profile (0), Vision (1), or Tracheid (2).
1159  *
1160  * @public @memberof GoWebScanSettingsGroup
1161  * @param group GoWebScanSettingsGroup object.
1162  * @param index Section index.
1163  * @param value Section type.
1164  * @return Operation status.
1165  */
1166 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionType(GoWebScanSettingsGroup group, kSize index, k32s value);
1167 
1168 /**
1169  * Gets the section type. Profile (0), Vision (1), or Tracheid (2).
1170  *
1171  * @public @memberof GoWebScanSettingsGroup
1172  * @param group GoWebScanSettingsGroup object.
1173  * @param index Section index.
1174  * @return Section type.
1175  */
1176 GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionType(GoWebScanSettingsGroup group, kSize index);
1177 
1178 /**
1179  * Sets the start of section along the X-axis (length), in system coordinates (mils).
1180  *
1181  * @public @memberof GoWebScanSettingsGroup
1182  * @param group GoWebScanSettingsGroup object.
1183  * @param index Section index.
1184  * @param value Section start along X-axis (mils).
1185  * @return Operation status.
1186  */
1187 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionX0(GoWebScanSettingsGroup group, kSize index, k32s value);
1188 
1189 /**
1190 * Gets the start of section along the X-axis (length), in system coordinates (mils).
1191 *
1192 * @public @memberof GoWebScanSettingsGroup
1193 * @param group GoWebScanSettingsGroup object.
1194 * @param index Section index.
1195 * @return Section start along X-axis (mils).
1196 */
1197 GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionX0(GoWebScanSettingsGroup group, kSize index);
1198 
1199 /**
1200 * Sets the end of section along the X-axis (length), in system coordinates (mils). Should be
1201 * greater than X0 set in GoWebScanSettingsGroup_SetSectionX0().
1202 *
1203 * @public @memberof GoWebScanSettingsGroup
1204 * @param group GoWebScanSettingsGroup object.
1205 * @param index Section index.
1206 * @param value Section end along X-axis (mils).
1207 * @return Operation status.
1208 */
1209 GoWebScanFx(kStatus) GoWebScanSettingsGroup_SetSectionX1(GoWebScanSettingsGroup group, kSize index, k32s value);
1210 
1211 /**
1212 * Gets the end of section along the X-axis (length), in system coordinates (mils).
1213 *
1214 * @public @memberof GoWebScanSettingsGroup
1215 * @param group GoWebScanSettingsGroup object.
1216 * @param index Section index.
1217 * @return Section end along X-axis (mils).
1218 */
1219 GoWebScanFx(k32s) GoWebScanSettingsGroup_SectionX1(GoWebScanSettingsGroup group, kSize index);
1220 
1221 
1222 /*
1223 * GoWebScanSettingsSensor
1224 */
1225 
1226 /**
1227 * Constructs a GoWebScanSettingsSensor object.
1228 *
1229 * @public @memberof GoWebScanSettingsSensor
1230 * @param sensor Receives the constructed GoWebScanSettingsSensor object.
1231 * @param allocator Memory allocator (or kNULL for default).
1232 * @return Operation status.
1233 */
1234 GoWebScanFx(kStatus) GoWebScanSettingsSensor_Construct(GoWebScanSettingsSensor* sensor, kAlloc allocator);
1235 
1236 /**
1237  * Sets the parent group the sensor is in.
1238  *
1239  * @public @memberof GoWebScanSettingsSensor
1240  * @param sensor GoWebScanSettingsSensor object.
1241  * @param parent Parent group settings.
1242  * @return Operation status.
1243  */
1244 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetParent(GoWebScanSettingsSensor sensor, GoWebScanSettingsGroup parent);
1245 
1246 /**
1247  * Sets the index of the sensor within the group.
1248  *
1249  * @public @memberof GoWebScanSettingsSensor
1250  * @param sensor GoWebScanSettingsSensor object.
1251  * @param index Sensor index within group.
1252  * @return Operation status.
1253  */
1254 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetIndex(GoWebScanSettingsSensor sensor, kSize index);
1255 
1256 /**
1257  * Sets the serial number of the profile sensor in a paired profile-vision
1258  * GoWebScanSettingsSensor object (for systems with vision).
1259  *
1260  * @public @memberof GoWebScanSettingsSensor
1261  * @param sensor GoWebScanSettingsSensor object.
1262  * @param serialNumber Profile serial number.
1263  * @return Operation status.
1264  */
1265 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetProfileSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber);
1266 
1267 /**
1268 * Sets the serial number of the vision sensor in a paired profile-vision
1269 * GoWebScanSettingsSensor object (for systems with vision). This field
1270 * does not need to be set if no vision is present in the system.
1271 *
1272 * @public @memberof GoWebScanSettingsSensor
1273 * @param sensor GoWebScanSettingsSensor object.
1274 * @param serialNumber Vision serial number.
1275 * @return Operation status.
1276 */
1277 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetVisionSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber);
1278 
1279 /**
1280  * Sets whether the sensor is enabled.
1281  *
1282  * @public @memberof GoWebScanSettingsSensor
1283  * @param sensor GoWebScanSettingsSensor object.
1284  * @param enabled Boolean for whether sensor is enabled.
1285  * @return Operation status.
1286  */
1287 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetEnabled(GoWebScanSettingsSensor sensor, kBool enabled);
1288 
1289 /**
1290  * Adds an obstruction to the sensor. An obstruction is defined as an ROI in the X-axis and Z-
1291  * axis (in the sensor's coordinate system) that is ignored by the system. If there are any
1292  * objects that regularly appear within the field of view of the sensors, such as chain runners,
1293  * the zones in which those objects appear must be identified before the system will operate
1294  * correctly in Detection mode. Multiple obstructions can be defined for a single sensor.
1295  *
1296  * @public @memberof GoWebScanSettingsSensor
1297  * @param sensor GoWebScanSettingsSensor object.
1298  * @param obstruction Pointer to the obstruction to add.
1299  * @return Operation status.
1300  * @see GoWebScanObstruction
1301  */
1302 GoWebScanFx(kStatus) GoWebScanSettingsSensor_AddObstruction(GoWebScanSettingsSensor sensor, const GoWebScanObstruction* obstruction);
1303 
1304 /**
1305  * Removes an obstruction from the sensor's list of obstructions.
1306  *
1307  * @public @memberof GoWebScanSettingsSensor
1308  * @param sensor GoWebScanSettingsSensor object.
1309  * @param index Index of the obstruction.
1310  * @return Operation status.
1311  */
1312 GoWebScanFx(kStatus) GoWebScanSettingsSensor_RemoveObstruction(GoWebScanSettingsSensor sensor, kSize index);
1313 
1314 /**
1315  * Removes all obstructions defined for a sensor.
1316  *
1317  * @public @memberof GoWebScanSettingsSensor
1318  * @param sensor GoWebScanSettingsSensor object.
1319  * @return Operation status.
1320  */
1321 GoWebScanFx(kStatus) GoWebScanSettingsSensor_ClearObstructions(GoWebScanSettingsSensor sensor);
1322 
1323 /**
1324  * Gets the settings file of the parent group the sensor is part of.
1325  *
1326  * @public @memberof GoWebScanSettingsSensor
1327  * @param sensor GoWebScanSettingsSensor object.
1328  * @return GoWebScanSettingsGroup object representing parent group.
1329  */
1330 GoWebScanFx(GoWebScanSettingsGroup) GoWebScanSettingsSensor_Parent(GoWebScanSettingsSensor sensor);
1331 
1332 /**
1333  * Gets the system plane the sensor is located in.
1334  *
1335  * @public @memberof GoWebScanSettingsSensor
1336  * @param sensor GoWebScanSettingsSensor object.
1337  * @return System plane of sensor.
1338  */
1339 GoWebScanFx(GoWebScanSystemPlane) GoWebScanSettingsSensor_Plane(GoWebScanSettingsSensor sensor);
1340 
1341 /**
1342 * Gets the index of the sensor with respect to the group.
1343 *
1344 * @public @memberof GoWebScanSettingsSensor
1345 * @param sensor GoWebScanSettingsSensor object.
1346 * @return Index of sensor in group.
1347 */
1348 GoWebScanFx(kSize) GoWebScanSettingsSensor_Index(GoWebScanSettingsSensor sensor);
1349 
1350 /**
1351  * Gets the serial number of the sensor. For systems with vision where the
1352  * GoWebScanSettingsSensor object represents a profile-vision pair, this
1353  * returns the profile serial number.
1354  *
1355  * @public @memberof GoWebScanSettingsSensor
1356  * @param sensor GoWebScanSettingsSensor object.
1357  * @return Profile serial number.
1358  */
1359 GoWebScanFx(k32s) GoWebScanSettingsSensor_ProfileSerialNumber(GoWebScanSettingsSensor sensor);
1360 
1361 /**
1362  * Gets the serial number of the vision sensor in a profile-vision pair (for vision systems
1363  * only). If the system has no vision, this will return GO_WEB_SCAN_UNASSIGNED_SERIAL_NUMBER.
1364  *
1365  * @public @memberof GoWebScanSettingsSensor
1366  * @param sensor GoWebScanSettingsSensor object.
1367  * @return Vision serial number.
1368  */
1369 GoWebScanFx(k32s) GoWebScanSettingsSensor_VisionSerialNumber(GoWebScanSettingsSensor sensor);
1370 
1371 /**
1372 * Gets a flag for whether the sensor is enabled.
1373 *
1374 * @public @memberof GoWebScanSettingsSensor
1375 * @param sensor GoWebScanSettingsSensor object.
1376 * @return Boolean for whether sensor is enabled.
1377 */
1378 GoWebScanFx(kBool) GoWebScanSettingsSensor_Enabled(GoWebScanSettingsSensor sensor);
1379 
1380 /**
1381  * Gets the effective X center of the sensor in system coordinates (mils). If
1382  * GoWebScanSettings_SetUseXCenters has been enabled and an X center has been set via
1383  * GoWebScanSettingsSensor_SetXCenter, this will be returned, otherwise the X center will be
1384  * calculated assuming nominal 24'' spacing between sensor centers (e.g., 12'', 36'', etc..).
1385  *
1386  * @public @memberof GoWebScanSettingsSensor
1387  * @param sensor GoWebScanSettingsSensor object.
1388  * @return Effective X center (mils).
1389  */
1390 GoWebScanFx(k32s) GoWebScanSettingsSensor_EffectiveXCenter(GoWebScanSettingsSensor sensor);
1391 
1392 /**
1393  * Gets the number of obstructions defined for a sensor.
1394  *
1395  * @public @memberof GoWebScanSettingsSensor
1396  * @param sensor GoWebScanSettingsSensor object.
1397  * @return Number of obstructions.
1398  */
1399 GoWebScanFx(kSize) GoWebScanSettingsSensor_ObstructionCount(GoWebScanSettingsSensor sensor);
1400 
1401 /**
1402  * Gets the obstruction at a specified index.
1403  *
1404  * @public @memberof GoWebScanSettingsSensor
1405  * @param sensor GoWebScanSettingsSensor object.
1406  * @param index Obstruction index.
1407  * @return Pointer to the obstruction.
1408  */
1409 GoWebScanFx(GoWebScanObstruction*) GoWebScanSettingsSensor_ObstructionAt(GoWebScanSettingsSensor sensor, kSize index);
1410 
1411 /**
1412  * Gets the array list of obstructions defined for a sensor.
1413  *
1414  * @public @memberof GoWebScanSettingsSensor
1415  * @param sensor GoWebScanSettingsSensor object.
1416  * @return Array list of obstructions. Type GoWebScanObstruction.
1417  */
1418 GoWebScanFx(kArrayList) GoWebScanSettingsSensor_Obstructions(GoWebScanSettingsSensor sensor);
1419 
1420 /**
1421  * Sets the mounting location of the sensor, in system coordinates (mils). This setting
1422  * has no effect unless GoWebScanSettings_SetUseXCenters() is also enabled.
1423  *
1424  * @public @memberof GoWebScanSettingsSensor
1425  * @param sensor GoWebScanSettingsSensor object.
1426  * @param value X center of sensor (mils).
1427  * @return Operation status.
1428  */
1429 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetXCenter(GoWebScanSettingsSensor sensor, k32s value);
1430 
1431 /**
1432  * Gets the mounting location of the sensor, in system coordinates (mils). This setting
1433  * has no effect unless GoWebScanSettings_SetUseXCenters() is also enabled.
1434  *
1435  * @public @memberof GoWebScanSettingsSensor
1436  * @param sensor GoWebScanSettingsSensor object.
1437  * @return X center of sensor (mils).
1438  */
1439 GoWebScanFx(k32s) GoWebScanSettingsSensor_XCenter(GoWebScanSettingsSensor sensor);
1440 
1441 /**
1442  * Sets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
1443  *
1444  * @public @memberof GoWebScanSettingsSensor
1445  * @param sensor GoWebScanSettingsSensor object.
1446  * @param index Obstruction index.
1447  * @param value Start of obstruction in X (mils).
1448  * @return Operation status.
1449  */
1450 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionX0(GoWebScanSettingsSensor sensor, kSize index, k32s value);
1451 
1452 /**
1453 * Gets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
1454 *
1455 * @public @memberof GoWebScanSettingsSensor
1456 * @param sensor GoWebScanSettingsSensor object.
1457 * @param index Obstruction index.
1458 * @return Start of obstruction in X (mils).
1459 */
1460 GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionX0(GoWebScanSettingsSensor sensor, kSize index);
1461 
1462 /**
1463 * Sets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
1464 *
1465 * @public @memberof GoWebScanSettingsSensor
1466 * @param sensor GoWebScanSettingsSensor object.
1467 * @param index Obstruction index.
1468 * @param value End of obstruction in X (mils).
1469 * @return Operation status.
1470 */
1471 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionX1(GoWebScanSettingsSensor sensor, kSize index, k32s value);
1472 
1473 /**
1474 * Gets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils).
1475 *
1476 * @public @memberof GoWebScanSettingsSensor
1477 * @param sensor GoWebScanSettingsSensor object.
1478 * @param index Obstruction index.
1479 * @return End of obstruction in X (mils).
1480 */
1481 GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionX1(GoWebScanSettingsSensor sensor, kSize index);
1482 
1483 /**
1484 * Sets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
1485 *
1486 * @public @memberof GoWebScanSettingsSensor
1487 * @param sensor GoWebScanSettingsSensor object.
1488 * @param index Obstruction index.
1489 * @param value Start of obstruction in Z (mils).
1490 * @return Operation status.
1491 */
1492 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionZ0(GoWebScanSettingsSensor sensor, kSize index, k32s value);
1493 
1494 /**
1495 * Gets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
1496 *
1497 * @public @memberof GoWebScanSettingsSensor
1498 * @param sensor GoWebScanSettingsSensor object.
1499 * @param index Obstruction index.
1500 * @return Start of obstruction in Z (mils).
1501 */
1502 GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionZ0(GoWebScanSettingsSensor sensor, kSize index);
1503 
1504 /**
1505 * Sets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
1506 *
1507 * @public @memberof GoWebScanSettingsSensor
1508 * @param sensor GoWebScanSettingsSensor object.
1509 * @param index Obstruction index.
1510 * @param value End of obstruction in Z (mils).
1511 * @return Operation status.
1512 */
1513 GoWebScanFx(kStatus) GoWebScanSettingsSensor_SetObstructionZ1(GoWebScanSettingsSensor sensor, kSize index, k32s value);
1514 
1515 /**
1516 * Gets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils).
1517 *
1518 * @public @memberof GoWebScanSettingsSensor
1519 * @param sensor GoWebScanSettingsSensor object.
1520 * @param index Obstruction index.
1521 * @return End of obstruction in Z (mils).
1522 */
1523 GoWebScanFx(k32s) GoWebScanSettingsSensor_ObstructionZ1(GoWebScanSettingsSensor sensor, kSize index);
1524 
1525 kEndHeader()
1526 #include <GoWebScanSdk/GoWebScanSettings.x.h>
1527 
1528 #endif
kStatus GoWebScanSettings_SetCalUseVisionIntensity(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan enables (1) or disables (0) the use of target intensities for each color chann...
kStatus GoWebScanSettingsSensor_RemoveObstruction(GoWebScanSettingsSensor sensor, kSize index)
Removes an obstruction from the sensor's list of obstructions.
kStatus GoWebScanSettings_SetVisionExposure(GoWebScanSettings settings, k32u value)
Sets the vision exposure in microseconds.
kStatus GoWebScanSettingsSensor_SetEnabled(GoWebScanSettingsSensor sensor, kBool enabled)
Sets whether the sensor is enabled.
kStatus GoWebScanSettings_Store(GoWebScanSettings settings, const kChar *fileName)
Stores the settings XML to a specified path.
k32s GoWebScanSettings_TracheidYResolution(GoWebScanSettings settings)
Gets the tracheid Y resolution (mils per tracheid value, across board width).
kStatus GoWebScanSettingsGroup_SetPlane(GoWebScanSettingsGroup group, GoWebScanSystemPlane plane)
Sets the system plane for the group.
kStatus GoWebScanSettings_SetCalYAdjustment(GoWebScanSettings settings, k32s value)
Sets the offset applied to the Y-coordinates of all data (profile, vision, tracheid) in Web or Detect...
Represents a style of triggering the start of an object when in detection mode. The start of an objec...
kStatus GoWebScanSettings_SetDetectTriggerStyle(GoWebScanSettings settings, GoWebScanDetectionStyle value)
Sets the type of object detection trigger: Global (0) or Local (1).
Represents a style of interpolation used during profile resampling.
kStatus GoWebScanSettingsSensor_ClearObstructions(GoWebScanSettingsSensor sensor)
Removes all obstructions defined for a sensor.
kStatus GoWebScanSettingsSensor_SetProfileSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber)
Sets the serial number of the profile sensor in a paired profile-vision GoWebScanSettingsSensor objec...
kStatus GoWebScanSettings_SetCalVisionIntensityB(GoWebScanSettings settings, k8u value)
Sets the desired blue intensity level for the calibration target (1 - 255).
kSize GoWebScanSettings_SensorCount(GoWebScanSettings settings)
Gets the number of sensors in the system.
k32s GoWebScanSettingsSensor_ObstructionZ1(GoWebScanSettingsSensor sensor, kSize index)
Gets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils)...
k32s GoWebScanSettingsSensor_ObstructionX1(GoWebScanSettingsSensor sensor, kSize index)
Gets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils)...
k32s GoWebScanSettingsSensor_ObstructionX0(GoWebScanSettingsSensor sensor, kSize index)
Gets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils)...
kStatus GoWebScanSettingsGroup_SetSectionX1(GoWebScanSettingsGroup group, kSize index, k32s value)
Sets the end of section along the X-axis (length), in system coordinates (mils).
GoWebScanObstruction * GoWebScanSettingsSensor_ObstructionAt(GoWebScanSettingsSensor sensor, kSize index)
Gets the obstruction at a specified index.
kStatus GoWebScanSettingsSensor_SetParent(GoWebScanSettingsSensor sensor, GoWebScanSettingsGroup parent)
Sets the parent group the sensor is in.
k64f GoWebScanSettings_CalYIntervalDivisor(GoWebScanSettings settings)
Gets the Y interval divisor which is used when calculating minimum Y-interval for retained data durin...
kStatus GoWebScanSettings_SetCalYIntervalDivisor(GoWebScanSettings settings, k64f value)
Sets the divisor to use when calculating minimum Y-interval for retained data during calibration data...
kStatus GoWebScanSettingsSensor_SetVisionSerialNumber(GoWebScanSettingsSensor sensor, k32s serialNumber)
Sets the serial number of the vision sensor in a paired profile-vision GoWebScanSettingsSensor object...
kStatus GoWebScanSettings_SetSimulatedSpeed(GoWebScanSettings settings, k64f value)
Sets the simulated encoder speed.
kStatus GoWebScanSettingsGroup_AddSensor(GoWebScanSettingsGroup group, GoWebScanSettingsSensor sensor)
Adds a sensor, as defined by a GoWebScanSettingsSensor object, to the group.
kBool GoWebScanSettings_DetectEdgeFilter(GoWebScanSettings settings)
Gets a flag for whether the detection edge filter is enabled.
kStatus GoWebScanSettingsSensor_Construct(GoWebScanSettingsSensor *sensor, kAlloc allocator)
Constructs a GoWebScanSettingsSensor object.
kStatus GoWebScanSettingsGroup_ClearSensors(GoWebScanSettingsGroup group)
Clears and disposes all sensors from the group.
k32s GoWebScanSettings_CalXAdjustment(GoWebScanSettings settings)
Gets the X adjustment offset in mils.
GoWebScanSettings GoWebScanSettingsGroup_Parent(GoWebScanSettingsGroup group)
Gets the settings of the system the group is in.
kStatus GoWebScanSettingsGroup_SetSectionType(GoWebScanSettingsGroup group, kSize index, k32s value)
Sets the section type.
kStatus GoWebScanSettings_SetUseObstructions(GoWebScanSettings settings, kBool value)
Sets whether to manually remove regions from the calibration input data via user-defined obstructions...
k32s GoWebScanSettings_TracheidXResolution(GoWebScanSettings settings)
Gets the tracheid X resolution (mils per tracheid pixel, along board length).
k32s GoWebScanSettings_GapFill(GoWebScanSettings settings)
Gets the maximum distance to fill gaps in data along the X-axis (mils).
GoWebScanSettingsSensor GoWebScanSettings_SensorAt(GoWebScanSettings settings, kSSize index)
Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the system...
Represents a container for user-configurable settings of the system. The class reads and writes the s...
kStatus GoWebScanSettingsSensor_AddObstruction(GoWebScanSettingsSensor sensor, const GoWebScanObstruction *obstruction)
Adds an obstruction to the sensor.
Essential GoWebScan declarations.
GoWebScanSystemPlane GoWebScanSettingsGroup_Plane(GoWebScanSettingsGroup group)
Gets the system plane of a group.
kStatus GoWebScanSettings_SetObstructionFilter(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan should remove profile points contained within obstruction regions from output ...
kStatus GoWebScanSettings_SetGapFill(GoWebScanSettings settings, k32s value)
Sets the maximum distance to fill gaps in data along the X-axis (mils).
kStatus GoWebScanSettings_SetProfileInterpolation(GoWebScanSettings settings, GoWebScanInterpolation value)
Sets the method used to resample profile points along the X-axis: Nearest Neighbor (0)...
kStatus GoWebScanSettingsSensor_SetObstructionZ1(GoWebScanSettingsSensor sensor, kSize index, k32s value)
Sets the end of an obstruction zone along the Z-axis (height), in sensor coordinates (mils)...
kStatus GoWebScanSettings_SetTravelOrientation(GoWebScanSettings settings, k32s value)
Sets the travel orientation which specifies the direction of conveyor movement: Moving Toward (1) or ...
kStatus GoWebScanSettings_SetTracheidExposure(GoWebScanSettings settings, k32u value)
Sets the tracheid exposure in microseconds.
k32s GoWebScanSettings_VisionYResolution(GoWebScanSettings settings)
Gets the vision Y resolution (mils per vision pixel, across board width).
k32s GoWebScanSettingsSensor_ProfileSerialNumber(GoWebScanSettingsSensor sensor)
Gets the serial number of the sensor.
kArrayList GoWebScanSettingsSensor_Obstructions(GoWebScanSettingsSensor sensor)
Gets the array list of obstructions defined for a sensor.
k64f GoWebScanSettings_SimulatedSpeed(GoWebScanSettings settings)
Gets the simulated encoder speed.
kStatus GoWebScanSettings_SetProfileFrameRate(GoWebScanSettings settings, k32u value)
Sets the frame rate to configure profile sensors to, in Hz.
k32s GoWebScanSettings_CalYAdjustment(GoWebScanSettings settings)
Gets the Y adjustment offset in mils.
kStatus GoWebScanSettings_SetDetectMaxWidth(GoWebScanSettings settings, k32s value)
Sets the maximum width of a detection output (mils), including edge margins.
kBool GoWebScanSettingsSensor_Enabled(GoWebScanSettingsSensor sensor)
Gets a flag for whether the sensor is enabled.
k32s GoWebScanSettingsGroup_SectionType(GoWebScanSettingsGroup group, kSize index)
Gets the section type.
k32s GoWebScanSettings_DetectMaxWidth(GoWebScanSettings settings)
Gets the detection maximum width in mils.
kStatus GoWebScanSettingsSensor_SetXCenter(GoWebScanSettingsSensor sensor, k32s value)
Sets the mounting location of the sensor, in system coordinates (mils).
k32s GoWebScanSettingsGroup_SectionId(GoWebScanSettingsGroup group, kSize index)
Gets the section ID.
kStatus GoWebScanSettings_SetCalVisionIntensityR(GoWebScanSettings settings, k8u value)
Sets the desired red intensity level for the calibration target (1 - 255).
kBool GoWebScanSettings_DetectBackgroundFilter(GoWebScanSettings settings)
Gets flag for whether the background filter is enabled.
k32u GoWebScanSettings_ProfileExposure(GoWebScanSettings settings)
Gets the profile exposure in microseconds.
kBool GoWebScanSettings_UseXCenters(GoWebScanSettings settings)
Gets the flag for whether GoWebScan uses user-defined X-centers.
kStatus GoWebScanSettings_SetEncoderSimulated(GoWebScanSettings settings, kBool value)
Enables simulating forward motion by overriding encoder values in data messages with simulated values...
kStatus GoWebScanSettings_SetVisionYResolution(GoWebScanSettings settings, k32s value)
Sets the vision Y resolution (mils per vision pixel, across board width).
kBool GoWebScanSettings_CalUseVisionIntensity(GoWebScanSettings settings)
Gets a flag for whether the use of target intensities for each color channel during vision system cal...
k32u GoWebScanSettings_TracheidExposure(GoWebScanSettings settings)
Gets the tracheid exposure in microseconds.
GoWebScanInterpolation GoWebScanSettings_ProfileInterpolation(GoWebScanSettings settings)
Gets the profile interpolation method: Nearest Neighbor (0), or Linear Interpolation (1)...
GoWebScanSection * GoWebScanSettingsGroup_SectionAt(GoWebScanSettingsGroup group, kSize index)
Gets a pointer to the section at a specified index.
k32s GoWebScanSettings_OverlapBlend(GoWebScanSettings settings)
Gets the overlap blend distance in mils.
kStatus GoWebScanSettings_SetVisionXResolution(GoWebScanSettings settings, k32s value)
Sets the vision X resolution (mils per vision pixel, along board length).
kStatus GoWebScanSettings_SetProfileExposure(GoWebScanSettings settings, k32u value)
Sets the profile exposure in microseconds.
kBool GoWebScanSettings_TracheidEnabled(GoWebScanSettings settings)
Gets the flag for whether tracheid data is enabled.
k32s GoWebScanSettings_DetectEdgeMargin(GoWebScanSettings settings)
Gets the detection edge margin in mils.
kStatus GoWebScanSettingsGroup_Construct(GoWebScanSettingsGroup *group, GoWebScanSettings parent, kAlloc allocator)
Constructs a GoWebScanSettingsGroup object.
kBool GoWebScanSettings_CalUseObstructions(GoWebScanSettings settings)
Gets a flag for whether to manually remove regions from the calibration input data via user-defined o...
GoWebScanSystemPlane GoWebScanSettingsSensor_Plane(GoWebScanSettingsSensor sensor)
Gets the system plane the sensor is located in.
Represents a container for user-configurable settings of a group within the system. Groups represent planes (top or bottom).
kStatus GoWebScanSettings_SetXOrientation(GoWebScanSettings settings, k32s value)
Sets the sensor X orientation which represents whether the X-axis (length) increasing from left-to-ri...
k32s GoWebScanSettings_VisionXResolution(GoWebScanSettings settings)
Gets the vision X resolution (mils per vision pixel, along board length).
kStatus GoWebScanSettings_SetTracheidYResolution(GoWebScanSettings settings, k32s value)
Sets the tracheid Y resolution (mils per tracheid value, across board width).
kStatus GoWebScanSettings_SetDetectEdgeFilter(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan should attempt to remove or correct edge measurement anomalies (1) or leave th...
kStatus GoWebScanSettings_Construct(GoWebScanSettings *settings, kAlloc allocator)
Constructs a GoWebScanSettings object.
kStatus GoWebScanSettingsGroup_SetSensorCount(GoWebScanSettingsGroup group, kSize count)
Sets the number of sensors in the group.
kStatus GoWebScanSettingsGroup_SetSectionX0(GoWebScanSettingsGroup group, kSize index, k32s value)
Sets the start of section along the X-axis (length), in system coordinates (mils).
kStatus GoWebScanSettings_SetTileWidth(GoWebScanSettings settings, k32s value)
Sets the width of the data (mils) included in each profile, vision, or tracheid output tile...
k32s GoWebScanSettings_TileWidth(GoWebScanSettings settings)
Gets the width of the data (mils) included in each profile, vision, or tracheid output tile...
k32s GoWebScanSettings_Concurrency(GoWebScanSettings settings)
Gets the thread count for processing tasks concurrently.
kStatus GoWebScanSettings_SetProfileXResolution(GoWebScanSettings settings, k32s value)
Sets the profile X resolution (mils per profile pixel, along board length).
kBool GoWebScanSettings_ObstructionFilter(GoWebScanSettings settings)
Gets flag for whether the obstruction filter is enabled.
k64f GoWebScanSettings_EncoderResolution(GoWebScanSettings settings)
Gets the encoder resolution in mils/tick.
GoWebScanSettingsSensor GoWebScanSettingsGroup_SensorAt(GoWebScanSettingsGroup group, kSize index)
Gets the GoWebScanSettingsSensor object representing a sensor at a specified index in the group...
k8u GoWebScanSettings_CalVisionIntensityG(GoWebScanSettings settings)
Gets the target green intensity level for vision system calibration.
kStatus GoWebScanSettingsGroup_ClearSections(GoWebScanSettingsGroup group)
Clears all sections from the list.
kStatus GoWebScanSettings_SetProfileYResolution(GoWebScanSettings settings, k32s value)
Sets the profile Y resolution (mils per profile pixel, across board width).
k32s GoWebScanSettings_ProfileXResolution(GoWebScanSettings settings)
Gets the profile X resolution (mils per profile pixel, along board length).
k32s GoWebScanSettings_TravelOrientation(GoWebScanSettings settings)
Gets the travel orientation which specifies the direction of conveyor movement: Moving Toward (1) or ...
kStatus GoWebScanSettings_EnableTracheid(GoWebScanSettings settings, kBool enable)
Enables tracheid data in the system.
kSize GoWebScanSettings_GroupCount(GoWebScanSettings settings)
Gets the number of groups (representing planes) in the system.
kSize GoWebScanSettingsSensor_ObstructionCount(GoWebScanSettingsSensor sensor)
Gets the number of obstructions defined for a sensor.
kStatus GoWebScanSettingsGroup_RemoveSection(GoWebScanSettingsGroup group, kSize index)
Removes a section from the group.
Defines GoWebScan utility functions.
kStatus GoWebScanSettingsSensor_SetObstructionZ0(GoWebScanSettingsSensor sensor, kSize index, k32s value)
Sets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils)...
k32s GoWebScanSettings_SensorYOrientation(GoWebScanSettings settings, k32s plane)
Gets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0)...
Represents the top or bottom plane of the system.
k8u GoWebScanSettings_CalVisionIntensityB(GoWebScanSettings settings)
Gets the target blue intensity level for vision system calibration.
k32s GoWebScanSettingsSensor_ObstructionZ0(GoWebScanSettingsSensor sensor, kSize index)
Gets the start of an obstruction zone along the Z-axis (height), in sensor coordinates (mils)...
GoWebScanSettingsGroup GoWebScanSettings_GroupAt(GoWebScanSettings settings, kSize index)
Gets the GoWebScanSettingsGroup object representing a group at a specified index. ...
GoWebScanDetectionStyle GoWebScanSettings_DetectTriggerStyle(GoWebScanSettings settings)
Gets the detection trigger style.
kSize GoWebScanSettingsGroup_SensorCount(GoWebScanSettingsGroup group)
Gets the number of sensors in the group.
k32u GoWebScanSettings_VisionExposure(GoWebScanSettings settings)
Gets the vision exposure in microseconds.
kStatus GoWebScanSettings_SetSensorYOrientation(GoWebScanSettings settings, GoWebScanSystemPlane plane, k32s value)
Sets the sensor Y orientation for a given plane: Facing Toward (1) or Facing Away (0)...
kStatus GoWebScanSettings_SetUseXCenters(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan should use the per-sensor X-center values provided in the settings file...
kBool GoWebScanSettings_DetectSideExtension(GoWebScanSettings settings)
Gets flag for whether extending the board side edge to correct for distortions is enabled...
kStatus GoWebScanSettings_SetConcurrency(GoWebScanSettings settings, k32s value)
Sets the thread count for processing tasks concurrently.
k8u GoWebScanSettings_CalVisionIntensityR(GoWebScanSettings settings)
Gets the target red intensity level for vision system calibration.
k32s GoWebScanSettingsGroup_SectionX0(GoWebScanSettingsGroup group, kSize index)
Gets the start of section along the X-axis (length), in system coordinates (mils).
kStatus GoWebScanSettings_SetDetectSideExtension(GoWebScanSettings settings, kBool value)
Sets whether profile points which are along the board side edge and report an offset range from neigh...
kSize GoWebScanSettingsGroup_SectionCount(GoWebScanSettingsGroup group)
Gets the number of sections defined for the group.
kStatus GoWebScanSettingsSensor_SetObstructionX0(GoWebScanSettingsSensor sensor, kSize index, k32s value)
Sets the start of an obstruction zone along the X-axis (length), in sensor coordinates (mils)...
k32s GoWebScanSettingsSensor_XCenter(GoWebScanSettingsSensor sensor)
Gets the mounting location of the sensor, in system coordinates (mils).
kSize GoWebScanSettingsSensor_Index(GoWebScanSettingsSensor sensor)
Gets the index of the sensor with respect to the group.
kStatus GoWebScanSettings_EnableVision(GoWebScanSettings settings, kBool enable)
Enables vision data in the system.
kStatus GoWebScanSettings_SetDetectBackgroundFilter(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan should remove tracheid and vision data where there is no corresponding profile...
kStatus GoWebScanSettings_SetDetectTriggerLength(GoWebScanSettings settings, k32s value)
Sets the length (mils) of material used to trigger object on/off events, not including material insid...
k32s GoWebScanSettingsGroup_SectionX1(GoWebScanSettingsGroup group, kSize index)
Gets the end of section along the X-axis (length), in system coordinates (mils).
k32s GoWebScanSettings_ProfileYResolution(GoWebScanSettings settings)
Gets the profile Y resolution (mils per profile pixel, across board width).
kStatus GoWebScanSettings_SetOverlapBlend(GoWebScanSettings settings, k32s value)
Sets the maximum amount of redundant camera information that can be blended together at the x- bounda...
k32u GoWebScanSettings_ProfileFrameRate(GoWebScanSettings settings)
Gets the profile frame rate in Hz.
kStatus GoWebScanSettings_SetCalXAdjustment(GoWebScanSettings settings, k32s value)
Sets the offset applied to the X-coordinates of all data (profile, vision, tracheid) in Web or Detect...
Represents a section of output system data. This can be defined by the user to allow for routing data...
Definition: GoWebScanSdkDef.h:494
k32s GoWebScanSettings_XOrientation(GoWebScanSettings settings)
Gets the sensor X orientation.
Represents a container for user-configurable settings of a sensor within the system. For systems with vision, a GoWebScanSettingsSensor object represents a pair of vision and profile sensors (sensor mounted together).
k32s GoWebScanSettingsSensor_EffectiveXCenter(GoWebScanSettingsSensor sensor)
Gets the effective X center of the sensor in system coordinates (mils).
kStatus GoWebScanSettingsSensor_SetObstructionX1(GoWebScanSettingsSensor sensor, kSize index, k32s value)
Sets the end of an obstruction zone along the X-axis (length), in sensor coordinates (mils)...
k32s GoWebScanSettingsSensor_VisionSerialNumber(GoWebScanSettingsSensor sensor)
Gets the serial number of the vision sensor in a profile-vision pair (for vision systems only)...
kBool GoWebScanSettings_CalDetectLocators(GoWebScanSettings settings)
Gets a flag for whether the detection of calibration locators is enabled.
GoWebScanSettingsGroup GoWebScanSettingsSensor_Parent(GoWebScanSettingsSensor sensor)
Gets the settings file of the parent group the sensor is part of.
kStatus GoWebScanSettings_Load(GoWebScanSettings *settings, const kChar *fileName, kAlloc alloc)
Loads the settings XML from a specified path and constructs and initializes a GoWebScanSettings objec...
kStatus GoWebScanSettings_SetDetectEdgeMargin(GoWebScanSettings settings, k32s value)
Sets the size of the margins (mils) that will be added to the leading and trailing edge of each detec...
kStatus GoWebScanSettings_SetCalDetectLocators(GoWebScanSettings settings, kBool value)
Sets whether GoWebScan should attempt to detect calibration reference holes (1), or assume that senso...
kStatus GoWebScanSettingsGroup_SetSectionId(GoWebScanSettingsGroup group, kSize index, k32s value)
Sets the section ID.
kStatus GoWebScanSettingsSensor_SetIndex(GoWebScanSettingsSensor sensor, kSize index)
Sets the index of the sensor within the group.
k32s GoWebScanSettings_DetectTriggerLength(GoWebScanSettings settings)
Gets the detection trigger length in mils.
kStatus GoWebScanSettingsGroup_AddSection(GoWebScanSettingsGroup group, const GoWebScanSection *section)
Adds a section to the group.
kStatus GoWebScanSettings_SetCalVisionIntensityG(GoWebScanSettings settings, k8u value)
Sets the desired green intensity level for the calibration target (1 - 255).
kBool GoWebScanSettings_EncoderSimulated(GoWebScanSettings settings)
Gets the flag for whether the encoder simulator is enabled.
kStatus GoWebScanSettings_SetEncoderResolution(GoWebScanSettings settings, k64f value)
Sets the encoder resolution in mils/tick.
kBool GoWebScanSettings_VisionEnabled(GoWebScanSettings settings)
Gets the flag for whether vision data is enabled.
kStatus GoWebScanSettings_SetTracheidXResolution(GoWebScanSettings settings, k32s value)
Sets the tracheid X resolution (mils per tracheid pixel, along board length).