Gocator API
GoSdkDef.h
Go to the documentation of this file.
1 /**
2  * @file GoSdkDef.h
3  * @brief Essential SDK declarations.
4  *
5  * For each defined value (ie "#define foo <some value>"), it must be followed
6  * on the same line with the three (3) '/', followed by a '<' followed by a
7  * comment about the line, in order
8  * for Doxygen to parse the definitions properly. Otherwise you will get
9  * Doxygen warnings about explicit link request to 'blah blah' could not be
10  * resolved.
11  *
12  * @internal
13  * Copyright (C) 2017 by LMI Technologies Inc.
14  * Licensed under the MIT License.
15  * Redistributed files must retain the above copyright notice.
16  */
17 #ifndef GO_SDK_DEF_H
18 #define GO_SDK_DEF_H
19 
20 #include <kApi/kApiDef.h>
21 #include <kApi/Io/kNetwork.h>
22 
23 #if defined (GO_EMIT)
24 # define GoFx(TYPE) kExportFx(TYPE) ///< GoSdk function declaration helper.
25 # define GoCx(TYPE) kExportCx(TYPE) ///< GoSdk dynamic function declaration helper.
26 # define GoDx(TYPE) kExportDx(TYPE) ///< GoSdk data declaration helper.
27 #elif defined (GO_STATIC)
28 # define GoFx(TYPE) kInFx(TYPE)
29 # define GoCx(TYPE) kInCx(TYPE)
30 # define GoDx(TYPE) kInDx(TYPE)
31 #else
32 # define GoFx(TYPE) kImportFx(TYPE)
33 # define GoCx(TYPE) kImportCx(TYPE)
34 # define GoDx(TYPE) kImportDx(TYPE)
35 #endif
36 
37 /**
38  * Returns the SDK version.
39  *
40  * @public @memberof GoSdk
41  * @version Introduced in firmware 4.0.10.27
42  * @return SDK version.
43  */
44 GoFx(kVersion) GoSdk_Version();
45 
46 /**
47  * Returns the protocol version associated with the SDK.
48  *
49  * @public @memberof GoSdk
50  * @version Introduced in firmware 4.0.10.27
51  * @return Protocol version.
52  */
53 GoFx(kVersion) GoSdk_ProtocolVersion();
54 
55 /**
56  * Frees the memory associated with a given kObject sourced class handle.
57  *
58  * @public @memberof GoSdk
59  * @version Introduced in firmware 4.0.10.27
60  * @param object A kObject.
61  * @return Operation status.
62  */
63 GoFx(kStatus) GoDestroy(kObject object);
64 
65 /**
66  * @struct GoUpgradeFxArgs
67  * @extends kValue
68  * @ingroup GoSdk
69  * @brief Represents arguments provided to an upgrade callback function.
70  */
71 typedef struct GoUpgradeFxArgs
72 {
73  k64f progress; ///< Upgrade progress (percentage).
75 
76 typedef kStatus (kCall* GoUpgradeFx) (kPointer receiver, kObject sender, GoUpgradeFxArgs* args);
77 
78 /**
79  * @struct GoDeviceState
80  * @extends kValue
81  * @ingroup GoSdk
82  * @brief Represents the sensor operational state. Maps to sensor's GsDeviceState.
83  *
84  * The following enumerators are defined:
85  * - #GO_DEVICE_STATE_CONFLICT
86  * - #GO_DEVICE_STATE_READY
87  * - #GO_DEVICE_STATE_RUNNING
88  */
89 typedef k32s GoDeviceState;
90 /** @name GoDeviceState
91  *@{*/
92 #define GO_DEVICE_STATE_CONFLICT (-1) ///< Sensor cannot be used because it is in a conflicting state.
93 #define GO_DEVICE_STATE_READY (0) ///< Sensor is not scanning but is capable of scanning.
94 #define GO_DEVICE_STATE_RUNNING (1) ///< Sensor is scanning.
95 /**@}*/
96 
97 /**
98  * @struct GoUser
99  * @extends kValue
100  * @ingroup GoSdk
101  * @brief Represents a user id.
102  *
103  * The following enumerators are defined:
104  * - #GO_USER_NONE
105  * - #GO_USER_ADMIN
106  * - #GO_USER_TECH
107  */
108 typedef k32s GoUser;
109 /** @name GoUser
110  *@{*/
111 #define GO_USER_NONE (0) ///< No user.
112 #define GO_USER_ADMIN (1) ///< Administrator user.
113 #define GO_USER_TECH (2) ///< Technician user.
114 /**@}*/
115 
116 typedef k32s Buddyable;
117 /** @name Buddyable
118 *@{*/
119 #define GO_NOT_BUDDYABLE (0) ///< Not Buddyable.
120 #define GO_BUDDYABLE (1) ///< Buddyable.
121 #define GO_ALREADY_BUDDIED (-100) ///< Already Buddied.
122 #define GO_INVALID_STATE (-99) ///< Error: Invalid State.
123 #define GO_VERSION_MISMATCH (-98) ///< Error: Version Mismatch.
124 #define GO_MODEL_MISMATCH (-97) ///< Error: Model Mismatch.
125 #define GO_UNREACHABLE_ADDRESS (-96) ///< Error: Unreachable Address.
126 
127 /**@}*/
128 
129 
130 /**
131  * @struct GoState
132  * @extends kValue
133  * @ingroup GoSdk
134  * @brief Represents the current state of a sensor object.
135  *
136  * The following enumerators are defined:
137  * - #GO_STATE_ONLINE
138  * - #GO_STATE_OFFLINE
139  * - #GO_STATE_RESETTING
140  * - #GO_STATE_CONNECTED
141  * - #GO_STATE_INCOMPATIBLE
142  * - #GO_STATE_INCONSISTENT
143  * - #GO_STATE_UNRESPONSIVE
144  * - #GO_STATE_CANCELLED
145  * - #GO_STATE_INCOMPLETE
146  * - #GO_STATE_BUSY
147  * - #GO_STATE_READY
148  * - #GO_STATE_RUNNING
149  */
150 typedef k32s GoState;
151 /** @name GoState
152  *@{*/
153 #define GO_STATE_ONLINE (0) ///< Sensor disconnected, but detected via discovery.
154 #define GO_STATE_OFFLINE (1) ///< Sensor disconnected and no longer detected via discovery (refresh system to eliminate sensor).
155 #define GO_STATE_RESETTING (2) ///< Sensor disconnected and currently resetting (wait for completion).
156 #define GO_STATE_CONNECTED (3) ///< Sensor connected, but state is otherwise unknown. This is an internal state that is normally not returned.
157  ///< Seeing this state usually indicates a race condition in the user code. Please see the description of GoSystem regarding thread safety.
158 #define GO_STATE_INCOMPATIBLE (4) ///< Sensor connected, but protocol incompatible with client (upgrade required).
159 #define GO_STATE_INCONSISTENT (5) ///< Sensor connected, but remote state was changed (refresh sensor).
160 #define GO_STATE_UNRESPONSIVE (6) ///< Sensor connected, but no longer detected via health or discovery (disconnect).
161 #define GO_STATE_CANCELLED (7) ///< Sensor connected, but communication aborted via GoSensor_Cancel function (disconnect or refresh sensor).
162 #define GO_STATE_INCOMPLETE (8) ///< Sensor connected, but a required buddy sensor is not present (wait or remove buddy association).
163 #define GO_STATE_BUSY (9) ///< Sensor connected, but currently controlled by another sensor (cannot be configured directly).
164 #define GO_STATE_READY (10) ///< Sensor connected and ready to accept configuration commands.
165 #define GO_STATE_RUNNING (11) ///< Sensor connected and currently running.
166 #define GO_STATE_UPGRADING (12) ///< Sensor is currently being upgraded.
167 /**@}*/
168 
169 typedef k32s GoBuddyState;
170 /** @name GoBuddyState
171 *@{*/
172 #define GO_BUDDY_STATE_ERROR (0) ///< General Error.
173 #define GO_BUDDY_STATE_CONNECTING (3) ///< Buddy is currently connecting.
174 #define GO_BUDDY_STATE_CONNECTABLE (2) ///< Sensor can be buddied to.
175 #define GO_BUDDY_STATE_CONNECTED (1) ///< Buddy is connected.
176 #define GO_BUDDY_STATE_ALREADY_BUDDIED (-100) ///< Sensor is already buddied to something else.
177 #define GO_BUDDY_STATE_INVALID_STATE (-99) ///< Buddy is in an invalid state.
178 #define GO_BUDDY_STATE_VERSION_MISMATCH (-98) ///< The sensors are not currently running the same Gocator firmware version.
179 #define GO_BUDDY_STATE_MODEL_MISMATCH (-97) ///< Sensors are not of the same model number and cannot be buddied.
180 #define GO_BUDDY_STATE_UNREACHABLE_ADDRESS (-96) ///< Sensor cannot be connected to.
181 #define GO_BUDDY_STATE_DEVICE_MISSING (-95) ///< Buddied sensor cannot be detected.
182 #define GO_BUDDY_STATE_ERROR_CONNECTION (-94) ///< Buddy connection error encountered.
183 #define GO_BUDDY_STATE_MAX_BUDDIES (-93) ///< Maximum number of buddies allowed reached.
184 #define GO_BUDDY_STATE_STANDALONE_NOBUDDY (-92) ///< StandAlone sensor cannot be buddied
185 #define GO_BUDDY_STATE_RESTRICTED_MISMATCH (-91) ///< Restricted sensor can only be buddied with matching restricted sensors.
186 /**@}*/
187 
188 
189 /**
190  * @struct GoRole
191  * @extends kValue
192  * @ingroup GoSdk
193  * @brief Represents a user role. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
194  *
195  * The following enumerators are defined:
196  * - #GO_ROLE_MAIN
197  * - #GO_ROLE_BUDDY
198  */
199 typedef k32s GoRole;
200 /** @name GoRole
201  *@{*/
202 #define GO_ROLE_MAIN (0) ///< Sensor is operating as a main sensor.
203 #define GO_ROLE_BUDDY (1) ///< Sensor is operating as a buddy sensor.
204 #define GOROLE_BUDDYIDX(buddyidx) ((GoRole)GO_ROLE_BUDDY + buddyidx) //finds buddy by index, this expects a zero buddy index as the first index to all buddies
205 /**@}*/
206 
207 /**
208  * @struct GoAcceleratorConnectionStatus
209  * @extends kValue
210  * @ingroup GoSdk
211  * @brief Represents the status of the Accelerator connection.
212  * These are applicable only when using the GoAccelerator class.
213  *
214  * The following enumerators are defined:
215  * - #GO_ACCELERATOR_CONNECTION_STATUS_CONNECTED
216  * - #GO_ACCELERATOR_CONNECTION_STATUS_DISCONNECTED
217  * - #GO_ACCELERATOR_CONNECTION_STATUS_ERROR
218  */
220 /** @name GoAcceleratorConnectionStatus
221  *@{*/
222 #define GO_ACCELERATOR_CONNECTION_STATUS_CONNECTED (0) ///< Accelerated sensor has connected.
223 #define GO_ACCELERATOR_CONNECTION_STATUS_DISCONNECTED (1) ///< Accelerated sensor has disconnected.
224 #define GO_ACCELERATOR_CONNECTION_STATUS_ERROR (2) ///< An error occurred with the accelerated sensor connection.
225 /**@}*/
226 
227 /**
228  * Forward declaration for GoAccelerator.
229  * This allows other modules (e.g., GoSensor) to reference GoAccelerator without
230  * including the full GoAccelerator.h header, breaking circular dependencies.
231  * Added for type safety - replaces kPointer usage in GoSensor.x.h.
232  */
234 
235 /**
236  * @struct GoAlignmentState
237  * @extends kValue
238  * @ingroup GoSdk
239  * @brief Represents an alignment state.
240  *
241  * The following enumerators are defined:
242  * - #GO_ALIGNMENT_STATE_NOT_ALIGNED
243  * - #GO_ALIGNMENT_STATE_ALIGNED
244  */
245 typedef k32s GoAlignmentState;
246 /** @name GoAlignmentState
247  *@{*/
248 #define GO_ALIGNMENT_STATE_NOT_ALIGNED (0) ///< Sensor is not aligned.
249 #define GO_ALIGNMENT_STATE_ALIGNED (1) ///< Sensor is aligned.
250 /**@}*/
251 
252 /**
253  * @struct GoAlignmentRef
254  * @extends kValue
255  * @ingroup GoSdk
256  * @brief Represents an alignment reference.
257  *
258  * The following enumerators are defined:
259  * - #GO_ALIGNMENT_REF_FIXED
260  * - #GO_ALIGNMENT_REF_DYNAMIC
261  */
262 typedef k32s GoAlignmentRef;
263 /** @name GoAlignmentRef
264  *@{*/
265 #define GO_ALIGNMENT_REF_FIXED (0) ///< The alignment used will be specific to the sensor.
266 #define GO_ALIGNMENT_REF_DYNAMIC (1) ///< The alignment used will be specific to the current job if saved.
267 /**@}*/
268 
269 /**
270  * @struct GoMode
271  * @extends kValue
272  * @ingroup GoSdk
273  * @brief Represents a scan mode.
274  *
275  * The following enumerators are defined:
276  * - #GO_MODE_UNKNOWN
277  * - #GO_MODE_VIDEO
278  * - #GO_MODE_RANGE
279  * - #GO_MODE_PROFILE
280  * - #GO_MODE_SURFACE
281  */
282 typedef k32s GoMode;
283 /** @name GoMode
284  *@{*/
285 #define GO_MODE_UNKNOWN (-1) ///< Unknown scan mode.
286 #define GO_MODE_VIDEO (0) ///< Video scan mode.
287 #define GO_MODE_RANGE (1) ///< Range scan mode.
288 #define GO_MODE_PROFILE (2) ///< Profile scan mode.
289 #define GO_MODE_SURFACE (3) ///< Surface scan mode.
290 /**@}*/
291 
292 
293 /**
294  * @struct GoTrigger
295  * @extends kValue
296  * @ingroup GoSdk
297  * @brief Represents a trigger.
298  *
299  * The following enumerators are defined:
300  * - #GO_TRIGGER_TIME
301  * - #GO_TRIGGER_ENCODER
302  * - #GO_TRIGGER_INPUT
303  * - #GO_TRIGGER_SOFTWARE
304  */
305 typedef k32s GoTrigger;
306 /** @name GoTrigger
307  *@{*/
308 #define GO_TRIGGER_TIME (0) ///< The sensor will be time triggered.
309 #define GO_TRIGGER_ENCODER (1) ///< The sensor will be encoder triggered.
310 #define GO_TRIGGER_INPUT (2) ///< The sensor will be digital input triggered.
311 #define GO_TRIGGER_SOFTWARE (3) ///< The sensor will be software triggered.
312 /** @} */
313 
314 /**
315  * @struct GoEncoderTriggerMode
316  * @extends kValue
317  * @ingroup GoSdk
318  * @brief Represents an encoder's triggering behavior.
319  *
320  * The following enumerators are defined:
321  * - #GO_ENCODER_TRIGGER_MODE_TRACK_REVERSE
322  * - #GO_ENCODER_TRIGGER_MODE_IGNORE_REVERSE
323  * - #GO_ENCODER_TRIGGER_MODE_BIDIRECTIONAL
324  */
325 typedef k32s GoEncoderTriggerMode;
326 /** @name GoEncoderTriggerMode
327  *@{*/
328 #define GO_ENCODER_TRIGGER_MODE_TRACK_REVERSE (0) ///< Do not reverse trigger. Track reverse motion to prevent repeat forward triggers.
329 #define GO_ENCODER_TRIGGER_MODE_IGNORE_REVERSE (1) ///< Do not reverse trigger. Forward trigger unconditionally.
330 #define GO_ENCODER_TRIGGER_MODE_BIDIRECTIONAL (2) ///< Forward and reverse trigger.
331 /** @} */
332 
333 /**
334  * @struct GoFrameRateMaxSource
335  * @extends kValue
336  * @ingroup GoSdk
337  * @brief Represents the current maximum frame rate limiting source.
338  *
339  * The following enumerators are defined:
340  * - #GO_FRAME_RATE_MAX_SOURCE_CAMERA
341  * - #GO_FRAME_RATE_MAX_SOURCE_PART_DETECTION
342  */
343 typedef k32s GoFrameRateMaxSource;
344 /** @name GoFrameRateMaxSource
345  *@{*/
346 #define GO_FRAME_RATE_MAX_SOURCE_CAMERA (0) ///< Limited by the sensor's camera configuration.
347 #define GO_FRAME_RATE_MAX_SOURCE_PART_DETECTION (1) ///< Limited by part detection logic.
348 /** @} */
349 
350 /**
351  * @struct GoEncoderSpacingMinSource
352  * @extends kValue
353  * @ingroup GoSdk
354  * @brief Represents the current encoder period limiting source.
355  *
356  * The following enumerators are defined:
357  * - #GO_ENCODER_PERIOD_MAX_SOURCE_RESOLUTION
358  * - #GO_ENCODER_PERIOD_MAX_SOURCE_PART_DETECTION
359  */
361 /** @name GoEncoderSpacingMinSource
362  *@{*/
363 #define GO_ENCODER_PERIOD_MAX_SOURCE_RESOLUTION (0) ///< Limited by encoder resolution.
364 #define GO_ENCODER_PERIOD_MAX_SOURCE_PART_DETECTION (1) ///< Limited by part detection logic.
365 /**@}*/
366 
367 /**
368  * @struct GoTriggerUnits
369  * @extends kValue
370  * @ingroup GoSdk
371  * @brief Represents the system's primary synchronization domain
372  *
373  * The following enumerators are defined:
374  * - #GO_TRIGGER_UNIT_TIME
375  * - #GO_TRIGGER_UNIT_ENCODER
376  */
377 typedef k32s GoTriggerUnits;
378 /** @name GoTriggerUnits
379  *@{*/
380 #define GO_TRIGGER_UNIT_TIME (0) ///< Base the system on the internal clock.
381 #define GO_TRIGGER_UNIT_ENCODER (1) ///< Base the system on the encoder.
382 /**@}*/
383 
384 /**
385  * @struct GoExposureMode
386  * @extends kValue
387  * @ingroup GoSdk
388  * @brief Represents all possible exposure modes.
389  *
390  * The following enumerators are defined:
391  * - #GO_EXPOSURE_MODE_SINGLE
392  * - #GO_EXPOSURE_MODE_MULTIPLE
393  * - #GO_EXPOSURE_MODE_DYNAMIC
394  */
395 typedef k32s GoExposureMode;
396 /** @name GoExposureMode
397  *@{*/
398 #define GO_EXPOSURE_MODE_SINGLE (0) ///< Single exposure mode.
399 #define GO_EXPOSURE_MODE_MULTIPLE (1) ///< Multiple exposure mode.
400 #define GO_EXPOSURE_MODE_DYNAMIC (2) ///< Dynamic exposure mode.
401 /**@}*/
402 
403 /**
404  * @struct GoPreFilterType
405  * @extends kValue
406  * @ingroup GoSdk
407  * @brief Represents a prefilter type.
408  *
409  * The following enumerators are defined:
410  * - #GO_PREFILTER_TYPE_BOX
411  * - #GO_PREFILTER_TYPE_GAUSSIAN
412  * - #GO_PREFILTER_TYPE_CUSTOM
413  */
414 typedef k32s GoPreFilterType;
415 /** @name GoPreFilterType
416  *@{*/
417 #define GO_PREFILTER_TYPE_BOX (0) ///< Box prefilter type (with fixed 3, 5, 9, 11 or 13 coefficient values).
418 #define GO_PREFILTER_TYPE_GAUSSIAN (1) ///< Gaussian prefilter type (with fixed 3, 5, 9, 11 or 13 coefficient values).
419 #define GO_PREFILTER_TYPE_CUSTOM (2) ///< Custom prefilter where user specifies up to GoPreFilterLengthOption prefilter coefficients.
420 /**@}*/
421 
422 /**
423  * @struct GoPreFilterLengthOption
424  * @extends kValue
425  * @ingroup GoSdk
426  * @brief Represents the choices of the filter length (ie. how many prefilter coefficients to use for the prefilter).
427  *
428  * The following enumerators are defined:
429  * - #GO_PREFILTER_LENGTH_OPTION_3
430  * - #GO_PREFILTER_LENGTH_OPTION_5
431  * - #GO_PREFILTER_LENGTH_OPTION_7
432  * - #GO_PREFILTER_LENGTH_OPTION_9
433  * - #GO_PREFILTER_LENGTH_OPTION_11
434  * - #GO_PREFILTER_LENGTH_OPTION_13
435  * - #GO_PREFILTER_LENGTH_OPTION_15
436  * - #GO_PREFILTER_LENGTH_OPTION_19
437  * - #GO_PREFILTER_LENGTH_OPTION_23
438  * - #GO_PREFILTER_LENGTH_OPTION_29
439  *
440  * Lengths 15-29 are only available on sensors with extended-length support.
441  */
443 /** @name GoPreFilterLengthOption
444  *@{*/
445 #define GO_PREFILTER_LENGTH_OPTION_3 (3) ///< Use a prefilter with 3 prefilter coefficients.
446 #define GO_PREFILTER_LENGTH_OPTION_5 (5) ///< Use a prefilter with 5 prefilter coefficients.
447 #define GO_PREFILTER_LENGTH_OPTION_7 (7) ///< Use a prefilter with 7 prefilter coefficients.
448 #define GO_PREFILTER_LENGTH_OPTION_9 (9) ///< Use a prefilter with 9 prefilter coefficients.
449 #define GO_PREFILTER_LENGTH_OPTION_11 (11) ///< Use a prefilter with 11 prefilter coefficients.
450 #define GO_PREFILTER_LENGTH_OPTION_13 (13) ///< Use a prefilter with 13 prefilter coefficients.
451 #define GO_PREFILTER_LENGTH_OPTION_15 (15) ///< Use a prefilter with 15 prefilter coefficients. Extended-length sensors only.
452 #define GO_PREFILTER_LENGTH_OPTION_19 (19) ///< Use a prefilter with 19 prefilter coefficients. Extended-length sensors only.
453 #define GO_PREFILTER_LENGTH_OPTION_23 (23) ///< Use a prefilter with 23 prefilter coefficients. Extended-length sensors only.
454 #define GO_PREFILTER_LENGTH_OPTION_29 (29) ///< Use a prefilter with 29 prefilter coefficients. Extended-length sensors only.
455  /**@}*/
456 
457 // VE-7244: Extended from 13 to 29 to accompany PL polyphase rescaling on extended-length sensors.
458 #define GO_PREFILTER_MAX_NUM_COEFF_IN_FILTER (GO_PREFILTER_LENGTH_OPTION_29) ///< Maximum number of coefficients a filter can have.
459 
460 /**
461  * @name GoPreFilterCoefficient
462  * @extends kValue
463  * @ingroup GoSdk
464  * @brief Represents a prefilter coefficient value type.
465  */
467 
468 /**
469  * @struct GoOrientation
470  * @extends kValue
471  * @ingroup GoSdk
472  * @brief Represents a sensor orientation type.
473  *
474  * The following enumerators are defined:
475  * - #GO_ORIENTATION_WIDE
476  * - #GO_ORIENTATION_OPPOSITE
477  * - #GO_ORIENTATION_REVERSE
478  */
479 typedef k32s GoOrientation;
480 /** @name GoOrientation
481  *@{*/
482 #define GO_ORIENTATION_WIDE (0) ///< Wide sensor orientation.
483 #define GO_ORIENTATION_OPPOSITE (1) ///< Opposite sensor orientation.
484 #define GO_ORIENTATION_REVERSE (2) ///< Reverse sensor orientation.
485 /**@}*/
486 
487 /**
488  * @struct GoInputSource
489  * @extends kValue
490  * @ingroup GoSdk
491  * @brief Represents a data input source.
492  *
493  * The following enumerators are defined:
494  * - #GO_INPUT_SOURCE_LIVE
495  * - #GO_INPUT_SOURCE_RECORDING
496  */
497 typedef k32s GoInputSource;
498 /** @name GoInputSource
499  *@{*/
500 #define GO_INPUT_SOURCE_LIVE (0) ///< The current data input source is from live sensor data.
501 #define GO_INPUT_SOURCE_RECORDING (1) ///< The current data source is from a replay.
502 /**@}*/
503 
504 /**
505  * @struct GoSeekDirection
506  * @extends kValue
507  * @ingroup GoSdk
508  * @brief Represents a playback seek direction.
509  *
510  * The following enumerators are defined:
511  * - #GO_SEEK_DIRECTION_FORWARD
512  * - #GO_SEEK_DIRECTION_BACKWARD
513  */
514 typedef k32s GoSeekDirection;
515 /** @name GoSeekDirection
516  *@{*/
517 #define GO_SEEK_DIRECTION_FORWARD (0) ///< Seek forward in the current replay.
518 #define GO_SEEK_DIRECTION_BACKWARD (1) ///< Seek backward in the current replay.
519 /**@}*/
520 
521 /**
522  * @struct GoDataSource
523  * @extends kValue
524  * @ingroup GoSdk
525  * @brief Represents a data source.
526  *
527  * The following enumerators are defined:
528  * #GO_DATA_SOURCE_NONE
529  * #GO_DATA_SOURCE_TOP
530  * #GO_DATA_SOURCE_BOTTOM
531  * #GO_DATA_SOURCE_TOP_LEFT
532  * #GO_DATA_SOURCE_TOP_RIGHT
533  * #GO_DATA_SOURCE_TOP_BOTTOM
534  * #GO_DATA_SOURCE_LEFT_RIGHT
535  * #GO_DATA_SOURCE_GRID_BASE
536  */
537 typedef k32s GoDataSource;
538 /** @name GoDataSource
539  *@{*/
540 #define GO_DATA_SOURCE_NONE (-1) ///< Used to represent a buddy device when the buddy is not connected
541 #define GO_DATA_SOURCE_TOP (0) ///< Represents main device when in a single sensor or opposite orientation buddy setup. Also represents the combined main and buddy in a wide or reverse orientation
542 #define GO_DATA_SOURCE_BOTTOM (1) ///< Represents the buddy device in an opposite orientation buddy configuration
543 #define GO_DATA_SOURCE_TOP_LEFT (2) ///< Represents the main device in a wide or reverse orientation buddy configuration
544 #define GO_DATA_SOURCE_TOP_RIGHT (3) ///< Represents the buddy device in a wide or reverse orientation buddy configuration
545 #define GO_DATA_SOURCE_TOP_BOTTOM (4) ///< Represents both the main and buddy devices in a opposite orientation
546 #define GO_DATA_SOURCE_LEFT_RIGHT (5) ///< Represents a buddy configuration where data from the two devices are not merged (e.g. buddied 1000 series sensors in a wide layout)
547 #define GO_DATA_SOURCE_GRID_BASE (100) ///< Used to represent a device in a buddy scenario by adding the device's index to this value to retrieve its data.
548  /**@}*/
549 
550 /**
551  * @struct GoSpacingIntervalType
552  * @extends kValue
553  * @ingroup GoSdk
554  * @brief Represents spacing interval types.
555  *
556  * The following enumerators are defined:
557  * - #GO_SPACING_INTERVAL_TYPE_MAX_RES
558  * - #GO_SPACING_INTERVAL_TYPE_BALANCED
559  * - #GO_SPACING_INTERVAL_TYPE_MAX_SPEED
560  */
562 /** @name GoSpacingIntervalType
563  *@{*/
564 #define GO_SPACING_INTERVAL_TYPE_MAX_RES (0) ///< Maximum resolution spacing interval type.
565 #define GO_SPACING_INTERVAL_TYPE_BALANCED (1) ///< Balanced spacing interval type.
566 #define GO_SPACING_INTERVAL_TYPE_MAX_SPEED (2) ///< Maximum speed spacing interval type.
567 #define GO_SPACING_INTERVAL_TYPE_CUSTOM (3) ///< The user specified custom interval.
568 /**@}*/
569 
570 /**
571  * @struct GoTriggerSource
572  * @extends kValue
573  * @ingroup GoSdk
574  * @brief Represents a trigger source type.
575  *
576  * The following enumerators are defined:
577  * - #GO_TRIGGER_SOURCE_TIME
578  * - #GO_TRIGGER_SOURCE_ENCODER
579  * - #GO_TRIGGER_SOURCE_INPUT
580  * - #GO_TRIGGER_SOURCE_SOFTWARE
581  */
582 typedef k32s GoTriggerSource;
583 /** @name GoTriggerSource
584  *@{*/
585 #define GO_TRIGGER_SOURCE_TIME (0) ///< Trigger on internal clock.
586 #define GO_TRIGGER_SOURCE_ENCODER (1) ///< Trigger on encoder.
587 #define GO_TRIGGER_SOURCE_INPUT (2) ///< Trigger on digital input.
588 #define GO_TRIGGER_SOURCE_SOFTWARE (3) ///< Trigger on software messages.
589 /**@}*/
590 
591 /**
592  * @struct GoAlignmentType
593  * @extends kValue
594  * @ingroup GoSdk
595  * @brief Represents an alignment type.
596  *
597  * The following enumerators are defined:
598  * - #GO_ALIGNMENT_TYPE_STATIONARY
599  * - #GO_ALIGNMENT_TYPE_MOVING
600  */
601 typedef k32s GoAlignmentType;
602 /** @name GoAlignmentType
603  *@{*/
604 #define GO_ALIGNMENT_TYPE_STATIONARY (0) ///< Stationary target alignment type.
605 #define GO_ALIGNMENT_TYPE_MOVING (1) ///< Moving target alignment type.
606 /**@}*/
607 
608 /**
609  * @struct GoAlignmentTarget
610  * @extends kValue
611  * @ingroup GoSdk
612  * @brief Represents an alignment target type.
613  *
614  * The following enumerators are defined:
615  * - #GO_ALIGNMENT_TARGET_NONE
616  * - #GO_ALIGNMENT_TARGET_DISK
617  * - #GO_ALIGNMENT_TARGET_BAR
618  * - #GO_ALIGNMENT_TARGET_PLATE
619  * - #GO_ALIGNMENT_TARGET_POLYGON
620  */
621 
622 typedef k32s GoAlignmentTarget;
623 /** @name GoAlignmentTarget
624  *@{*/
625 #define GO_ALIGNMENT_TARGET_NONE (0) ///< No calibration target.
626 #define GO_ALIGNMENT_TARGET_DISK (1) ///< Calibration disk.
627 #define GO_ALIGNMENT_TARGET_BAR (2) ///< Calibration bar.
628 #define GO_ALIGNMENT_TARGET_PLATE (3) ///< Calibration plate.
629 #define GO_ALIGNMENT_TARGET_POLYGON (5) ///< Calibration polygon.
630 /**@}*/
631 
632 
633 /**
634  * @struct GoAlignmentDegreesOfFreedom
635  * @extends kValue
636  * @ingroup GoSdk
637  * @brief Represents an alignment degree of freedom setting.
638  *
639  * The following enumerators are defined:
640  * - #GO_ALIGNMENT_DOF_NONE
641  * - #GO_ALIGNMENT_3DOF_XZ_Y
642  * - #GO_ALIGNMENT_4DOF_XYZ_Y
643  * - #GO_ALIGNMENT_5DOF_XYZ_YZ
644  * - #GO_ALIGNMENT_6DOF_XYZ_XYZ
645  */
647 /** @name GoAlignmentDegreesOfFreedom
648  * Enumerations are 6-bit bit masks representing (left to right) axis xyz followed by angles xyz
649  *@{*/
650 #define GO_ALIGNMENT_DOF_NONE (0x00) ///< No degrees of freedom selected.
651 #define GO_ALIGNMENT_3DOF_XZ_Y (0x2A) ///< 3 degrees of freedom: x,z angle y.
652 #define GO_ALIGNMENT_4DOF_XYZ_Y (0x3A) ///< 4 degrees of freedom: x,y,z angle y.
653 #define GO_ALIGNMENT_5DOF_XYZ_YZ (0x3B) ///< 5 degrees of freedom: x,y,z angles y,z.
654 #define GO_ALIGNMENT_6DOF_XYZ_XYZ (0x3F) ///< 6 degrees of freedom: x,y,z angles x,y,z.
655 /**@}*/
656 
657 /**
658  * @struct GoPolygonCornerParameters
659  * @extends kValue
660  * @ingroup GoSdk
661  * @brief Corner parameters for polygon corner alignment.
662  */
664 {
665  kPoint64f point;
666  kArrayList deviceIdxs; // of type k32u
668 
669 /**
670  * @struct GoReplayExportSourceType
671  * @extends kValue
672  * @ingroup GoSdk
673  * @brief Represents the replay export source type.
674  *
675  * The following enumerators are defined:
676  * - #GO_REPLAY_EXPORT_SOURCE_PRIMARY
677  * - #GO_REPLAY_EXPORT_SOURCE_INTENSITY
678  */
680 /** @name GoReplayExportSourceType
681  *@{*/
682 #define GO_REPLAY_EXPORT_SOURCE_PRIMARY (0) ///< Primary data (relevant to the current scan mode) replay export.
683 #define GO_REPLAY_EXPORT_SOURCE_INTENSITY (1) ///< Export intensity data using the scan data without regards to aspect ratio.
684 #define GO_REPLAY_EXPORT_SOURCE_INTENSITY_KEEP_ASPECT_RATIO (2) ///< Export intensity data, resizing data to maintain correct aspect ratio of the image.
685  /**@}*/
686 
687 /**
688  * @struct GoFamily
689  * @extends kValue
690  * @ingroup GoSdk
691  * @brief Represents the supported Gocator hardware families.
692  *
693  * The following enumerators are defined:
694  * - #GO_FAMILY_1000
695  * - #GO_FAMILY_2000
696  * - #GO_FAMILY_3000
697  * - #GO_FAMILY_6000
698  */
699 typedef k32s GoFamily;
700 /** @name GoFamily
701  *@{*/
702 #define GO_FAMILY_UNKNOWN (-1) ///< Unidentified sensor family.
703 #define GO_FAMILY_1000 (0) ///< 1x00 series sensors.
704 #define GO_FAMILY_2000 (1) ///< 2x00 series sensors.
705 #define GO_FAMILY_3000 (2) ///< 3x00 series sensors.
706 #define GO_FAMILY_6000 (5) ///< 6x00 series sensors.
707 /**@}*/
708 
709 /**
710  * @struct GoDecision
711  * @extends kValue
712  * @ingroup GoSdk
713  * @brief Represents the measurement output decision values. Bit 0 represents the decision value, while bits 1 through 7 represent the decision code, outlined by GoDecisionCode.
714  * @see GoDecisionCode
715  *
716  * The following enumerators are defined:
717  * - #GO_DECISION_FAIL
718  * - #GO_DECISION_PASS
719  */
720 typedef k8u GoDecision;
721 /** @name GoDecision
722  *@{*/
723 #define GO_DECISION_FAIL (0) ///< The measurement value is either valid and falls outside the defined passing decision range or is invalid. The failure error code can be used to determine whether the value was valid.
724 #define GO_DECISION_PASS (1) ///< The measurement value is valid and it falls within the defined passing decision range.
725 /**@}*/
726 
727 
728 /**
729  * @struct GoDecisionCode
730  * @extends kValue
731  * @ingroup GoSdk
732  * @brief Represents the possible measurement decision codes.
733  *
734  * The following enumerators are defined:
735  * - #GO_DECISION_CODE_OK
736  * - #GO_DECISION_CODE_INVALID_ANCHOR
737  * - #GO_DECISION_CODE_INVALID_VALUE
738  */
739 typedef k8u GoDecisionCode;
740 /** @name GoDecisionCode
741  *@{*/
742 #define GO_DECISION_CODE_OK (0) ///< The measurement value is valid and it falls outside the defined passing decision range.
743 #define GO_DECISION_CODE_INVALID_VALUE (1) ///< The measurement value is invalid.
744 #define GO_DECISION_CODE_INVALID_ANCHOR (2) ///< The tool associated with the measurement is anchored is has received invalid measurement data from its anchoring source(s).
745 /**@}*/
746 
747 /**
748 * @struct GoIntensitySource
749 * @extends kValue
750 * @ingroup GoSdk
751 * @brief Represents all possible sources of intensity data.
752 *
753 * The following enumerators are defined:
754 * - #GO_INTENSITY_SOURCE_BOTH
755 * - #GO_INTENSITY_SOURCE_FRONT
756 * - #GO_INTENSITY_SOURCE_BACK
757 */
758 typedef k32s GoIntensitySource;
759 /** @name GoIntensitySource
760 *@{*/
761 #define GO_INTENSITY_SOURCE_BOTH (0) ///< Intensity data based on both cameras.
762 #define GO_INTENSITY_SOURCE_FRONT (1) ///< Intensity data based on front camera.
763 #define GO_INTENSITY_SOURCE_BACK (2) ///< Intensity data based on back camera.
764 /**@}*/
765 
766 /**
767 * @struct GoIntensityMode
768 * @extends kValue
769 * @ingroup GoSdk
770 * @brief Represents all possible intensity generation modes for multiple exposures.
771 *
772 * The following enumerators are defined:
773 * - #GO_INTENSITY_MODE_AUTO
774 * - #GO_INTENSITY_MODE_PRESERVE_ORIGINAL
775 */
776 typedef k32s GoIntensityMode;
777 
778 /** @name GoIntensityMode
779 *@{*/
780 #define GO_INTENSITY_MODE_AUTO (0) ///< Automatically pick and scale the most reliable intensity data.
781 #define GO_INTENSITY_MODE_PRESERVE_ORIGINAL (1) ///< Preserve the original values as much as possible.
782 /**@}*/
783 
784 
785 /** @name GoSecurityLevel
786 *@{*/
787 typedef k32u GoSecurityLevel;
788 #define GO_SECURITY_NONE (0) ///< No security, any user type can access system.
789 #define GO_SECURITY_BASIC (1) ///< Basic security level, only authorized user types can access system.
790 /**@}*/
791 
792 #define GO_ERROR_AUTHENTICATION (-2001) ///< logged in user does not have required privileges to performed specific action
793 
794 /**
795 * @struct GoVoltageSetting
796 * @extends kValue
797 * @note Supported with G3
798 * @ingroup GoSdk
799 * @brief Represents either 48V or 24V (with cable length) operation.
800 * Only relevant on G3210
801 *
802 * The following enumerators are defined:
803 * - #GO_VOLTAGE_48
804 * - #GO_VOLTAGE_24
805 */
806 typedef k16u GoVoltageSetting;
807 /** @name GoVoltageSetting
808 *@{*/
809 #define GO_VOLTAGE_48 (0) ///< 48V (No Cable length input required)
810 #define GO_VOLTAGE_24 (1) ///< 24V (Cable Length required + projector dimming)
811 /**@}*/
812 
813 /**
814 * @struct GoBrandingType
815 * @extends kValue
816 * @ingroup GoSdk
817 * @brief Represents possible branding types (for brand customization schemes).
818 *
819 * The following enumerators are defined:
820 * - #GO_BRANDING_TYPE_LMI
821 * - #GO_BRANDING_TYPE_UNBRANDED
822 * - #GO_BRANDING_TYPE_CUSTOM
823 */
824 typedef k32s GoBrandingType;
825 #define GO_BRANDING_TYPE_LMI (0) ///< LMI brand displayed.
826 #define GO_BRANDING_TYPE_UNBRANDED (1) ///< White-label; no brand visible.
827 #define GO_BRANDING_TYPE_CUSTOM (2) ///< Custom branding applied.
828 /**@}*/
829 
830 /**
831  * @struct GoStates
832  * @extends kValue
833  * @ingroup GoSdk
834  * @brief Sensor state, login, alignment information, recording state, playback source, uptime, playback information, and auto-start setting state.
835  */
836 typedef struct GoStates
837 {
838  GoDeviceState sensorState; ///< The state of the sensor.
839  GoUser loginType; ///< The logged in user.
840  GoAlignmentRef alignmentReference; ///< The alignment reference of the sensor.
841  GoAlignmentState alignmentState; ///< The alignment state of the sensor.
842  kBool recordingEnabled; ///< The current state of recording on the sensor.
843  k32s playbackSource; ///< The current playback source of the sensor.
844  k32u uptimeSec; ///< Sensor uptime in seconds.
845  k32u uptimeMicrosec; ///< Sensor uptime in microseconds.
846  k32u playbackPos; ///< The playback position index.
847  k32u playbackCount; ///< The playback count.
848  kBool autoStartEnabled; ///< The auto-start enabled state.
849  kBool isAccelerator; ///< The accelerated state of the sensor.
850  GoVoltageSetting voltage; ///< Power Source Voltage: 24 or 48 V
851  k32u cableLength; ///< The length of the cable (in millimeters) from the Sensor to the Master.
852  kBool quickEditEnabled; ///< The current state of editing.
853  GoSecurityLevel security; ///< The security level setup on the sensor: none/basic; when basic level does not allow anonymous users accessing system.
854  GoBrandingType brandingType; ///< The branding type of the sensor; (for brand customization schemes).
855 } GoStates;
856 
857 /**
858  * @struct GoAddressInfo
859  * @extends kValue
860  * @ingroup GoSdk
861  * @brief Sensor network address settings.
862  */
863 typedef struct GoAddressInfo
864 {
865  kBool useDhcp; ///< Sensor uses DHCP?
866  kIpAddress address; ///< Sensor IP address.
867  kIpAddress mask; ///< Sensor subnet bit-mask.
868  kIpAddress gateway; ///< Sensor gateway address.
869 } GoAddressInfo;
870 
871 /**
872  * @struct GoPortInfo
873  * @extends kValue
874  * @ingroup GoSdk
875  * @brief Ports used from a source device.
876  */
877 typedef struct GoPortInfo
878 {
879  k16u controlPort; ///< Control channel port.
880  k16u upgradePort; ///< Upgrade channel port.
881  k16u webPort; ///< Web channel port.
882  k16u dataPort; ///< Data channel port.
883  k16u healthPort; ///< Health channel port.
884 } GoPortInfo;
885 
886 /**
887 * @struct GoBuddyInfo
888 * @extends kValue
889 * @ingroup GoSdk
890 * @brief Buddy related status of another sensor.
891 */
892 typedef struct GoBuddyInfo
893 {
894  k32u id; ///< Serial number of the device.
895  GoBuddyState state;///< Buddy state of this device.
896 } GoBuddyInfo;
897 
898 /**
899  * @struct GoElement64f
900  * @extends kValue
901  * @ingroup GoSdk
902  * @brief Represents a 64-bit floating point configuration element with a range and enabled state.
903  */
904 typedef struct GoElement64f
905 {
906  kBool enabled; ///< Represents whether the element value is currently used. (not always applicable)
907  k64f systemValue; ///< The system value. (not always applicable)
908  k64f value; ///< The element's double field value.
909  k64f max; ///< The maximum allowable value that can be set for this element.
910  k64f min; ///< The minimum allowable value that can be set for this element.
911 } GoElement64f;
912 
913 /**
914  * @struct GoElement32u
915  * @extends kValue
916  * @ingroup GoSdk
917  * @brief Represents a 32-bit unsigned integer configuration element with a range and enabled state.
918  */
919 typedef struct GoElement32u
920 {
921  kBool enabled; ///< Represents whether the element value is currently used.
922  k32u systemValue; ///< The system value. (not always applicable)
923  k32u value; ///< The element's 32-bit unsigned field value.
924  k32u max; ///< The maximum allowable value that can be set for this element.
925  k32u min; ///< The minimum allowable value that can be set for this element.
926 } GoElement32u;
927 
928 /**
929  * @struct GoElement32s
930  * @extends kValue
931  * @ingroup GoSdk
932  * @brief Represents a 32-bit signed integer configuration element with a range and enabled state.
933  */
934 typedef struct GoElement32s
935 {
936  kBool enabled; ///< Represents whether the element value is currently used.
937  k32s systemValue; ///< The system value. (not always applicable)
938  k32s value; ///< The element's 32-bit signed field value.
939  k32s max; ///< The maximum allowable value that can be set for this element.
940  k32s min; ///< The minimum allowable value that can be set for this element.
941 } GoElement32s;
942 
943 /**
944  * @struct GoElementBool
945  * @extends kValue
946  * @ingroup GoSdk
947  * @brief Represents a boolean configuration element with an enabled state.
948  */
949 typedef struct GoElementBool
950 {
951  kBool enabled; ///< Represents whether the element value is currently used.
952  kBool systemValue; ///< The system value. (not always applicable)
953  kBool value; ///< The element's boolean field value.
954 } GoElementBool;
955 
956 /**
957  * @struct GoFilter
958  * @extends kValue
959  * @ingroup GoSdk
960  * @brief Represents a filter configuration element.
961  */
962 typedef struct GoFilter
963 {
964  kBool used; ///< Represents whether the filter field is currently used.
965  GoElement64f value; ///< The filter's configuration properties
966 } GoFilter;
967 
968 /**
969  * @struct GoActiveAreaConfig
970  * @extends kValue
971  * @ingroup GoSdk
972  * @brief Represents an active area configuration element.
973  */
974 typedef struct GoActiveAreaConfig
975 {
976  GoElement64f x; ///< The X offset of the active area. (mm)
977  GoElement64f y; ///< The Y offset of the active area. (mm)
978  GoElement64f z; ///< The Z offset of the active area. (mm)
979  GoElement64f height; ///< The height of the active area. (mm)
980  GoElement64f length; ///< The length of the active area. (mm)
981  GoElement64f width; ///< The width of the active area. (mm)
983 
984 /**
985  * @struct GoTransformation
986  * @extends kValue
987  * @ingroup GoSdk
988  * @brief Represents an alignment element.
989  */
990 typedef struct GoTransformation
991 {
992  k64f x; ///< The X offset of the transformation. (mm)
993  k64f y; ///< The Y offset of the transformation. (mm)
994  k64f z; ///< The Z offset of the transformation. (mm)
995  k64f xAngle; ///< The X angle of the transformation. (degrees)
996  k64f yAngle; ///< The Y angle of the transformation. (degrees)
997  k64f zAngle; ///< The Z angle of the transformation. (degrees)
999 
1000 /**
1001  * @struct GoTransformedDataRegion
1002  * @extends kValue
1003  * @ingroup GoSdk
1004  * @brief Represents a transformed data region.
1005  */
1007 {
1008  k64f x; ///< The X offset of the transformed data region. (mm)
1009  k64f y; ///< The Y offset of the transformed data region. (mm)
1010  k64f z; ///< The Z offset of the transformed data region. (mm)
1011  k64f width; ///< The width of the transformed data region. (mm)
1012  k64f length; ///< The length of the transformed data region. (mm)
1013  k64f height; ///< The height of the transformed data region. (mm)
1015 
1016 /**
1017  * @struct GoOutputCompositeSource
1018  * @extends kValue
1019  * @ingroup GoSdk
1020  * @brief Represents a composite data source.
1021  */
1023 {
1024  k32s id; ///< The ID of the underlying data source.
1025  GoDataSource dataSource; ///< The data source of the composite data source.
1027 
1028 /**
1029  * @struct GoAsciiOperation
1030  * @extends kValue
1031  * @ingroup GoSdk-Output
1032  * @brief Represents an ASCII protocol operational type.
1033  *
1034  * The following enumerators are defined:
1035  * - #GO_ASCII_OPERATION_ASYNCHRONOUS
1036  * - #GO_ASCII_OPERATION_POLLING
1037  */
1038 typedef k32s GoAsciiOperation;
1039 /** @name GoAsciiOperation
1040  *@{*/
1041 #define GO_ASCII_OPERATION_ASYNCHRONOUS (0) ///< Selected measurement output will be sent upon sensor start.
1042 #define GO_ASCII_OPERATION_POLLING (1) ///< Measurement output will only be sent as requested.
1043 /**@}*/
1044 
1045 /**
1046  * @struct GoAsciiStandardFormatMode
1047  * @extends kValue
1048  * @ingroup GoSdk-Output
1049  * @brief Represents an ASCII standard format type.
1050  *
1051  * The following enumerators are defined:
1052  * - #GS_ASCII_FORMAT_MODE_MEAS
1053  * - #GS_ASCII_FORMAT_MODE_ENCODER_AND_FRAME
1054  */
1056 /** @name GoAsciiStandardFormatMode
1057  *@{*/
1058 #define GS_ASCII_FORMAT_MODE_MEAS (0) ///< Standard format will output with measurement values and decisions.
1059 #define GS_ASCII_FORMAT_MODE_ENCODER_AND_FRAME (1) ///< Standard format will output with Encoder and Frame, then measurement values and decisions.
1060 /**@}*/
1061 
1062 /**
1063  * @struct GoSelcomFormat
1064  * @extends kValue
1065  * @ingroup GoSdk-Serial
1066  * @brief Represents the selcom format followed on the serial output.
1067  *
1068  * The following enumerators are defined:
1069  * - #GO_SELCOM_FORMAT_SLS
1070  * - #GO_SELCOM_FORMAT_12BIT_ST
1071  * - #GO_SELCOM_FORMAT_14BIT
1072  * - #GO_SELCOM_FORMAT_14BIT_ST
1073  */
1074 typedef k32s GoSelcomFormat;
1075 /** @name GoSelcomFormat
1076  *@{*/
1077 #define GO_SELCOM_FORMAT_SLS (0) ///< Selcom uses the SLS format
1078 #define GO_SELCOM_FORMAT_12BIT_ST (1) ///< Selcom uses the 12-Bit Search/Track format
1079 #define GO_SELCOM_FORMAT_14BIT (2) ///< Selcom uses the 14-Bit format
1080 #define GO_SELCOM_FORMAT_14BIT_ST (3) ///< Selcom uses the 14-Bit Search/Track format
1081 /**@}*/
1082 
1083 /**
1084  * @struct GoSerialProtocol
1085  * @extends kValue
1086  * @ingroup GoSdk-Serial
1087  * @brief Represents all serial output protocols.
1088  *
1089  * The following enumerators are defined:
1090  * - #GO_SERIAL_PROTOCOL_GOCATOR
1091  * - #GO_SERIAL_PROTOCOL_SELCOM
1092  */
1093 typedef k32s GoSerialProtocol;
1094 /** @name GoSerialProtocol
1095  *@{*/
1096 #define GO_SERIAL_PROTOCOL_GOCATOR (0) ///< Gocator serial protocol.
1097 #define GO_SERIAL_PROTOCOL_SELCOM (1) ///< Selcom serial protocol.
1098 /**@}*/
1099 
1100 
1101 /**
1102  * @struct GoAnalogTrigger
1103  * @extends kValue
1104  * @ingroup GoSdk-Analog
1105  * @brief Represents an analog output trigger.
1106  *
1107  * The following enumerators are defined:
1108  * - #GO_ANALOG_TRIGGER_MEASUREMENT
1109  * - #GO_ANALOG_TRIGGER_SOFTWARE
1110  */
1111 typedef k32s GoAnalogTrigger;
1112 /** @name GoAnalogTrigger
1113  *@{*/
1114 #define GO_ANALOG_TRIGGER_MEASUREMENT (0) ///< Analog output triggered by measurement data.
1115 #define GO_ANALOG_TRIGGER_SOFTWARE (1) ///< Analog output triggered by software.
1116 /**@}*/
1117 
1118 /**
1119  * @struct GoDigitalPass
1120  * @extends kValue
1121  * @ingroup GoSdk-Digital
1122  * @brief Represents a digital output condition.
1123  *
1124  * The following enumerators are defined:
1125  * - #GO_DIGITAL_PASS_TRUE
1126  * - #GO_DIGITAL_PASS_FALSE
1127  * - #GO_DIGITAL_PASS_ALWAYS
1128  */
1129 typedef k32s GoDigitalPass;
1130 /** @name GoDigitalPass
1131  *@{*/
1132 #define GO_DIGITAL_PASS_TRUE (0) ///< Digital output triggers when all selected measurements pass.
1133 #define GO_DIGITAL_PASS_FALSE (1) ///< Digital output triggers when all selected measurements fail.
1134 #define GO_DIGITAL_PASS_ALWAYS (2) ///< Digital output triggers on every scan.
1135 /**@}*/
1136 
1137 /**
1138  * @struct GoDigitalSignal
1139  * @extends kValue
1140  * @ingroup GoSdk-Digital
1141  * @brief Represents a digital output signal type.
1142  *
1143  * The following enumerators are defined:
1144  * - #GO_DIGITAL_SIGNAL_PULSED
1145  * - #GO_DIGITAL_SIGNAL_CONTINUOUS
1146  */
1147 typedef k32s GoDigitalSignal;
1148 /** @name GoDigitalSignal
1149  *@{*/
1150 #define GO_DIGITAL_SIGNAL_PULSED (0) ///< Digital output is pulsed when triggered.
1151 #define GO_DIGITAL_SIGNAL_CONTINUOUS (1) ///< Digital output is continuous when triggered.
1152 /**@}*/
1153 
1154 /**
1155  * @struct GoDigitalEvent
1156  * @extends kValue
1157  * @ingroup GoSdk-Digital
1158  * @brief Represents a digital output event.
1159  *
1160  * The following enumerators are defined:
1161  * - #GO_DIGITAL_EVENT_MEASUREMENT
1162  * - #GO_DIGITAL_EVENT_SOFTWARE
1163  * - #GO_DIGITAL_EVENT_ALIGNMENT
1164  * - #GO_DIGITAL_EVENT_EXPOSURE_BEGIN
1165  * - #GO_DIGITAL_EVENT_EXPOSURE_END
1166  */
1167 typedef k32s GoDigitalEvent;
1168 /** @name GoDigitalEvent
1169  *@{*/
1170 #define GO_DIGITAL_EVENT_MEASUREMENT (1) ///< Digital output is triggered by measurement data.
1171 #define GO_DIGITAL_EVENT_SOFTWARE (2) ///< Digital output is triggered by software.
1172 #define GO_DIGITAL_EVENT_ALIGNMENT (3) ///< Digital output represents the alignment status.
1173 #define GO_DIGITAL_EVENT_EXPOSURE_BEGIN (4) ///< Digital output is triggered at the start of exposure.
1174 #define GO_DIGITAL_EVENT_EXPOSURE_END (5) ///< Digital output is triggered at the end of exposure, prior to processing.
1175 /**@}*/
1176 
1177 /**
1178  * @struct GoAnalogEvent
1179  * @extends kValue
1180  * @ingroup GoSdk-Analog
1181  * @brief Represents a analog output event.
1182  *
1183  * The following enumerators are defined:
1184  * - #GO_ANALOG_EVENT_MEASURMENT
1185  * - #GO_ANALOG_EVENT_SOFTWARE
1186  */
1187 typedef k32s GoAnalogEvent;
1188 /** @name GoAnalogEvent
1189  *@{*/
1190 #define GO_ANALOG_EVENT_MEASURMENT (1) ///< Analog output is triggered by measurement data.
1191 #define GO_ANALOG_EVENT_SOFTWARE (2) ///< Analog output is triggered by software.
1192 /**@}*/
1193 
1194 /**
1195  * @struct GoEthernetProtocol
1196  * @extends kValue
1197  * @ingroup GoSdk-Ethernet
1198  * @brief Represents a ethernet output protocol.
1199  *
1200  * The following enumerators are defined:
1201  * - #GO_ETHERNET_PROTOCOL_GOCATOR
1202  * - #GO_ETHERNET_PROTOCOL_MODBUS
1203  * - #GO_ETHERNET_PROTOCOL_ETHERNET_IP
1204  * - #GO_ETHERNET_PROTOCOL_ASCII
1205  * - #GO_ETHERNET_PROTOCOL_PROFINET
1206  * - #GO_ETHERNET_PROTOCOL_PTP
1207  */
1208 typedef k32s GoEthernetProtocol;
1209 /** @name GoEthernetProtocol
1210  *@{*/
1211 #define GO_ETHERNET_PROTOCOL_GOCATOR (0) ///< Gocator ethernet protocol.
1212 #define GO_ETHERNET_PROTOCOL_MODBUS (1) ///< Modbus ethernet protocol.
1213 #define GO_ETHERNET_PROTOCOL_ETHERNET_IP (2) ///< EthernetIP ethernet protocol.
1214 #define GO_ETHERNET_PROTOCOL_ASCII (3) ///< ASCII ethernet protocol.
1215 #define GO_ETHERNET_PROTOCOL_PROFINET (4) ///< Profinet ethernet protocol.
1216 #define GO_ETHERNET_PROTOCOL_PTP (5) ///< PTP protocol.
1217 
1218  /**@}*/
1219 
1220 
1221 /**
1222  * @struct GoEndianType
1223  * @extends kValue
1224  * @ingroup GoSdk-Ethernet
1225  * @brief Represents an endian output type.
1226  *
1227  * The following enumerators are defined:
1228  * - #GO_ENDIAN_TYPE_BIG
1229  * - #GO_ENDIAN_TYPE_LITTLE
1230  */
1231 typedef k32s GoEndianType;
1232 /** @name GoEndianType
1233  *@{*/
1234 #define GO_ENDIAN_TYPE_BIG (0) ///< Big Endian output.
1235 #define GO_ENDIAN_TYPE_LITTLE (1) ///< Little Endian output.
1236 /**@}*/
1237 
1238 
1239 /**
1240  * @struct GoOutputSource
1241  * @extends kValue
1242  * @ingroup GoSdk-Output
1243  * @brief Represents output sources.
1244  *
1245  * The following enumerators are defined:
1246  * - #GO_OUTPUT_SOURCE_NONE
1247  * - #GO_OUTPUT_SOURCE_VIDEO
1248  * - #GO_OUTPUT_SOURCE_RANGE
1249  * - #GO_OUTPUT_SOURCE_PROFILE
1250  * - #GO_OUTPUT_SOURCE_SURFACE
1251  * - #GO_OUTPUT_SOURCE_SECTION
1252  * - #GO_OUTPUT_SOURCE_RANGE_INTENSITY
1253  * - #GO_OUTPUT_SOURCE_PROFILE_INTENSITY
1254  * - #GO_OUTPUT_SOURCE_SURFACE_INTENSITY
1255  * - #GO_OUTPUT_SOURCE_SECTION_INTENSITY
1256  * - #GO_OUTPUT_SOURCE_MEASUREMENT
1257  * - #GO_OUTPUT_SOURCE_TRACHEID
1258  */
1259 typedef k32s GoOutputSource;
1260 /** @name GoOutputSource
1261  *@{*/
1262 #define GO_OUTPUT_SOURCE_NONE (0) ///< Unknown output source.
1263 #define GO_OUTPUT_SOURCE_VIDEO (1) ///< Output video data.
1264 #define GO_OUTPUT_SOURCE_RANGE (2) ///< Output range data.
1265 #define GO_OUTPUT_SOURCE_PROFILE (3) ///< Output profile data.
1266 #define GO_OUTPUT_SOURCE_SURFACE (4) ///< Output surface data.
1267 #define GO_OUTPUT_SOURCE_RANGE_INTENSITY (5) ///< Output range intensity data.
1268 #define GO_OUTPUT_SOURCE_PROFILE_INTENSITY (6) ///< Output profile intensity data.
1269 #define GO_OUTPUT_SOURCE_SURFACE_INTENSITY (7) ///< Output surface intensity data.
1270 #define GO_OUTPUT_SOURCE_MEASUREMENT (8) ///< Output measurement data.
1271 #define GO_OUTPUT_SOURCE_SECTION (9) ///< Output section data.
1272 #define GO_OUTPUT_SOURCE_SECTION_INTENSITY (10) ///< Output section intensity data.
1273 #define GO_OUTPUT_SOURCE_TRACHEID (11) ///< Output tracheid data.
1274 #define GO_OUTPUT_SOURCE_EVENT (12) ///< Output event data.
1275 #define GO_OUTPUT_SOURCE_FEATURE (13) ///< Output feature data.
1276 #define GO_OUTPUT_SOURCE_TOOLDATA (14) ///< Output tool data.
1277  /**@}*/
1278 
1279 /**
1280  * @struct GoDataStep
1281  * @extends kValue
1282  * @ingroup GoSdk-Tools
1283  * @brief Represents possible data streams.
1284  *
1285  * The following enumerators are defined:
1286  * - #GO_DATA_STEP_NONE
1287  * - #GO_DATA_STEP_VIDEO
1288  * - #GO_DATA_STEP_RANGE
1289  * - #GO_DATA_STEP_PROFILE
1290  * - #GO_DATA_STEP_SURFACE
1291  * - #GO_DATA_STEP_SECTION
1292  * - #GO_DATA_STEP_PROFILE_RAW
1293  * - #GO_DATA_STEP_SURFACE_RAW
1294  * - #GO_DATA_STEP_TRACHEID
1295  * - #GO_DATA_STEP_TOOLDATA_OUTPUTS
1296  * - #GO_DATA_STEP_PROFILE_UNMERGED_HDR
1297  * - #GO_DATA_STEP_SURFACE_ORIGINAL
1298  */
1299 typedef k32s GoDataStep;
1300 /** @name GoDataStep
1301  *@{*/
1302 #define GO_DATA_STEP_NONE (-1) ///< Indicates that no specific stream has been specified.
1303 #define GO_DATA_STEP_VIDEO (0) ///< Video data stream.
1304 #define GO_DATA_STEP_RANGE (1) ///< Range data stream.
1305 #define GO_DATA_STEP_PROFILE (2) ///< Profile data stream.
1306 #define GO_DATA_STEP_SURFACE (3) ///< Surface data stream.
1307 #define GO_DATA_STEP_SECTION (4) ///< Section data stream.
1308 #define GO_DATA_STEP_PROFILE_RAW (5) ///< Raw profile data stream.
1309 #define GO_DATA_STEP_SURFACE_RAW (6) ///< Raw surface data stream.
1310 #define GO_DATA_STEP_TRACHEID (7) ///< Tracheid data stream.
1311 #define GO_DATA_STEP_TOOLDATA_OUTPUTS (8) ///< Tool Data Output data stream.
1312 #define GO_DATA_STEP_PROFILE_UNMERGED_HDR (9) ///< Unmerged profile data stream.
1313 #define GO_DATA_STEP_SURFACE_ORIGINAL (11) ///< Original surface data stream.
1314 
1315  /**@}*/
1316 
1317 
1318 /**
1319  * @struct GoDataStream
1320  * @extends kValue
1321  * @ingroup GoSdk-Output
1322  * @brief Represents a data stream which consists of a data step and ID.
1323  */
1324 typedef struct GoDataStream
1325 {
1326  GoDataStep step;
1327  k32s id;
1328 } GoDataStream;
1329 
1330 /**
1331  * @struct GoDataStreamId
1332  * @extends kValue
1333  * @ingroup GoSdk-ExtTool
1334  * @brief Represents a data stream id which consists of a data step, step id and source id.
1335  */
1336 typedef struct GoDataStreamId
1337 {
1338  k32s step;
1339  k32s id;
1340  k32s source;
1341 } GoDataStreamId;
1342 
1343 /**
1344  * @struct GoOutputDelayDomain
1345  * @extends kValue
1346  * @ingroup GoSdk-Output
1347  * @brief Represents an output delay domain.
1348  *
1349  * The following enumerators are defined:
1350  * - #GO_OUTPUT_DELAY_DOMAIN_TIME
1351  * - #GO_OUTPUT_DELAY_DOMAIN_ENCODER
1352  */
1353 typedef k32s GoOutputDelayDomain;
1354 /** @name GoOutputDelayDomain
1355  *@{*/
1356 #define GO_OUTPUT_DELAY_DOMAIN_TIME (0) ///< Time(uS) based delay domain.
1357 #define GO_OUTPUT_DELAY_DOMAIN_ENCODER (1) ///< Encoder tick delay domain.
1358 /**@}*/
1359 
1360 /**
1361  * @struct GoPixelType
1362  * @extends kValue
1363  * @ingroup GoSdk
1364  * @brief Represents a video message pixel type.
1365  *
1366  * The following enumerators are defined:
1367  * - #GO_PIXEL_TYPE_8U
1368  * - #GO_PIXEL_TYPE_RGB
1369  */
1370 typedef k32s GoPixelType;
1371 /** @name GoPixelType
1372  *@{*/
1373 #define GO_PIXEL_TYPE_UNKNOWN (-1)
1374 #define GO_PIXEL_TYPE_8U (0) ///< Each pixel is represented as unsigned 8-bit values.
1375 #define GO_PIXEL_TYPE_RGB (1) ///< Each pixel is represented as three unsigned 8-bit values.
1376 /**@}*/
1377 
1378 /**
1379  * @struct GoToolType
1380  * @extends kValue
1381  * @ingroup GoSdk-Tools
1382  * @brief Lists all tool types.
1383  *
1384  * The following enumerators are defined:
1385  * - #GO_TOOL_UNKNOWN
1386  * - #GO_TOOL_RANGE_POSITION
1387  * - #GO_TOOL_RANGE_THICKNESS
1388  * - #GO_TOOL_PROFILE_AREA
1389  * - #GO_TOOL_PROFILE_BOUNDING_BOX
1390  * - #GO_TOOL_PROFILE_BRIDGE_VALUE
1391  * - #GO_TOOL_PROFILE_CIRCLE
1392  * - #GO_TOOL_PROFILE_DIMENSION
1393  * - #GO_TOOL_PROFILE_GROOVE
1394  * - #GO_TOOL_PROFILE_INTERSECT
1395  * - #GO_TOOL_PROFILE_LINE
1396  * - #GO_TOOL_PROFILE_PANEL
1397  * - #GO_TOOL_PROFILE_POSITION
1398  * - #GO_TOOL_PROFILE_STRIP
1399  * - #GO_TOOL_PROFILE_X_LINE
1400  * - #GO_TOOL_SURFACE_BOUNDING_BOX
1401  * - #GO_TOOL_SURFACE_COUNTERSUNK_HOLE
1402  * - #GO_TOOL_SURFACE_ELLIPSE
1403  * - #GO_TOOL_SURFACE_HOLE
1404  * - #GO_TOOL_SURFACE_OPENING
1405  * - #GO_TOOL_SURFACE_PLANE
1406  * - #GO_TOOL_SURFACE_POSITION
1407  * - #GO_TOOL_SURFACE_STUD
1408  * - #GO_TOOL_SURFACE_VOLUME
1409  * - #GO_TOOL_SCRIPT
1410  */
1411 typedef k32s GoToolType;
1412 /** @name GoToolType
1413  *@{*/
1414 #define GO_TOOL_UNKNOWN (-1) ///< Unknown tool.
1415 #define GO_TOOL_RANGE_POSITION (0) ///< Range Position tool.
1416 #define GO_TOOL_RANGE_THICKNESS (1) ///< Range Thickness tool.
1417 #define GO_TOOL_PROFILE_AREA (2) ///< Profile Area tool.
1418 #define GO_TOOL_PROFILE_BOUNDING_BOX (21) ///< Profile Bounding Box tool.
1419 #define GO_TOOL_PROFILE_BRIDGE_VALUE (24) ///< Profile Bridge Value tool.
1420 #define GO_TOOL_PROFILE_CIRCLE (3) ///< Profile Circle tool.
1421 #define GO_TOOL_PROFILE_DIMENSION (4) ///< Profile Dimension tool.
1422 #define GO_TOOL_PROFILE_GROOVE (5) ///< Profile Groove tool.
1423 #define GO_TOOL_PROFILE_INTERSECT (6) ///< Profile Intersect tool.
1424 #define GO_TOOL_PROFILE_LINE (7) ///< Profile Line tool.
1425 #define GO_TOOL_PROFILE_PANEL (8) ///< Profile Panel tool.
1426 #define GO_TOOL_PROFILE_POSITION (9) ///< Profile Position tool.
1427 #define GO_TOOL_PROFILE_STRIP (10) ///< Profile Strip tool.
1428 #define GO_TOOL_PROFILE_X_LINE (23) ///< Profile X-Line tool.
1429 #define GO_TOOL_SURFACE_BOUNDING_BOX (11) ///< Surface Bounding Box tool.
1430 #define GO_TOOL_SURFACE_COUNTERSUNK_HOLE (20) ///< Surface Countersunk Hole tool.
1431 #define GO_TOOL_SURFACE_DIMENSION (25) ///< Surface Dimension tool.
1432 #define GO_TOOL_SURFACE_ELLIPSE (12) ///< Surface Ellipse tool.
1433 #define GO_TOOL_SURFACE_HOLE (13) ///< Surface Hole tool.
1434 #define GO_TOOL_SURFACE_OPENING (14) ///< Surface Opening tool.
1435 #define GO_TOOL_SURFACE_PLANE (15) ///< Surface Plane tool.
1436 #define GO_TOOL_SURFACE_POSITION (16) ///< Surface Position tool.
1437 #define GO_TOOL_SURFACE_RIVET (22) ///< Surface Rivet tool.
1438 #define GO_TOOL_SURFACE_STUD (17) ///< Surface Stud tool.
1439 #define GO_TOOL_SURFACE_VOLUME (18) ///< Surface Volume tool.
1440 #define GO_TOOL_SCRIPT (19) ///< Script tool.
1441 #define GO_TOOL_PROFILE_ROUND_CORNER (26) ///< Profile Round Corner tool.
1442 
1443 #define GO_TOOL_EXTENSIBLE (1000)
1444 #define GO_TOOL_TOOL (1001)
1445 /**@}*/
1446 
1447 /**
1448 * @struct GoDataType
1449 * @extends kValue
1450 * @ingroup GoSdk-Tools
1451 * @brief Represents data source selections. Used as a bitmask.
1452 */
1453 typedef k32s GoDataType;
1454 /** @name GoDataType
1455 *@{*/
1456 #define GO_DATA_TYPE_NONE (0x1) ///< None.
1457 #define GO_DATA_TYPE_RANGE (0x2) ///< Range data.
1458 #define GO_DATA_TYPE_UNIFORM_PROFILE (0x3) ///< Uniformly-spaced (resampled) profile data.
1459 #define GO_DATA_TYPE_PROFILE_POINT_CLOUD (0x4) ///< Unresampled profile data.
1460 #define GO_DATA_TYPE_UNIFORM_SURFACE (0x5) ///< Uniformly-spaced height map.
1461 #define GO_DATA_TYPE_SURFACE_POINT_CLOUD (0x6) ///< Unresampled point cloud.
1462 #define GO_DATA_TYPE_UNMERGED_PROFILE_POINT_CLOUD (0x7) ///< Unmerged raw profile data. Reserved for future use.
1463 #define GO_DATA_TYPE_VIDEO (0x8) ///< Video data.
1464 #define GO_DATA_TYPE_TRACHEID (0x9) ///< Tracheid data. Reserved for internal use.
1465 #define GO_DATA_TYPE_MEASUREMENT (0xA) ///< Measurement data.
1466 #define GO_DATA_TYPE_MESH (0xB) ///< Mesh data.
1467 
1468 #define GO_DATA_TYPE_FEATURES_ONLY (0x200) ///< Geometric features only. No scan data.
1469 #define GO_DATA_TYPE_GENERIC_BASE (0x80000000) ///< Generic data start id value.
1470 #define GO_DATA_TYPE_GENERIC_END (0xFFFFFFFF) ///< Generic data last id value.
1471 
1472 #define GO_DATA_TYPE_RAW_PROFILE (GO_DATA_TYPE_PROFILE_POINT_CLOUD) ///< Unresampled profile data. (Deprecated)
1473 #define GO_DATA_TYPE_RAW_SURFACE (GO_DATA_TYPE_SURFACE_POINT_CLOUD) ///< Unresampled point cloud. (Deprecated)
1474 #define GO_DATA_TYPE_UNMERGED_RAW_PROFILE (GO_DATA_TYPE_UNMERGED_PROFILE_POINT_CLOUD) ///< Unmerged raw profile data. (Deprecated)
1475 /**@}*/
1476 
1477 /**
1478 * @struct GoFeatureDataType
1479 * @extends kValue
1480 * @ingroup GoSdk-Tools
1481 * @brief Lists all feature data types.
1482 *
1483 * The following enumerators are defined:
1484 * - #GO_FEATURE_DATA_UNKNOWN
1485 * - #GO_FEATURE_DATA_POINT
1486 * - #GO_FEATURE_DATA_LINE
1487 * - #GO_FEATURE_DATA_CIRCLE
1488 * - #GO_FEATURE_DATA_PLANE
1489 */
1490 typedef k32s GoFeatureDataType;
1491 /** @name GoFeatureDataType
1492 *@{*/
1493 #define GO_FEATURE_DATA_UNKNOWN (-1) ///< Unknown feature.
1494 #define GO_FEATURE_DATA_POINT (0) ///< Point feature.
1495 #define GO_FEATURE_DATA_LINE (1) ///< Linear feature.
1496 #define GO_FEATURE_DATA_CIRCLE (2) ///< Circular feature.
1497 #define GO_FEATURE_DATA_PLANE (3) ///< Planar feature.
1498 /**@}*/
1499 
1500 /**
1501 * @struct GoFeatureType
1502 * @extends kValue
1503 * @ingroup GoSdk-Tools
1504 * @brief Lists all feature types.
1505 *
1506 * The following enumerators are defined:
1507 * - #GO_FEATURE_UNKNOWN
1508 * - #GO_FEATURE_EXTENSIBLE
1509 */
1510 typedef k32s GoFeatureType;
1511 /** @name GoFeatureType
1512 *@{*/
1513 #define GO_FEATURE_UNKNOWN (-1) ///< Unknown feature.
1514 #define GO_FEATURE_EXTENSIBLE (0) ///< Extensible feature.
1515 /**@}*/
1516 
1517 
1518 /**
1519  * @struct GoMeasurementType
1520  * @extends kValue
1521  * @ingroup GoSdk-Tools
1522  * @brief Lists all measurement types.
1523  *
1524  * The following enumerators are defined:
1525  * - #GO_MEASUREMENT_UNKNOWN
1526  * - #GO_MEASUREMENT_RANGE_POSITION_Z
1527  * - #GO_MEASUREMENT_RANGE_THICKNESS_THICKNESS
1528  * - #GO_MEASUREMENT_PROFILE_AREA_AREA
1529  * - #GO_MEASUREMENT_PROFILE_AREA_CENTROID_X
1530  * - #GO_MEASUREMENT_PROFILE_AREA_CENTROID_Z
1531  * - #GO_MEASUREMENT_PROFILE_BOUNDING_BOX_X
1532  * - #GO_MEASUREMENT_PROFILE_BOUNDING_BOX_Z
1533  * - #GO_MEASUREMENT_PROFILE_BOUNDING_BOX_HEIGHT
1534  * - #GO_MEASUREMENT_PROFILE_BOUNDING_BOX_WIDTH
1535  * - #GO_MEASUREMENT_PROFILE_BOUNDING_BOX_GLOBAL_X
1536  * - #GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_ANGLE
1537  * - #GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_BRIDGE_VALUE
1538  * - #GO_MEASUREMENT_PROFILE_CIRCLE_X
1539  * - #GO_MEASUREMENT_PROFILE_CIRCLE_Z
1540  * - #GO_MEASUREMENT_PROFILE_CIRCLE_RADIUS
1541  * - #GO_MEASUREMENT_PROFILE_CIRCLE_STDDEV
1542  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR
1543  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR_X
1544  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR_Z
1545  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR
1546  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR_X
1547  * - #GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR_Z
1548  * - #GO_MEASUREMENT_PROFILE_DIMENSION_WIDTH
1549  * - #GO_MEASUREMENT_PROFILE_DIMENSION_HEIGHT
1550  * - #GO_MEASUREMENT_PROFILE_DIMENSION_DISTANCE
1551  * - #GO_MEASUREMENT_PROFILE_DIMENSION_CENTER_X
1552  * - #GO_MEASUREMENT_PROFILE_DIMENSION_CENTER_Z
1553  * - #GO_MEASUREMENT_PROFILE_GROOVE_X
1554  * - #GO_MEASUREMENT_PROFILE_GROOVE_Z
1555  * - #GO_MEASUREMENT_PROFILE_GROOVE_WIDTH
1556  * - #GO_MEASUREMENT_PROFILE_GROOVE_DEPTH
1557  * - #GO_MEASUREMENT_PROFILE_INTERSECT_X
1558  * - #GO_MEASUREMENT_PROFILE_INTERSECT_Z
1559  * - #GO_MEASUREMENT_PROFILE_INTERSECT_ANGLE
1560  * - #GO_MEASUREMENT_PROFILE_LINE_STDDEV
1561  * - #GO_MEASUREMENT_PROFILE_LINE_ERROR_MIN
1562  * - #GO_MEASUREMENT_PROFILE_LINE_ERROR_MAX
1563  * - #GO_MEASUREMENT_PROFILE_LINE_PERCENTILE
1564  * - #GO_MEASUREMENT_PROFILE_PANEL_GAP
1565  * - #GO_MEASUREMENT_PROFILE_PANEL_FLUSH
1566  * - #GO_MEASUREMENT_PROFILE_PANEL_LEFT_GAP_X
1567  * - #GO_MEASUREMENT_PROFILE_PANEL_LEFT_GAP_Z
1568  * - #GO_MEASUREMENT_PROFILE_PANEL_LEFT_FLUSH_X
1569  * - #GO_MEASUREMENT_PROFILE_PANEL_LEFT_FLUSH_Z
1570  * - #GO_MEASUREMENT_PROFILE_PANEL_LEFT_SURFACE_ANGLE
1571  * - #GO_MEASUREMENT_PROFILE_PANEL_RIGHT_GAP_X
1572  * - #GO_MEASUREMENT_PROFILE_PANEL_RIGHT_GAP_Z
1573  * - #GO_MEASUREMENT_PROFILE_PANEL_RIGHT_FLUSH_X
1574  * - #GO_MEASUREMENT_PROFILE_PANEL_RIGHT_FLUSH_Z
1575  * - #GO_MEASUREMENT_PROFILE_PANEL_RIGHT_SURFACE_ANGLE
1576  * - #GO_MEASUREMENT_PROFILE_POSITION_X
1577  * - #GO_MEASUREMENT_PROFILE_POSITION_Z
1578  * - #GO_MEASUREMENT_PROFILE_STRIP_POSITION_X
1579  * - #GO_MEASUREMENT_PROFILE_STRIP_POSITION_Z
1580  * - #GO_MEASUREMENT_PROFILE_STRIP_WIDTH
1581  * - #GO_MEASUREMENT_PROFILE_STRIP_HEIGHT
1582  * - #GO_MEASUREMENT_PROFILE_X_LINE_Z
1583  * - #GO_MEASUREMENT_PROFILE_X_LINE_VALIDITY
1584  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_X
1585  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_Y
1586  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_Z
1587  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_ZANGLE
1588  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_HEIGHT
1589  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_WIDTH
1590  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_LENGTH
1591  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_X
1592  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_Y
1593  * - #GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_Z_ANGLE
1594  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_X
1595  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Y
1596  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Z
1597  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_OUTER_RADIUS
1598  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_DEPTH
1599  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_BEVEL_RADIUS
1600  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_BEVEL_ANGLE
1601  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_X_ANGLE
1602  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Y_ANGLE
1603  * - #GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_COUNTERBORE_DEPTH
1604  * - #GO_MEASUREMENT_SURFACE_DIMENSION_WIDTH
1605  * - #GO_MEASUREMENT_SURFACE_DIMENSION_HEIGHT
1606  * - #GO_MEASUREMENT_SURFACE_DIMENSION_LENGTH
1607  * - #GO_MEASUREMENT_SURFACE_DIMENSION_DISTANCE
1608  * - #GO_MEASUREMENT_SURFACE_DIMENSION_PLANE_DISTANCE
1609  * - #GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_X
1610  * - #GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_Y
1611  * - #GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_Z
1612  * - #GO_MEASUREMENT_SURFACE_ELLIPSE_MAJOR
1613  * - #GO_MEASUREMENT_SURFACE_ELLIPSE_MINOR
1614  * - #GO_MEASUREMENT_SURFACE_ELLIPSE_RATIO
1615  * - #GO_MEASUREMENT_SURFACE_ELLIPSE_ZANGLE
1616  * - #GO_MEASUREMENT_SURFACE_HOLE_X
1617  * - #GO_MEASUREMENT_SURFACE_HOLE_Y
1618  * - #GO_MEASUREMENT_SURFACE_HOLE_Z
1619  * - #GO_MEASUREMENT_SURFACE_HOLE_RADIUS
1620  * - #GO_MEASUREMENT_SURFACE_OPENING_X
1621  * - #GO_MEASUREMENT_SURFACE_OPENING_Y
1622  * - #GO_MEASUREMENT_SURFACE_OPENING_Z
1623  * - #GO_MEASUREMENT_SURFACE_OPENING_WIDTH
1624  * - #GO_MEASUREMENT_SURFACE_OPENING_LENGTH
1625  * - #GO_MEASUREMENT_SURFACE_OPENING_ANGLE
1626  * - #GO_MEASUREMENT_SURFACE_PLANE_X_ANGLE
1627  * - #GO_MEASUREMENT_SURFACE_PLANE_Y_ANGLE
1628  * - #GO_MEASUREMENT_SURFACE_PLANE_Z_OFFSET
1629  * - #GO_MEASUREMENT_SURFACE_PLANE_STD_DEV
1630  * - #GO_MEASUREMENT_SURFACE_PLANE_ERROR_MIN
1631  * - #GO_MEASUREMENT_SURFACE_PLANE_ERROR_MAX
1632  * - #GO_MEASUREMENT_SURFACE_PLANE_X_NORMAL
1633  * - #GO_MEASUREMENT_SURFACE_PLANE_Y_NORMAL
1634  * - #GO_MEASUREMENT_SURFACE_PLANE_Z_NORMAL
1635  * - #GO_MEASUREMENT_SURFACE_PLANE_DISTANCE
1636  * - #GO_MEASUREMENT_SURFACE_POSITION_X
1637  * - #GO_MEASUREMENT_SURFACE_POSITION_Y
1638  * - #GO_MEASUREMENT_SURFACE_POSITION_Z
1639  * - #GO_MEASUREMENT_SURFACE_RIVET_X
1640  * - #GO_MEASUREMENT_SURFACE_RIVET_Y
1641  * - #GO_MEASUREMENT_SURFACE_RIVET_Z
1642  * - #GO_MEASUREMENT_SURFACE_RIVET_TILT_ANGLE
1643  * - #GO_MEASUREMENT_SURFACE_RIVET_TILT_DIRECTION
1644  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIUS
1645  * - #GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MIN
1646  * - #GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MAX
1647  * - #GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MEAN
1648  * - #GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_STD_DEV
1649  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MIN
1650  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MAX
1651  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MEAN
1652  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_STD_DEV
1653  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MIN
1654  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MAX
1655  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MEAN
1656  * - #GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_STD_DEV
1657  * - #GO_MEASUREMENT_SURFACE_STUD_BASE_X
1658  * - #GO_MEASUREMENT_SURFACE_STUD_BASE_Y
1659  * - #GO_MEASUREMENT_SURFACE_STUD_BASE_Z
1660  * - #GO_MEASUREMENT_SURFACE_STUD_TIP_X
1661  * - #GO_MEASUREMENT_SURFACE_STUD_TIP_Y
1662  * - #GO_MEASUREMENT_SURFACE_STUD_TIP_Z
1663  * - #GO_MEASUREMENT_SURFACE_STUD_RADIUS
1664  * - #GO_MEASUREMENT_SURFACE_VOLUME_AREA
1665  * - #GO_MEASUREMENT_SURFACE_VOLUME_VOLUME
1666  * - #GO_MEASUREMENT_SURFACE_VOLUME_THICKNESS
1667  * - #GO_MEASUREMENT_SCRIPT_OUTPUT
1668  */
1669 typedef k32s GoMeasurementType;
1670 /** @name GoMeasurementType
1671  *@{*/
1672 #define GO_MEASUREMENT_UNKNOWN (-1) ///< Unknown measurement.
1673 #define GO_MEASUREMENT_RANGE_POSITION_Z (0) ///< Range Position tool Z measurement.
1674 #define GO_MEASUREMENT_RANGE_THICKNESS_THICKNESS (1) ///< Range Thickness tool Thickness measurement.
1675 #define GO_MEASUREMENT_PROFILE_AREA_AREA (2) ///< Profile Area tool Area measurement.
1676 #define GO_MEASUREMENT_PROFILE_AREA_CENTROID_X (3) ///< Profile Area tool Centroid X measurement.
1677 #define GO_MEASUREMENT_PROFILE_AREA_CENTROID_Z (4) ///< Profile Area tool Centroid Z measurement.
1678 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_X (82) ///< Profile Bounding Box X measurement.
1679 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_Z (83) ///< Profile Bounding Box Z measurement.
1680 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_HEIGHT (84) ///< Profile Bounding Box Height measurement.
1681 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_WIDTH (85) ///< Profile Bounding Box Width measurement.
1682 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_GLOBAL_X (86) ///< Profile Bounding Box Global X measurement.
1683 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_GLOBAL_Y (112) ///< Profile Bounding Box Global Y measurement.
1684 #define GO_MEASUREMENT_PROFILE_BOUNDING_BOX_GLOBAL_ANGLE (113) ///< Profile Bounding Box Global Angle measurement.
1685 #define GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_BRIDGE_VALUE (106) ///< Profile Bridge Value measurement.
1686 #define GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_ANGLE (107) ///< Profile Bridge Value measurement.
1687 #define GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_WINDOW (146) ///< Profile Bridge Value measurement.
1688 #define GO_MEASUREMENT_PROFILE_BRIDGE_VALUE_STDDEV (147) ///< Profile Bridge Value measurement.
1689 #define GO_MEASUREMENT_PROFILE_CIRCLE_X (5) ///< Profile Circle tool X measurement.
1690 #define GO_MEASUREMENT_PROFILE_CIRCLE_Z (6) ///< Profile Circle tool Z measurement.
1691 #define GO_MEASUREMENT_PROFILE_CIRCLE_RADIUS (7) ///< Profile Circle tool Radius measurement.
1692 #define GO_MEASUREMENT_PROFILE_CIRCLE_STDDEV (148) ///< Profile Circle tool StdDev measurement.
1693 #define GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR (149) ///< Profile Circle tool Minimum Error measurement.
1694 #define GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR_X (150) ///< Profile Circle tool Minimum Error X measurement.
1695 #define GO_MEASUREMENT_PROFILE_CIRCLE_MIN_ERROR_Z (151) ///< Profile Circle tool Minimum Error Z measurement.
1696 #define GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR (152) ///< Profile Circle tool Maximum Error measurement.
1697 #define GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR_X (153) ///< Profile Circle tool Maximum Error X measurement.
1698 #define GO_MEASUREMENT_PROFILE_CIRCLE_MAX_ERROR_Z (154) ///< Profile Circle tool Maximum Error Z measurement.
1699 #define GO_MEASUREMENT_PROFILE_DIMENSION_WIDTH (8) ///< Profile Dimension tool Width measurement.
1700 #define GO_MEASUREMENT_PROFILE_DIMENSION_HEIGHT (9) ///< Profile Dimension tool Height measurement.
1701 #define GO_MEASUREMENT_PROFILE_DIMENSION_DISTANCE (10) ///< Profile Dimension tool Distance measurement.
1702 #define GO_MEASUREMENT_PROFILE_DIMENSION_CENTER_X (11) ///< Profile Dimension tool Center X measurement.
1703 #define GO_MEASUREMENT_PROFILE_DIMENSION_CENTER_Z (12) ///< Profile Dimension tool Center Z measurement.
1704 #define GO_MEASUREMENT_PROFILE_GROOVE_X (13) ///< Profile Groove tool X measurement.
1705 #define GO_MEASUREMENT_PROFILE_GROOVE_Z (14) ///< Profile Groove tool Z measurement.
1706 #define GO_MEASUREMENT_PROFILE_GROOVE_WIDTH (15) ///< Profile Groove tool Width measurement.
1707 #define GO_MEASUREMENT_PROFILE_GROOVE_DEPTH (16) ///< Profile Groove tool Depth measurement.
1708 #define GO_MEASUREMENT_PROFILE_INTERSECT_X (17) ///< Profile Intersect tool X measurement.
1709 #define GO_MEASUREMENT_PROFILE_INTERSECT_Z (18) ///< Profile Intersect tool Z measurement.
1710 #define GO_MEASUREMENT_PROFILE_INTERSECT_ANGLE (19) ///< Profile Intersect tool Angle measurement.
1711 #define GO_MEASUREMENT_PROFILE_LINE_STDDEV (20) ///< Profile Line tool Standard Deviation measurement.
1712 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MIN (21) ///< Profile Line tool Minimum Error measurement.
1713 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MAX (22) ///< Profile Line tool Maximum Error measurement.
1714 #define GO_MEASUREMENT_PROFILE_LINE_PERCENTILE (23) ///< Profile Line tool Percentile measurement.
1715 #define GO_MEASUREMENT_PROFILE_LINE_OFFSET (130) ///< Profile Line tool Offset measurement.
1716 #define GO_MEASUREMENT_PROFILE_LINE_ANGLE (131) ///< Profile Line tool Angle measurement.
1717 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MIN_X (132) ///< Profile Line tool Minimum X Error measurement.
1718 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MIN_Z (133) ///< Profile Line tool Minimum Z Error measurement.
1719 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MAX_X (134) ///< Profile Line tool Maximum X Error measurement.
1720 #define GO_MEASUREMENT_PROFILE_LINE_ERROR_MAX_Z (135) ///< Profile Line tool Maximum Z Error measurement.
1721 #define GO_MEASUREMENT_PROFILE_PANEL_GAP (24) ///< Profile Panel tool Gap measurement.
1722 #define GO_MEASUREMENT_PROFILE_PANEL_FLUSH (25) ///< Profile Panel tool Flush measurement.
1723 #define GO_MEASUREMENT_PROFILE_PANEL_LEFT_GAP_X (136) ///< Profile Panel tool Left Gap X measurement.
1724 #define GO_MEASUREMENT_PROFILE_PANEL_LEFT_GAP_Z (137) ///< Profile Panel tool Left Gap Z measurement.
1725 #define GO_MEASUREMENT_PROFILE_PANEL_LEFT_FLUSH_X (138) ///< Profile Panel tool Left Flush X measurement.
1726 #define GO_MEASUREMENT_PROFILE_PANEL_LEFT_FLUSH_Z (139) ///< Profile Panel tool Left Flush Z measurement.
1727 #define GO_MEASUREMENT_PROFILE_PANEL_LEFT_SURFACE_ANGLE (140) ///< Profile Panel tool Left Surface Angle measurement.
1728 #define GO_MEASUREMENT_PROFILE_PANEL_RIGHT_GAP_X (141) ///< Profile Panel tool Right Gap X measurement.
1729 #define GO_MEASUREMENT_PROFILE_PANEL_RIGHT_GAP_Z (142) ///< Profile Panel tool Right Gap Z measurement.
1730 #define GO_MEASUREMENT_PROFILE_PANEL_RIGHT_FLUSH_X (143) ///< Profile Panel tool Right Flush X measurement.
1731 #define GO_MEASUREMENT_PROFILE_PANEL_RIGHT_FLUSH_Z (144) ///< Profile Panel tool Right Flush Z measurement.
1732 #define GO_MEASUREMENT_PROFILE_PANEL_RIGHT_SURFACE_ANGLE (145) ///< Profile Panel tool Right Surface Angle measurement.
1733 #define GO_MEASUREMENT_PROFILE_POSITION_X (26) ///< Profile Position tool X measurement.
1734 #define GO_MEASUREMENT_PROFILE_POSITION_Z (27) ///< Profile Position tool Z measurement.
1735 #define GO_MEASUREMENT_PROFILE_STRIP_POSITION_X (28) ///< Profile Strip tool X Position measurement.
1736 #define GO_MEASUREMENT_PROFILE_STRIP_POSITION_Z (29) ///< Profile Strip tool Z Position measurement.
1737 #define GO_MEASUREMENT_PROFILE_STRIP_WIDTH (30) ///< Profile Strip tool Width measurement.
1738 #define GO_MEASUREMENT_PROFILE_STRIP_HEIGHT (31) ///< Profile Strip tool Height measurement.
1739 #define GO_MEASUREMENT_PROFILE_X_LINE_Z (87) ///< Profile X-Line tool Z measurement.
1740 #define GO_MEASUREMENT_PROFILE_X_LINE_VALIDITY (88) ///< Profile X-Line tool Validity measurement.
1741 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_X (32) ///< Surface Bounding Box X measurement.
1742 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_Y (33) ///< Surface Bounding Box Y measurement.
1743 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_Z (34) ///< Surface Bounding Box Z measurement.
1744 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_ZANGLE (35) ///< Surface Bounding Box Z Angle measurement.
1745 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_HEIGHT (36) ///< Surface Bounding Box Height measurement.
1746 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_WIDTH (37) ///< Surface Bounding Box Width measurement.
1747 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_LENGTH (38) ///< Surface Bounding Box Length measurement.
1748 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_X (39) ///< Surface Bounding Box Global X measurement.
1749 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_Y (40) ///< Surface Bounding Box Global Y measurement.
1750 #define GO_MEASUREMENT_SURFACE_BOUNDING_BOX_GLOBAL_Z_ANGLE (41) ///< Surface Bounding Box Global Z Angle measurement.
1751 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_X (42) ///< Surface Countersunk Hole tool X position measurement.
1752 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Y (43) ///< Surface Countersunk Hole tool Y position measurement.
1753 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Z (44) ///< Surface Countersunk Hole tool Z position measurement.
1754 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_OUTER_RADIUS (45) ///< Surface Countersunk Hole tool Outer Radius measurement.
1755 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_DEPTH (46) ///< Surface Countersunk Hole tool Depth measurement.
1756 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_COUNTERBORE_DEPTH (108) ///< Surface Countersunk Hole tool Counterbore Depth measurement.
1757 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_BEVEL_RADIUS (47) ///< Surface Countersunk Hole tool Bevel Radius measurement.
1758 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_BEVEL_ANGLE (48) ///< Surface Countersunk Hole tool Bevel Angle measurement.
1759 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_X_ANGLE (49) ///< Surface Countersunk Hole tool X Angle measurement.
1760 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_Y_ANGLE (50) ///< Surface Countersunk Hole tool Y Angle measurement.
1761 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_AXIS_TILT (122) ///< Surface Countersunk Hole tool axis tilt measurement.
1762 #define GO_MEASUREMENT_SURFACE_COUNTERSUNK_HOLE_AXIS_ORIENTATION (123) ///< Surface Countersunk Hole tool axis orientation measurement.
1763 #define GO_MEASUREMENT_SURFACE_DIMENSION_WIDTH (114) ///< Surface Dimension tool Width measurement.
1764 #define GO_MEASUREMENT_SURFACE_DIMENSION_HEIGHT (115) ///< Surface Dimension tool Height measurement.
1765 #define GO_MEASUREMENT_SURFACE_DIMENSION_LENGTH (116) ///< Surface Dimension tool Length measurement.
1766 #define GO_MEASUREMENT_SURFACE_DIMENSION_DISTANCE (117) ///< Surface Dimension tool Distance measurement.
1767 #define GO_MEASUREMENT_SURFACE_DIMENSION_PLANE_DISTANCE (118) ///< Surface Dimension tool Plane Distance measurement.
1768 #define GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_X (119) ///< Surface Dimension tool Center X measurement.
1769 #define GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_Y (120) ///< Surface Dimension tool Center Y measurement.
1770 #define GO_MEASUREMENT_SURFACE_DIMENSION_CENTER_Z (121) ///< Surface Dimension tool Center Z measurement.
1771 #define GO_MEASUREMENT_SURFACE_ELLIPSE_MAJOR (51) ///< Surface Ellipse tool Major measurement.
1772 #define GO_MEASUREMENT_SURFACE_ELLIPSE_MINOR (52) ///< Surface Ellipse tool Minor measurement.
1773 #define GO_MEASUREMENT_SURFACE_ELLIPSE_RATIO (53) ///< Surface Ellipse tool Ratio measurement.
1774 #define GO_MEASUREMENT_SURFACE_ELLIPSE_ZANGLE (54) ///< Surface Ellipse tool Z Angle measurement.
1775 #define GO_MEASUREMENT_SURFACE_HOLE_X (55) ///< Surface Hole tool X measurement.
1776 #define GO_MEASUREMENT_SURFACE_HOLE_Y (56) ///< Surface Hole tool Y measurement.
1777 #define GO_MEASUREMENT_SURFACE_HOLE_Z (57) ///< Surface Hole tool Z measurement.
1778 #define GO_MEASUREMENT_SURFACE_HOLE_RADIUS (58) ///< Surface Hole tool Radius measurement.
1779 #define GO_MEASUREMENT_SURFACE_OPENING_X (59) ///< Surface Opening tool X measurement.
1780 #define GO_MEASUREMENT_SURFACE_OPENING_Y (60) ///< Surface Opening tool Y measurement.
1781 #define GO_MEASUREMENT_SURFACE_OPENING_Z (61) ///< Surface Opening tool Z measurement.
1782 #define GO_MEASUREMENT_SURFACE_OPENING_WIDTH (62) ///< Surface Opening tool Width measurement.
1783 #define GO_MEASUREMENT_SURFACE_OPENING_LENGTH (63) ///< Surface Opening tool Length measurement.
1784 #define GO_MEASUREMENT_SURFACE_OPENING_ANGLE (64) ///< Surface Opening tool Angle measurement.
1785 #define GO_MEASUREMENT_SURFACE_PLANE_X_ANGLE (65) ///< Surface Plane tool X Angle measurement.
1786 #define GO_MEASUREMENT_SURFACE_PLANE_Y_ANGLE (66) ///< Surface Plane tool Y Angle measurement.
1787 #define GO_MEASUREMENT_SURFACE_PLANE_Z_OFFSET (67) ///< Surface Plane tool Z Offset measurement.
1788 #define GO_MEASUREMENT_SURFACE_PLANE_STD_DEV (109) ///< Surface Plane tool Standard Deviation measurement.
1789 #define GO_MEASUREMENT_SURFACE_PLANE_ERROR_MIN (110) ///< Surface Plane tool Minimum Error measurement.
1790 #define GO_MEASUREMENT_SURFACE_PLANE_ERROR_MAX (111) ///< Surface Plane tool Maximum Error measurement.
1791 #define GO_MEASUREMENT_SURFACE_PLANE_X_NORMAL (126) ///< Surface Plane tool X Normal measurement.
1792 #define GO_MEASUREMENT_SURFACE_PLANE_Y_NORMAL (127) ///< Surface Plane tool Y Normal measurement.
1793 #define GO_MEASUREMENT_SURFACE_PLANE_Z_NORMAL (128) ///< Surface Plane tool Z Normal measurement.
1794 #define GO_MEASUREMENT_SURFACE_PLANE_DISTANCE (129) ///< Surface Plane tool X Normal measurement.
1795 #define GO_MEASUREMENT_SURFACE_EDGE_X (130) ///< Surface Position edge tool X measurement.
1796 #define GO_MEASUREMENT_SURFACE_EDGE_Y (131) ///< Surface Position edge tool Y measurement.
1797 #define GO_MEASUREMENT_SURFACE_EDGE_Z (132) ///< Surface Position edge tool Z measurement.
1798 #define GO_MEASUREMENT_SURFACE_INTERSECT_X (133) ///< Surface Position intersect tool X measurement.
1799 #define GO_MEASUREMENT_SURFACE_INTERSECT_Y (134) ///< Surface Position intersect tool Y measurement.
1800 #define GO_MEASUREMENT_SURFACE_INTERSECT_Z (135) ///< Surface Position intersect tool Z measurement.
1801 #define GO_MEASUREMENT_SURFACE_INTERSECT_ANGLE (136) ///< Surface Position intersect tool angle.
1802 
1803 #define GO_MEASUREMENT_SURFACE_POSITION_X (68) ///< Surface Position tool X measurement.
1804 #define GO_MEASUREMENT_SURFACE_POSITION_Y (69) ///< Surface Position tool Y measurement.
1805 #define GO_MEASUREMENT_SURFACE_POSITION_Z (70) ///< Surface Position tool Z measurement.
1806 #define GO_MEASUREMENT_SURFACE_RIVET_X (88) ///< Surface Rivet tool X measurement.
1807 #define GO_MEASUREMENT_SURFACE_RIVET_Y (89) ///< Surface Rivet tool Y measurement.
1808 #define GO_MEASUREMENT_SURFACE_RIVET_Z (90) ///< Surface Rivet tool Z measurement.
1809 #define GO_MEASUREMENT_SURFACE_RIVET_TILT_ANGLE (91) ///< Surface Rivet tool X Angle measurement.
1810 #define GO_MEASUREMENT_SURFACE_RIVET_TILT_DIRECTION (92) ///< Surface Rivet tool Y Angle measurement.
1811 #define GO_MEASUREMENT_SURFACE_RIVET_RADIUS (93) ///< Surface Rivet tool Radius measurement.
1812 #define GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MIN (94) ///< Surface Rivet tool Top Offset Minimum measurement.
1813 #define GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MAX (95) ///< Surface Rivet tool Top Offset Maximum measurement.
1814 #define GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_MEAN (96) ///< Surface Rivet tool Top Offset Mean measurement.
1815 #define GO_MEASUREMENT_SURFACE_RIVET_TOP_OFFSET_STD_DEV (97) ///< Surface Rivet tool Top Offset Standard Deviation measurement.
1816 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MIN (98) ///< Surface Rivet tool Radial Height Minimum measurement.
1817 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MAX (99) ///< Surface Rivet tool Radial Height Maximum measurement.
1818 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_MEAN (100) ///< Surface Rivet tool Radial Height Mean measurement.
1819 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_HEIGHT_STD_DEV (101) ///< Surface Rivet tool Radial Height Standard Deviation measurement.
1820 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MIN (102) ///< Surface Rivet tool Radial Slope Minimum measurement.
1821 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MAX (103) ///< Surface Rivet tool Radial Slope Maximum measurement.
1822 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_MEAN (104) ///< Surface Rivet tool Radial Slope Mean measurement.
1823 #define GO_MEASUREMENT_SURFACE_RIVET_RADIAL_SLOPE_STD_DEV (105) ///< Surface Rivet tool Radial Slope Standard Deviation measurement.
1824 #define GO_MEASUREMENT_SURFACE_STUD_BASE_X (71) ///< Surface Stud tool Base X measurement.
1825 #define GO_MEASUREMENT_SURFACE_STUD_BASE_Y (72) ///< Surface Stud tool Base Y measurement.
1826 #define GO_MEASUREMENT_SURFACE_STUD_BASE_Z (73) ///< Surface Stud tool Base Z measurement.
1827 #define GO_MEASUREMENT_SURFACE_STUD_TIP_X (74) ///< Surface Stud tool Tip X measurement.
1828 #define GO_MEASUREMENT_SURFACE_STUD_TIP_Y (75) ///< Surface Stud tool Tip Y measurement.
1829 #define GO_MEASUREMENT_SURFACE_STUD_TIP_Z (76) ///< Surface Stud tool Tip Z measurement.
1830 #define GO_MEASUREMENT_SURFACE_STUD_RADIUS (77) ///< Surface Stud tool Radius measurement.
1831 #define GO_MEASUREMENT_SURFACE_VOLUME_AREA (78) ///< Surface Volume tool Area measurement.
1832 #define GO_MEASUREMENT_SURFACE_VOLUME_VOLUME (79) ///< Surface Volume tool Volume measurement.
1833 #define GO_MEASUREMENT_SURFACE_VOLUME_THICKNESS (80) ///< Surface Volume tool Thickness measurement.
1834 #define GO_MEASUREMENT_SCRIPT_OUTPUT (81) ///< Script tool Output.
1835 #define GO_MEASUREMENT_EXTENSIBLE (87) ///< Extensible tool measurement.
1836 #define GO_MEASUREMENT_PROFILE_ROUND_CORNER_X (123) ///< Profile Round Corner tool X measurement.
1837 #define GO_MEASUREMENT_PROFILE_ROUND_CORNER_Z (124) ///< Profile Round Corner tool Z measurement.
1838 #define GO_MEASUREMENT_PROFILE_ROUND_CORNER_ANGLE (125) ///< Profile Round Corner tool Angle measurement.
1839 
1840 
1841 
1842 #define GO_FEATURE_DIMENSION_WIDTH (140) ///< Dimension tool width Intersect angle.
1843 #define GO_FEATURE_DIMENSION_LENGTH (141) ///< Dimension tool length Intersect angle.
1844 #define GO_FEATURE_DIMENSION_HEIGHT (142) ///< Dimension tool height Intersect angle.
1845 #define GO_FEATURE_DIMENSION_DISTANCE (143) ///< Dimension tool distance Intersect angle.
1846 #define GO_FEATURE_DIMENSION_PLANEDISTANCE (144) ///< Dimension tool plane distance Intersect angle.
1847 #define GO_FEATURE_DIMENSION_CENTERX (145) ///< Dimension tool center x Intersect angle.
1848 #define GO_FEATURE_DIMENSION_CENTERY (146) ///< Dimension tool center y Intersect angle.
1849 #define GO_FEATURE_DIMENSION_CENTERZ (147) ///< Dimension tool center z Intersect angle.
1850 
1851 /**@}*/
1852 
1853 // DO NOT CHANGE OR RE-ORDER THESE PUBLICALLY DEFINED ENUMERATOR VALUES.
1854 // NEW VALUES MUST BE APPENDED, NEVER INSERTED.
1855 /**
1856 * @struct GoFeatureType
1857 * @extends kValue
1858 * @ingroup GoSdk-Tools
1859 * @brief Lists all tool feature types.
1860 *
1861 * The following enumerators are defined:
1862 * - #GO_FEATURE_UNKNOWN
1863 * - #GO_FEATURE_EXTENSIBLE
1864 * - #GO_FEATURE_SURFACE_EDGE_EDGE_LINE
1865 * - #GO_FEATURE_SURFACE_CENTER_POINT
1866 * - #GO_FEATURE_SURFACE_BOUNDING_BOX_CENTER_POINT
1867 * - #GO_FEATURE_SURFACE_COUNTERSUNKHOLE_CENTER_POINT
1868 * - #GO_FEATURE_SURFACE_DIMENSION_CENTER_POINT
1869 * - #GO_FEATURE_SURFACE_ELLIPSE_CENTER_POINT
1870 * - #GO_FEATURE_SURFACE_ELLIPSE_MAJOR_AXIS_LINE
1871 * - #GO_FEATURE_SURFACE_ELLIPSE_MINOR_AXIS_LINE
1872 * - #GO_FEATURE_SURFACE_HOLE_CENTER_POINT
1873 * - #GO_FEATURE_SURFACE_OPENING_CENTER_POINT
1874 * - #GO_FEATURE_SURFACE_PLANE_PLANE
1875 * - #GO_FEATURE_SURFACE_POSITION_POINT
1876 * - #GO_FEATURE_SURFACE_STUD_TIP_POINT
1877 * - #GO_FEATURE_SURFACE_STUD_BASE_POINT
1878 * - #GO_FEATURE_SURFACE_BOUNDING_BOX_AXIS_LINE
1879 * - #GO_FEATURE_PROFILE_POSITION_POINT
1880 * - #GO_FEATURE_PROFILE_LINE_LINE
1881 * - #GO_FEATURE_PROFILE_LINE_MIN_ERROR_POINT
1882 * - #GO_FEATURE_PROFILE_LINE_MAX_ERROR_POINT
1883 * - #GO_FEATURE_PROFILE_INTERSECT_INTERSECT_POINT
1884 * - #GO_FEATURE_PROFILE_INTERSECT_LINE
1885 * - #GO_FEATURE_PROFILE_INTERSECT_BASE_LINE
1886 * - #GO_FEATURE_PROFILE_BOUNDING_BOX_CENTER_POINT
1887 * - #GO_FEATURE_PROFILE_BOUNDING_BOX_CORNER_POINT
1888 * - #GO_FEATURE_PROFILE_AREA_CENTER_POINT
1889 * - #GO_FEATURE_PROFILE_CIRCLE_CENTER_POINT
1890 * - #GO_FEATURE_PROFILE_DIMENSION_CENTER_POINT
1891 * - #GO_FEATURE_PROFILE_PANEL_LEFT_GAP_POINT
1892 * - #GO_FEATURE_PROFILE_PANEL_LEFT_FLUSH_POINT
1893 * - #GO_FEATURE_PROFILE_PANEL_RIGHT_GAP_POINT
1894 * - #GO_FEATURE_PROFILE_PANEL_RIGHT_FLUSH_POINT
1895 * - #GO_FEATURE_PROFILE_ROUND_CORNER_POINT
1896 * - #GO_FEATURE_PROFILE_ROUND_CORNER_EDGE_POINT
1897 * - #GO_FEATURE_PROFILE_ROUND_CORNER_CENTER_POINT
1898 */
1899 typedef k32s GoFeatureType;
1900 /** @name GoFeatureType
1901 *@{*/
1902 #define GO_FEATURE_UNKNOWN (-1) ///< Unknown feature.
1903 #define GO_FEATURE_EXTENSIBLE (0) ///< Extensible feature.
1904 #define GO_FEATURE_SURFACE_EDGE_EDGE_LINE (1) ///< Surface Edge Edge Line feature.
1905 #define GO_FEATURE_SURFACE_CENTER_POINT (2) ///< Surface Center Point feature.
1906 #define GO_FEATURE_SURFACE_BOUNDING_BOX_CENTER_POINT (3) ///< Surface Bounding Box Center Point feature.
1907 #define GO_FEATURE_SURFACE_COUNTERSUNKHOLE_CENTER_POINT (4) ///< Surface Countersunk Hole Center Point feature.
1908 #define GO_FEATURE_SURFACE_DIMENSION_CENTER_POINT (5) ///< Surface Dimension Center Point feature.
1909 #define GO_FEATURE_SURFACE_ELLIPSE_CENTER_POINT (6) ///< Surface Ellipse Center Point feature.
1910 #define GO_FEATURE_SURFACE_ELLIPSE_MAJOR_AXIS_LINE (7) ///< Surface Ellipse Major Axis feature.
1911 #define GO_FEATURE_SURFACE_ELLIPSE_MINOR_AXIS_LINE (8) ///< Surface Ellipse Minor Axis feature.
1912 #define GO_FEATURE_SURFACE_HOLE_CENTER_POINT (9) ///< Surface Hole Center Point feature.
1913 #define GO_FEATURE_SURFACE_OPENING_CENTER_POINT (10) ///< Surface Opening Center Point feature.
1914 #define GO_FEATURE_SURFACE_PLANE_PLANE (11) ///< Surface Plane Plane feature.
1915 #define GO_FEATURE_SURFACE_POSITION_POINT (12) ///< Surface Position Point feature.
1916 #define GO_FEATURE_SURFACE_STUD_TIP_POINT (13) ///< Surface Stud Tip Point feature.
1917 #define GO_FEATURE_SURFACE_STUD_BASE_POINT (14) ///< Surface Stud Base Point feature.
1918 #define GO_FEATURE_SURFACE_BOUNDING_BOX_AXIS_LINE (15) ///< Surface Bounding Box Axis Line feature.
1919 
1920 #define GO_FEATURE_PROFILE_POSITION_POINT (50) ///< Profile Position Point feature.
1921 #define GO_FEATURE_PROFILE_LINE_LINE (51) ///< Profile Line Line feature.
1922 #define GO_FEATURE_PROFILE_LINE_MIN_ERROR_POINT (52) ///< Profile Line Minimum Error Point feature.
1923 #define GO_FEATURE_PROFILE_LINE_MAX_ERROR_POINT (53) ///< Profile Line Maximum Error Point feature.
1924 #define GO_FEATURE_PROFILE_INTERSECT_INTERSECT_POINT (54) ///< Profile Intersect Intersect Point feature.
1925 #define GO_FEATURE_PROFILE_INTERSECT_LINE (55) ///< Profile Intersect Line feature.
1926 #define GO_FEATURE_PROFILE_INTERSECT_BASE_LINE (56) ///< Profile Intersect Base Line feature.
1927 #define GO_FEATURE_PROFILE_BOUNDING_BOX_CENTER_POINT (57) ///< Profile Bounding Box Center Point feature.
1928 #define GO_FEATURE_PROFILE_BOUNDING_BOX_CORNER_POINT (58) ///< Profile Bounding Box Corner Point feature.
1929 #define GO_FEATURE_PROFILE_AREA_CENTER_POINT (59) ///< Profile Area Center Point feature.
1930 #define GO_FEATURE_PROFILE_CIRCLE_CENTER_POINT (60) ///< Profile Circle Center Point feature.
1931 #define GO_FEATURE_PROFILE_DIMENSION_CENTER_POINT (61) ///< Profile Dimension Center Point feature.
1932 #define GO_FEATURE_PROFILE_PANEL_LEFT_GAP_POINT (62) ///< Profile Panel Left Gap Point feature.
1933 #define GO_FEATURE_PROFILE_PANEL_LEFT_FLUSH_POINT (63) ///< Profile Panel Left Flush Point feature.
1934 #define GO_FEATURE_PROFILE_PANEL_RIGHT_GAP_POINT (64) ///< Profile Panel Right Gap Point feature.
1935 #define GO_FEATURE_PROFILE_PANEL_RIGHT_FLUSH_POINT (65) ///< Profile Panel Right Flush Point feature.
1936 #define GO_FEATURE_PROFILE_ROUND_CORNER_POINT (66) ///< Profile Panel Round Corner Point feature.
1937 #define GO_FEATURE_PROFILE_ROUND_CORNER_EDGE_POINT (67) ///< Profile Panel Round Corner Edge Point feature.
1938 #define GO_FEATURE_PROFILE_ROUND_CORNER_CENTER_POINT (68) ///< Profile Panel Round Corner Center Point feature.
1939 /**@}*/
1940 
1941 
1942 #define GO_MEASUREMENT_ID_NONE (-1)
1943 /**
1944  * @struct GoDataMessageType
1945  * @extends kValue
1946  * @ingroup GoSdk-DataChannel
1947  * @brief Lists all data message types.
1948  *
1949  * The following enumerators are defined:
1950  * - #GO_DATA_MESSAGE_TYPE_UNKNOWN
1951  * - #GO_DATA_MESSAGE_TYPE_STAMP
1952  * - #GO_DATA_MESSAGE_TYPE_HEALTH
1953  * - #GO_DATA_MESSAGE_TYPE_VIDEO
1954  * - #GO_DATA_MESSAGE_TYPE_RANGE
1955  * - #GO_DATA_MESSAGE_TYPE_RANGE_INTENSITY
1956  * - #GO_DATA_MESSAGE_TYPE_PROFILE_POINT_CLOUD
1957  * - #GO_DATA_MESSAGE_TYPE_PROFILE_INTENSITY
1958  * - #GO_DATA_MESSAGE_TYPE_UNIFORM_PROFILE
1959  * - #GO_DATA_MESSAGE_TYPE_UNIFORM_SURFACE
1960  * - #GO_DATA_MESSAGE_TYPE_SURFACE_INTENSITY
1961  * - #GO_DATA_MESSAGE_TYPE_MEASUREMENT
1962  * - #GO_DATA_MESSAGE_TYPE_ALIGNMENT
1963  * - #GO_DATA_MESSAGE_TYPE_EXPOSURE_CAL
1964  * - #GO_DATA_MESSAGE_TYPE_EDGE_MATCH
1965  * - #GO_DATA_MESSAGE_TYPE_BOUNDING_BOX_MATCH
1966  * - #GO_DATA_MESSAGE_TYPE_ELLIPSE_MATCH
1967  * - #GO_DATA_MESSAGE_TYPE_SECTION
1968  * - #GO_DATA_MESSAGE_TYPE_SECTION_INTENSITY
1969  * - #GO_DATA_MESSAGE_TYPE_EVENT
1970  * - #GO_DATA_MESSAGE_TYPE_TRACHEID
1971  * - #GO_DATA_MESSAGE_TYPE_FEATURE_POINT
1972  * - #GO_DATA_MESSAGE_TYPE_FEATURE_LINE
1973  * - #GO_DATA_MESSAGE_TYPE_FEATURE_PLANE
1974  * - #GO_DATA_MESSAGE_TYPE_FEATURE_CIRCLE
1975  * - #GO_DATA_MESSAGE_TYPE_SURFACE_POINT_CLOUD
1976  * - #GO_DATA_MESSAGE_TYPE_GENERIC
1977  * - #GO_DATA_MESSAGE_TYPE_MESH
1978  * - #GO_DATA_MESSAGE_TYPE_PROFILE //Deprecated use GO_DATA_MESSAGE_TYPE_PROFILE_POINT_CLOUD instead
1979  * - #GO_DATA_MESSAGE_TYPE_RESAMPLED_PROFILE //Deprecated use GO_DATA_MESSAGE_TYPE_UNIFORM_PROFILE instead
1980  * - #GO_DATA_MESSAGE_TYPE_SURFACE //Deprecated use GO_DATA_MESSAGE_TYPE_UNIFORM_SURFACE
1981  */
1982 /* These definitions are similar to the GO_COMPACT_MESSAGE_XXX but are not
1983  * guaranteed to be the same.
1984  *
1985  * This set of GO_DATA_MESSAGE_TYPE_xxx definitions are external (customer)
1986  * facing and must NEVER be renumbered. Some SDK applications hardcode these values.
1987  *
1988  */
1989 typedef k32s GoDataMessageType;
1990 /** @name GoDataMessageType
1991  *@{*/
1992 #define GO_DATA_MESSAGE_TYPE_UNKNOWN -1 ///< Unknown message type.
1993 #define GO_DATA_MESSAGE_TYPE_STAMP 0 ///< Stamp message type.
1994 #define GO_DATA_MESSAGE_TYPE_HEALTH 1 ///< Health message type.
1995 #define GO_DATA_MESSAGE_TYPE_VIDEO 2 ///< Video message type.
1996 #define GO_DATA_MESSAGE_TYPE_RANGE 3 ///< Range message type.
1997 #define GO_DATA_MESSAGE_TYPE_RANGE_INTENSITY 4 ///< Range Intensity message type.
1998 #define GO_DATA_MESSAGE_TYPE_PROFILE_POINT_CLOUD 5 ///< Unresampled Profile message type.
1999 #define GO_DATA_MESSAGE_TYPE_PROFILE_INTENSITY 6 ///< Profile Point Cloud (or Uniform Profile) Intensity message type.
2000 #define GO_DATA_MESSAGE_TYPE_UNIFORM_PROFILE 7 ///< Uniform (resampled) Profile message type.
2001 #define GO_DATA_MESSAGE_TYPE_UNIFORM_SURFACE 8 ///< Uniform (resampled) Surface message type.
2002 #define GO_DATA_MESSAGE_TYPE_SURFACE_INTENSITY 9 ///< Surface Point Cloud (or Uniform Surface) Intensity message type.
2003 #define GO_DATA_MESSAGE_TYPE_MEASUREMENT 10 ///< Measurement message type.
2004 #define GO_DATA_MESSAGE_TYPE_ALIGNMENT 11 ///< Alignment result message type.
2005 #define GO_DATA_MESSAGE_TYPE_EXPOSURE_CAL 12 ///< Exposure AutoSet/Calibration result message type.
2006 #define GO_DATA_MESSAGE_TYPE_EDGE_MATCH 16 ///< Part matching edge algorithm message type.
2007 #define GO_DATA_MESSAGE_TYPE_BOUNDING_BOX_MATCH 17 ///< Part matching bounding box algorithm message type.
2008 #define GO_DATA_MESSAGE_TYPE_ELLIPSE_MATCH 18 ///< Part matching ellipse algorithm message type.
2009 #define GO_DATA_MESSAGE_TYPE_SECTION 20 ///< Section message type.
2010 #define GO_DATA_MESSAGE_TYPE_SECTION_INTENSITY 21 ///< Section Intensity message type.
2011 #define GO_DATA_MESSAGE_TYPE_EVENT 22 ///< Event message type.
2012 #define GO_DATA_MESSAGE_TYPE_TRACHEID 23 ///< Tracheid message type.
2013 #define GO_DATA_MESSAGE_TYPE_FEATURE_POINT 24 ///< Point Feature message type.
2014 #define GO_DATA_MESSAGE_TYPE_FEATURE_LINE 25 ///< Line Feature message type.
2015 #define GO_DATA_MESSAGE_TYPE_FEATURE_PLANE 26 ///< Plane Feature message type.
2016 #define GO_DATA_MESSAGE_TYPE_FEATURE_CIRCLE 27 ///< Circle Feature message type.
2017 #define GO_DATA_MESSAGE_TYPE_SURFACE_POINT_CLOUD 28 ///< Surface Point Cloud (Un-Resampled surface) message type.
2018 #define GO_DATA_MESSAGE_TYPE_GENERIC 29 ///< Generic message type.
2019 #define GO_DATA_MESSAGE_TYPE_NULL 30 ///< Null message type.
2020 
2021 #define GO_DATA_MESSAGE_TYPE_MESH 36 ///< Mesh message type.
2022 
2023 
2024 // Refinements to measurement and feature messages were required to make them work with array support.
2025 // The below GoDataMessageType ids are used INTERNALLY to distinguish the arrayed versions of measurements and features
2026 // but they automatically still resolve to the same respective Go<>Msg object, albeit with a different id.
2027 ///
2028 // eg. For measurements:
2029 // Unary GoMeasureMsg::id = GO_DATA_MESSAGE_TYPE_MEASUREMENT
2030 // (internal Arrayed GvMeasureMsgs use GO_COMPACT_MESSAGE_MEASUREMENT_V2)
2031 // Arrayed GoMeasureMsg::id = GO_DATA_MESSAGE_TYPE_MEASUREMENT_V2 (but still a GoMeasureMsg object).
2032 //
2033 #define GO_DATA_MESSAGE_TYPE_MEASUREMENT_V2 (31) ///< Measurement message type V2.
2034 #define GO_DATA_MESSAGE_TYPE_FEATURE_POINT_V2 (32) ///< Point Feature message type V2.
2035 #define GO_DATA_MESSAGE_TYPE_FEATURE_LINE_V2 (33) ///< Line Feature message type V2.
2036 #define GO_DATA_MESSAGE_TYPE_FEATURE_PLANE_V2 (34) ///< Plane Feature message type V2.
2037 #define GO_DATA_MESSAGE_TYPE_FEATURE_CIRCLE_V2 (35) ///< Circle Feature message type V2.
2038 
2039 
2040 #define GO_DATA_MESSAGE_TYPE_PROFILE GO_DATA_MESSAGE_TYPE_PROFILE_POINT_CLOUD ///< Deprecated Unresampled Profile message type.
2041 #define GO_DATA_MESSAGE_TYPE_RESAMPLED_PROFILE GO_DATA_MESSAGE_TYPE_UNIFORM_PROFILE ///< Deprecated Uniform (resampled) Profile message type.
2042 #define GO_DATA_MESSAGE_TYPE_SURFACE GO_DATA_MESSAGE_TYPE_UNIFORM_SURFACE ///< Deprecated Surface message type.
2043 /**@}*/
2044 
2045 /**
2046 * @struct GoReplayConditionType
2047 * @extends kValue
2048 * @ingroup GoSdk-Replay
2049 * @brief Represents a replay condition type.
2050 *
2051 * The following enumerators are defined:
2052 * - #GO_REPLAY_CONDITION_TYPE_ANY_MEASUREMENT
2053 * - #GO_REPLAY_CONDITION_TYPE_ANY_DATA
2054 * - #GO_REPLAY_CONDITION_TYPE_MEASUREMENT
2055 */
2056 typedef k32s GoReplayConditionType;
2057 /** @name GoReplayConditionType
2058 *@{*/
2059 #define GO_REPLAY_CONDITION_TYPE_ANY_MEASUREMENT (0) ///< Any Measurement condition.
2060 #define GO_REPLAY_CONDITION_TYPE_ANY_DATA (1) ///< Any Data condition.
2061 #define GO_REPLAY_CONDITION_TYPE_MEASUREMENT (2) ///< Measurement condition.
2062 
2063 /**@}*/
2064 
2065 /**
2066 * @struct GoReplayCombineType
2067 * @extends kValue
2068 * @ingroup GoSdk-Replay
2069 * @brief Represents a replay combine type.
2070 *
2071 * The following enumerators are defined:
2072 * - #GO_REPLAY_COMBINE_TYPE_ANY
2073 * - #GO_REPLAY_COMBINE_TYPE_ALL
2074 */
2075 typedef k32s GoReplayCombineType;
2076 /** @name GoReplayCombineType
2077 *@{*/
2078 #define GO_REPLAY_COMBINE_TYPE_ANY (0) ///< Any
2079 #define GO_REPLAY_COMBINE_TYPE_ALL (1) ///< All
2080 /**@}*/
2081 
2082 /**
2083 * @struct GoReplayMeasurementResult
2084 * @extends kValue
2085 * @ingroup GoSdk-Replay
2086 * @brief Represents a replay measurement result.
2087 *
2088 * The following enumerators are defined:
2089 * - #GO_REPLAY_MEASUREMENT_RESULT_PASS
2090 * - #GO_REPLAY_MEASUREMENT_RESULT_FAIL
2091 * - #GO_REPLAY_MEASUREMENT_RESULT_VALID
2092 * - #GO_REPLAY_MEASUREMENT_RESULT_INVALID
2093 * - #GO_REPLAY_MEASUREMENT_RESULT_FAIL_OR_INVALID
2094 */
2096 /** @name GoReplayMeasurementResult
2097 *@{*/
2098 #define GO_REPLAY_MEASUREMENT_RESULT_PASS (0) ///< Pass
2099 #define GO_REPLAY_MEASUREMENT_RESULT_FAIL (1) ///< Fail
2100 #define GO_REPLAY_MEASUREMENT_RESULT_VALID (2) ///< Valid
2101 #define GO_REPLAY_MEASUREMENT_RESULT_INVALID (3) ///< Invalid
2102 #define GO_REPLAY_MEASUREMENT_RESULT_FAIL_OR_INVALID (4) ///< Fail or Invalid
2103 /**@}*/
2104 
2105 /**
2106 * @struct GoReplayRangeCountCase
2107 * @extends kValue
2108 * @ingroup GoSdk-Replay
2109 * @brief Represents a replay range count case.
2110 *
2111 * The following enumerators are defined:
2112 * - #GO_REPLAY_RANGE_COUNT_CASE_AT_ABOVE
2113 * - #GO_REPLAY_RANGE_COUNT_CASE_BELOW
2114 */
2116 /** @name GoReplayRangeCountCase
2117 *@{*/
2118 #define GO_REPLAY_RANGE_COUNT_CASE_AT_ABOVE (0) ///< Case at above
2119 #define GO_REPLAY_RANGE_COUNT_CASE_BELOW (1) ///< Case below
2120 /**@}*/
2121 
2122 /**
2123 * @struct GoSensorAccelState
2124 * @extends kValue
2125 * @ingroup GoSdk
2126 * @brief Lists all sensor acceleration states that a sensor can be in.
2127 * When a sensor is being accelerated, GoSensorAccelStatus
2128 * provides more detail on the status of the acceleration.
2129 * These are applicable only when using the GoAcceleratorMgr class.
2130 *
2131 * The following enumerators are defined:
2132 * - #GO_SENSOR_ACCEL_STATE_UNKNOWN
2133 * - #GO_SENSOR_ACCEL_STATE_AVAILABLE
2134 * - #GO_SENSOR_ACCEL_STATE_ACCELERATED
2135 * - #GO_SENSOR_ACCEL_STATE_ACCELERATED_BY_OTHER
2136 * - #GO_SENSOR_ACCEL_STATE_FW_MISMATCH
2137 */
2138 typedef k32s GoSensorAccelState;
2139 /** @name GoSensorAccelState
2140 *@{*/
2141 #define GO_SENSOR_ACCEL_STATE_UNKNOWN (0) ///< State could not be determined.
2142 #define GO_SENSOR_ACCEL_STATE_AVAILABLE (1) ///< Sensor is a candidate for acceleration.
2143 #define GO_SENSOR_ACCEL_STATE_ACCELERATED (2) ///< Sensor is accelerated by this host.
2144 #define GO_SENSOR_ACCEL_STATE_ACCELERATED_BY_OTHER (3) ///< Sensor is accelerated by another host.
2145 #define GO_SENSOR_ACCEL_STATE_FW_MISMATCH (4) ///< Sensor firmware does not match accelerator program version.
2146 /**@}*/
2147 
2148 /**
2149 * @struct GoSensorAccelStatus
2150 * @extends kValue
2151 * @ingroup GoSdk
2152 * @brief Represents the acceleration status of a sensor that is available or
2153 * being accelerated by the local host. The corresponding acceleration state
2154 * can be GO_SENSOR_ACCEL_STATE_AVAILABLE (while acceleration has not
2155 * yet) or GO_SENSOR_ACCEL_STATE_ACCELERATED (acceleration completed).
2156 * These status values are not applicable for a sensor
2157 * accelerated by another host (ie. state is GO_SENSOR_ACCEL_STATE_ACCELERATED_BY_OTHER)).
2158 * These statuses are applicable only when using the GoAcceleratorMgr class.
2159 *
2160 * The following enumerators are defined:
2161 * - #GO_SENSOR_ACCEL_STATUS_SUCCESS
2162 * - #GO_SENSOR_ACCEL_STATUS_ACCELERATING
2163 * - #GO_SENSOR_ACCEL_STATUS_DECELERATING
2164 * - #GO_SENSOR_ACCEL_STATUS_MISSING
2165 * - #GO_SENSOR_ACCEL_STATUS_STOPPED
2166 * - #GO_SENSOR_ACCEL_STATUS_FAIL_TO_ACCEL
2167 * - #GO_SENSOR_ACCEL_STATUS_STOPPED_AVAILABLE
2168 * - #GO_SENSOR_ACCEL_STATUS_STOPPED_ACCELERATED_BY_OTHER
2169 * - #GO_SENSOR_ACCEL_STATUS_STOPPED_FW_MISMATCH
2170 * - #GO_SENSOR_ACCEL_STATUS_STOPPED_PORT_IN_USE
2171 * - #GO_SENSOR_ACCEL_STATUS_STOPPED_UNREACHABLE
2172 */
2173 typedef k32s GoSensorAccelStatus;
2174 /** @name GoSensorAccelStatus
2175 *@{*/
2176 #define GO_SENSOR_ACCEL_STATUS_SUCCESS (0) ///< Sensor accelerated successfully.
2177 #define GO_SENSOR_ACCEL_STATUS_ACCELERATING (-1) ///< Sensor is in the process of being accelerated.
2178 #define GO_SENSOR_ACCEL_STATUS_DECELERATING (-2) ///< Sensor is in the process of being unaccelerated.
2179 #define GO_SENSOR_ACCEL_STATUS_MISSING (-3) ///< Sensor is accelerated, but has disappeared from network.
2180 #define GO_SENSOR_ACCEL_STATUS_STOPPED (-4) ///< Sensor was accelerated but unexpectedly stopped (eg. crashed).
2181 #define GO_SENSOR_ACCEL_STATUS_FAIL_TO_ACCEL (-5) ///< Generic failure to accelerate sensor.
2182 #define GO_SENSOR_ACCEL_STATUS_STOPPED_AVAILABLE (-6) ///< Acceleration stopped and sensor is unaccelerated. Status is only for client use to elaborate on a STOPPED status.
2183 #define GO_SENSOR_ACCEL_STATUS_STOPPED_ACCELERATED_BY_OTHER (-7) ///< Acceleration stopped and sensor is now accelerated by another host. Status is only for client use to elaborate on a STOPPED status.
2184 #define GO_SENSOR_ACCEL_STATUS_STOPPED_FW_MISMATCH (-8) ///< Acceleration stopped and sensor now has an incompatible firmware version. Status is only for client use to elaborate on a STOPPED status.
2185 #define GO_SENSOR_ACCEL_STATUS_STOPPED_PORT_IN_USE (-9) ///< Acceleration stopped because sensor ports are in use by another application. Status is only for client use to elaborate on a STOPPED status.
2186 #define GO_SENSOR_ACCEL_STATUS_STOPPED_UNREACHABLE (-10) ///< Acceleration stopped because sensor in on an unreachable network. Status is only for client use to elaborate on a STOPPED status.
2187 
2188 /**
2189 * @struct GoAdvancedType
2190 * @extends kValue
2191 * @note Supported with G1, G2
2192 * @ingroup GoSdk
2193 * @brief Represents advanced acquisition type.
2194 *
2195 * The following enumerators are defined:
2196 * - #GO_ADVANCED_TYPE_CUSTOM
2197 * - #GO_ADVANCED_TYPE_DIFFUSE
2198 * - #GO_ADVANCED_TYPE_REFLECTIVE
2199 */
2200 typedef k32s GoAdvancedType;
2201 /** @name GoAdvancedType
2202 *@{*/
2203 #define GO_ADVANCED_TYPE_CUSTOM (0) ///< Custom advanced acquisition type.
2204 #define GO_ADVANCED_TYPE_DIFFUSE (1) ///< Diffuse advanced acquisition type.
2205 #define GO_ADVANCED_TYPE_REFLECTIVE (3) ///< Reflective advanced acquisition type.
2206 /**@}*/
2207 
2208 /**
2209  * @struct GoMaterialType
2210  * @deprecated
2211  * @extends kValue
2212  * @note Supported with G1, G2
2213  * @ingroup GoSdk
2214  * @brief Represents a material acquisition type.
2215  *
2216  * The following enumerators are defined:
2217  * - #GO_MATERIAL_TYPE_CUSTOM
2218  * - #GO_MATERIAL_TYPE_DIFFUSE
2219  */
2220 typedef k32s GoMaterialType;
2221 /** @name GoMaterialType
2222  *@{*/
2223 #define GO_MATERIAL_TYPE_CUSTOM (0) ///< Custom material acquisition type.
2224 #define GO_MATERIAL_TYPE_DIFFUSE (1) ///< Diffuse material acquisition type.
2225 /**@}*/
2226 
2227 /**
2228  * @struct GoSpotSelectionType
2229  * @extends kValue
2230  * @note Supported with G1, G2
2231  * @ingroup GoSdk
2232  * @brief Represents a spot selection type.
2233  *
2234  * The following enumerators are defined:
2235  * - #GO_SPOT_SELECTION_TYPE_BEST
2236  * - #GO_SPOT_SELECTION_TYPE_TOP
2237  * - #GO_SPOT_SELECTION_TYPE_BOTTOM
2238  * - #GO_SPOT_SELECTION_TYPE_NONE
2239  * - #GO_SPOT_SELECTION_TYPE_CONTINUITY
2240  * - #GO_SPOT_SELECTION_TYPE_TRANSLUCENT
2241  */
2242 typedef k32s GoSpotSelectionType;
2243 /** @name GoSpotSelectionType
2244  *@{*/
2245 #define GO_SPOT_SELECTION_TYPE_BEST (0) ///< Select the spot with the best value.
2246 #define GO_SPOT_SELECTION_TYPE_TOP (1) ///< Select the top-most spot.
2247 #define GO_SPOT_SELECTION_TYPE_BOTTOM (2) ///< Select the bottom-most spot.
2248 #define GO_SPOT_SELECTION_TYPE_NONE (3) ///< Disable spot selection.
2249 #define GO_SPOT_SELECTION_TYPE_CONTINUITY (4) ///< Select most continuous spot
2250 #define GO_SPOT_SELECTION_TYPE_TRANSLUCENT (5) ///< Select translucent spot.
2251  /**@}*/
2252 
2253 /**
2254  * @struct GoTranslucentThreadingMode
2255  * @extends kValue
2256  * @note Supported with G2
2257  * @ingroup GoSdk
2258  * @brief Represents a translucent spot threading mode.
2259  *
2260  * The following enumerators are defined:
2261  * - #GO_TRANSLUCENT_THREADING_MODE_NONE
2262  * - #GO_TRANSLUCENT_THREADING_MODE_BATCHING
2263  */
2265 /** @name GoTranslucentThreadingMode
2266  *@{*/
2267 #define GO_TRANSLUCENT_THREADING_MODE_NONE (0) ///< Single thread mode.
2268 #define GO_TRANSLUCENT_THREADING_MODE_BATCHING (1) ///< Batching mode.
2269  /**@}*/
2270 
2271 /**
2272  * @struct GoProfileStripBaseType
2273  * @extends kValue
2274  * @note Supported with G1, G2
2275  * @ingroup GoSdk-ProfileTools
2276  * @brief Represents a profile strip tool base type.
2277  *
2278  * The following enumerators are defined:
2279  * - #GO_PROFILE_STRIP_BASE_TYPE_NONE
2280  * - #GO_PROFILE_STRIP_BASE_TYPE_FLAT
2281  */
2283 /** @name GoProfileStripBaseType
2284  *@{*/
2285 #define GO_PROFILE_STRIP_BASE_TYPE_NONE (0) ///< No strip base type.
2286 #define GO_PROFILE_STRIP_BASE_TYPE_FLAT (1) ///< Flat strip base type.
2287 /**@}*/
2288 
2289 /**
2290  * @struct GoProfileStripEdgeType
2291  * @extends kValue
2292  * @note Supported with G1, G2
2293  * @ingroup GoSdk-ProfileTools
2294  * @brief Represents a profile strip tool edge type.
2295  *
2296  * The following enumerators are defined:
2297  * - #GO_PROFILE_STRIP_EDGE_TYPE_RISING
2298  * - #GO_PROFILE_STRIP_EDGE_TYPE_FALLING
2299  * - #GO_PROFILE_STRIP_EDGE_TYPE_DATA_END
2300  * - #GO_PROFILE_STRIP_EDGE_TYPE_VOID
2301  */
2303 /** @name GoProfileStripEdgeType
2304  *@{*/
2305 #define GO_PROFILE_STRIP_EDGE_TYPE_RISING (1) ///< Rising strip edge type.
2306 #define GO_PROFILE_STRIP_EDGE_TYPE_FALLING (2) ///< Falling strip edge type.
2307 #define GO_PROFILE_STRIP_EDGE_TYPE_DATA_END (4) ///< Data end strip edge type.
2308 #define GO_PROFILE_STRIP_EDGE_TYPE_VOID (8) ///< Void strip edge type.
2309 /**@}*/
2310 
2311 
2312 /**
2313  * @struct GoProfileFeatureType
2314  * @note Supported with G1, G2
2315  * @ingroup GoSdk-ProfileTools
2316  * @brief Represents a profile feature point type.
2317  *
2318  * The following enumerators are defined:
2319  * - #GO_PROFILE_FEATURE_TYPE_MAX_Z
2320  * - #GO_PROFILE_FEATURE_TYPE_MIN_Z
2321  * - #GO_PROFILE_FEATURE_TYPE_MAX_X
2322  * - #GO_PROFILE_FEATURE_TYPE_MIN_X
2323  * - #GO_PROFILE_FEATURE_TYPE_CORNER
2324  * - #GO_PROFILE_FEATURE_TYPE_AVERAGE
2325  * - #GO_PROFILE_FEATURE_TYPE_RISING_EDGE
2326  * - #GO_PROFILE_FEATURE_TYPE_FALLING_EDGE
2327  * - #GO_PROFILE_FEATURE_TYPE_ANY_EDGE
2328  * - #GO_PROFILE_FEATURE_TYPE_TOP_CORNER
2329  * - #GO_PROFILE_FEATURE_TYPE_BOTTOM_CORNER
2330  * - #GO_PROFILE_FEATURE_TYPE_LEFT_CORNER
2331  * - #GO_PROFILE_FEATURE_TYPE_RIGHT_CORNER
2332  * - #GO_PROFILE_FEATURE_TYPE_MEDIAN
2333  */
2334 typedef k32s GoProfileFeatureType;
2335 /** @name GoProfileFeatureType
2336  *@{*/
2337 #define GO_PROFILE_FEATURE_TYPE_MAX_Z (0) ///< Point with the maximum Z value.
2338 #define GO_PROFILE_FEATURE_TYPE_MIN_Z (1) ///< Point with the minimum Z value.
2339 #define GO_PROFILE_FEATURE_TYPE_MAX_X (2) ///< Point with the maximum X value.
2340 #define GO_PROFILE_FEATURE_TYPE_MIN_X (3) ///< Point with the minimum X value.
2341 #define GO_PROFILE_FEATURE_TYPE_CORNER (4) ///< Dominant corner.
2342 #define GO_PROFILE_FEATURE_TYPE_AVERAGE (5) ///< Average of points.
2343 #define GO_PROFILE_FEATURE_TYPE_RISING_EDGE (6) ///< Rising edge.
2344 #define GO_PROFILE_FEATURE_TYPE_FALLING_EDGE (7) ///< Falling edge.
2345 #define GO_PROFILE_FEATURE_TYPE_ANY_EDGE (8) ///< Rising or falling edge.
2346 #define GO_PROFILE_FEATURE_TYPE_TOP_CORNER (9) ///< Top-most corner.
2347 #define GO_PROFILE_FEATURE_TYPE_BOTTOM_CORNER (10) ///< Bottom-most corner.
2348 #define GO_PROFILE_FEATURE_TYPE_LEFT_CORNER (11) ///< Left-most corner.
2349 #define GO_PROFILE_FEATURE_TYPE_RIGHT_CORNER (12) ///< Right-most corner.
2350 #define GO_PROFILE_FEATURE_TYPE_MEDIAN (13) ///< Median of points.
2351 /**@}*/
2352 
2353 /**
2354  * @struct GoProfileGapAxis
2355  * @note Supported with G1, G2
2356  * @ingroup GoSdk-ProfileTools
2357  * @brief Represents a profile gap measurement axis.
2358  *
2359  * The following enumerators are defined:
2360  * - #GO_PROFILE_GAP_AXIS_EDGE
2361  * - #GO_PROFILE_GAP_AXIS_SURFACE
2362  * - #GO_PROFILE_GAP_AXIS_DISTANCE
2363  */
2364 typedef k32s GoProfileGapAxis;
2365 /** @name GoProfileGapAxis
2366  *@{*/
2367 #define GO_PROFILE_GAP_AXIS_EDGE (0) ///< Measure the gap along the edge normal.
2368 #define GO_PROFILE_GAP_AXIS_SURFACE (1) ///< Measure the gap along the surface line.
2369 #define GO_PROFILE_GAP_AXIS_DISTANCE (2) ///< Measure the shortest distance between the two edges.
2370 /**@}*/
2371 
2372 /**
2373  * @struct GoProfileEdgeType
2374  * @note Supported with G1, G2
2375  * @ingroup GoSdk-ProfileTools
2376  * @brief Represents a profile edge type.
2377  *
2378  * The following enumerators are defined:
2379  * - #GO_PROFILE_EDGE_TYPE_TANGENT
2380  * - #GO_PROFILE_EDGE_TYPE_CORNER
2381  */
2382 typedef k32s GoProfileEdgeType;
2383 /** @name GoProfileEdgeType
2384  *@{*/
2385 #define GO_PROFILE_EDGE_TYPE_TANGENT (0) ///< Detect the edge by looking for the tangent.
2386 #define GO_PROFILE_EDGE_TYPE_CORNER (1) ///< Detect the edge by looking for the corner.
2387 /**@}*/
2388 
2389 /**
2390  * @struct GoProfileBaseline
2391  * @note Supported with G1, G2
2392  * @ingroup GoSdk-ProfileTools
2393  * @brief Determines whether to use a line based on a Profile Line fit, or based on the x-axis.
2394  *
2395  * The following enumerators are defined:
2396  * - #GO_PROFILE_BASELINE_TYPE_X_AXIS
2397  * - #GO_PROFILE_BASELINE_TYPE_Z_AXIS
2398  * - #GO_PROFILE_BASELINE_TYPE_LINE
2399  */
2400 typedef k32s GoProfileBaseline;
2401 /** @name GoProfileBaseline
2402  *@{*/
2403 #define GO_PROFILE_BASELINE_TYPE_X_AXIS (0) ///< Use the X-Axis.
2404 #define GO_PROFILE_BASELINE_TYPE_Z_AXIS (1) ///< Use the Z-Axis.
2405 #define GO_PROFILE_BASELINE_TYPE_LINE (2) ///< Use the line fit.
2406 /**@}*/
2407 
2408 /**
2409  * @struct GoProfileAreaType
2410  * @note Supported with G1, G2
2411  * @ingroup GoSdk-ProfileTools
2412  * @brief Determines how to calculate profile area
2413  *
2414  * The following enumerators are defined:
2415  * - #GO_PROFILE_AREA_TYPE_OBJECT
2416  * - #GO_PROFILE_AREA_TYPE_CLEARANCE
2417  */
2418 typedef k32s GoProfileAreaType;
2419 /** @name GoProfileAreaType
2420  *@{*/
2421 #define GO_PROFILE_AREA_TYPE_OBJECT (0) ///< Sum the profile area that is above the line.
2422 #define GO_PROFILE_AREA_TYPE_CLEARANCE (1) ///< Sum the profile area that is below the line.
2423 /**@}*/
2424 
2425 /**
2426  * @struct GoProfileGapSide
2427  * @note Supported with G1, G2
2428  * @ingroup GoSdk-ProfileTools
2429  * @brief Selects which edge to use as the reference in a panel tool.
2430  *
2431  * The following enumerators are defined:
2432  * - #GO_PROFILE_PANEL_SIDE_LEFT
2433  * - #GO_PROFILE_PANEL_SIDE_RIGHT
2434  */
2435 typedef k32s GoProfilePanelSide;
2436 /** @name GoProfilePanelSide
2437  *@{*/
2438 #define GO_PROFILE_PANEL_SIDE_LEFT (0) ///< Use the left edge.
2439 #define GO_PROFILE_PANEL_SIDE_RIGHT (1) ///< Use the right edge.
2440 /**@}*/
2441 
2442 /**
2443  * @struct GoProfileRoundCornerDirection
2444  * @note Supported with G1, G2
2445  * @ingroup GoSdk-ProfileTools
2446  * @brief Selects which reference direction to use for the round corner tool.
2447  *
2448  * The following enumerators are defined:
2449  * - #GO_PROFILE_ROUND_CORNER_DIRECTION_LEFT
2450  * - #GO_PROFILE_ROUND_CORNER_DIRECTION_RIGHT
2451  */
2452 
2454 /** @name GoProfileRoundCornerDirection
2455  *@{*/
2456 #define GO_PROFILE_ROUND_CORNER_DIRECTION_LEFT (0) ///< Use the left edge.
2457 #define GO_PROFILE_ROUND_CORNER_DIRECTION_RIGHT (1) ///< Use the right edge.
2458 /**@}*/
2459 
2460 /**
2461  * @struct GoProfileGrooveShape
2462  * @note Supported with G1, G2
2463  * @ingroup GoSdk-ProfileTools
2464  * @brief Represents a profile edge type.
2465  *
2466  * The following enumerators are defined:
2467  * - #GO_PROFILE_GROOVE_SHAPE_U
2468  * - #GO_PROFILE_GROOVE_SHAPE_V
2469  * - #GO_PROFILE_GROOVE_SHAPE_OPEN
2470  */
2471 typedef k32s GoProfileGrooveShape;
2472 /** @name GoProfileGrooveShape
2473  *@{*/
2474 #define GO_PROFILE_GROOVE_SHAPE_U (0) ///< Detect grooves that are U shaped.
2475 #define GO_PROFILE_GROOVE_SHAPE_V (1) ///< Detect grooves that are V shaped.
2476 #define GO_PROFILE_GROOVE_SHAPE_OPEN (2) ///< Detect grooves that are open.
2477 /**@}*/
2478 
2479 /**
2480  * @struct GoProfileGrooveSelectType
2481  * @note Supported with G1, G2
2482  * @ingroup GoSdk-ProfileTools
2483  * @brief Determines which groove to select when multiple are present.
2484  *
2485  * The following enumerators are defined:
2486  * - #GO_PROFILE_GROOVE_SELECT_TYPE_MAX_DEPTH
2487  * - #GO_PROFILE_GROOVE_SELECT_TYPE_LEFT_INDEX
2488  * - #GO_PROFILE_GROOVE_SELECT_TYPE_RIGHT_INDEX
2489  */
2491 /** @name GoProfileGrooveSelectType
2492  *@{*/
2493 #define GO_PROFILE_GROOVE_SELECT_TYPE_MAX_DEPTH (0) ///< Select the groove with the maximum depth.
2494 #define GO_PROFILE_GROOVE_SELECT_TYPE_LEFT_INDEX (1) ///< Select the groove with the currently selected index starting from the left side.
2495 #define GO_PROFILE_GROOVE_SELECT_TYPE_RIGHT_INDEX (2) ///< Select the groove with the currently selected index starting from the right side.
2496 /**@}*/
2497 
2498 /**
2499  * @struct GoProfileGrooveLocation
2500  * @note Supported with G1, G2
2501  * @ingroup GoSdk-ProfileTools
2502  * @brief Determines which groove position to return.
2503  *
2504  * The following enumerators are defined:
2505  * - #GO_PROFILE_GROOVE_LOCATION_BOTTOM
2506  * - #GO_PROFILE_GROOVE_LOCATION_LEFT
2507  * - #GO_PROFILE_GROOVE_LOCATION_RIGHT
2508  */
2510 /** @name GoProfileGrooveLocation
2511  *@{*/
2512 #define GO_PROFILE_GROOVE_LOCATION_BOTTOM (0) ///< Return the position of the bottom of the groove.
2513 #define GO_PROFILE_GROOVE_LOCATION_LEFT (1) ///< Return the position of the left corner of the groove.
2514 #define GO_PROFILE_GROOVE_LOCATION_RIGHT (2) ///< Return the position of the right corner of the groove.
2515 /**@}*/
2516 
2517 /**
2518  * @struct GoProfileStripSelectType
2519  * @note Supported with G1, G2
2520  * @ingroup GoSdk-ProfileTools
2521  * @brief Determines which Strip to select when multiple are present.
2522  *
2523  * The following enumerators are defined:
2524  * - #GO_PROFILE_STRIP_SELECT_TYPE_BEST
2525  * - #GO_PROFILE_STRIP_SELECT_TYPE_LEFT_INDEX
2526  * - #GO_PROFILE_STRIP_SELECT_TYPE_RIGHT_INDEX
2527  */
2529 /** @name GoProfileStripSelectType
2530  *@{*/
2531 #define GO_PROFILE_STRIP_SELECT_TYPE_BEST (0) ///< Select the best strip.
2532 #define GO_PROFILE_STRIP_SELECT_TYPE_LEFT_INDEX (1) ///< Select the strip with the currently selected index starting from the left side.
2533 #define GO_PROFILE_STRIP_SELECT_TYPE_RIGHT_INDEX (2) ///< Select the strip with the currently selected index starting from the right side.
2534 /**@}*/
2535 
2536 /**
2537  * @struct GoProfileStripLocation
2538  * @note Supported with G1, G2
2539  * @ingroup GoSdk-ProfileTools
2540  * @brief Determines which Strip position to return.
2541  *
2542  * The following enumerators are defined:
2543  * - #GO_PROFILE_STRIP_LOCATION_LEFT
2544  * - #GO_PROFILE_STRIP_LOCATION_RIGHT
2545  * - #GO_PROFILE_STRIP_LOCATION_BOTTOM
2546  */
2548 /** @name GoProfileStripLocation
2549  *@{*/
2550 #define GO_PROFILE_STRIP_LOCATION_LEFT (0) ///< Return the position of the left corner of the Strip.
2551 #define GO_PROFILE_STRIP_LOCATION_RIGHT (1) ///< Return the position of the right corner of the Strip.
2552 #define GO_PROFILE_STRIP_LOCATION_BOTTOM (2) ///< Return the position of the center of the Strip.
2553 /**@}*/
2554 
2555 /**
2556 * @struct GoProfileGenerationType
2557 * @extends kValue
2558 * @note Supported with G1, G2
2559 * @brief Represents a profile generation type.
2560 *
2561 * The following enumerators are defined:
2562 * - #GO_PROFILE_GENERATION_TYPE_CONTINUOUS
2563 * - #GO_PROFILE_GENERATION_TYPE_FIXED_LENGTH
2564 * - #GO_PROFILE_GENERATION_TYPE_VARIABLE_LENGTH
2565 * - #GO_PROFILE_GENERATION_TYPE_ROTATIONAL
2566 */
2568 /** @name GoProfileGenerationType
2569 *@{*/
2570 #define GO_PROFILE_GENERATION_TYPE_CONTINUOUS (0) ///< Continuous Profile generation.
2571 #define GO_PROFILE_GENERATION_TYPE_FIXED_LENGTH (1) ///< Fixed length Profile generation.
2572 #define GO_PROFILE_GENERATION_TYPE_VARIABLE_LENGTH (2) ///< Variable length Profile generation.
2573 #define GO_PROFILE_GENERATION_TYPE_ROTATIONAL (3) ///< Rotational Profile generation.
2574 /**@}*/
2575 
2576 /**
2577 * @struct GoProfileGenerationStartTrigger
2578 * @extends kValue
2579 * @note Supported with G1, G2
2580 * @ingroup GoSdk-Profile
2581 * @brief Represents a profile generation start trigger.
2582 *
2583 * The following enumerators are defined:
2584 * - #GO_PROFILE_GENERATION_START_TRIGGER_SEQUENTIAL
2585 * - #GO_PROFILE_GENERATION_START_TRIGGER_DIGITAL
2586 */
2588 /** @name GoProfileGenerationStartTrigger
2589 *@{*/
2590 #define GO_PROFILE_GENERATION_START_TRIGGER_SEQUENTIAL (0) ///< Sequential start trigger.
2591 #define GO_PROFILE_GENERATION_START_TRIGGER_DIGITAL (1) ///< Digital input start trigger.
2592 /**@}*/
2593 
2594 /**
2595  * @struct GoPartFrameOfReference
2596  * @extends kValue
2597  * @note Supported with G2, G3
2598  * @ingroup GoSdk
2599  * @brief Represents a part detection frame of reference.
2600  *
2601  * The following enumerators are defined:
2602  * - #GO_PART_FRAME_OF_REFERENCE_TYPE_SENSOR
2603  * - #GO_PART_FRAME_OF_REFERENCE_TYPE_SCAN
2604  * - #GO_PART_FRAME_OF_REFERENCE_TYPE_PART
2605  */
2607 /** @name GoPartFrameOfReference
2608  *@{*/
2609 #define GO_PART_FRAME_OF_REFERENCE_TYPE_SENSOR (0) ///< Sensor frame of reference. 2x00 only.
2610 #define GO_PART_FRAME_OF_REFERENCE_TYPE_SCAN (0) ///< Scan frame of reference. 3x00 only. Value duplication is intentional.
2611 #define GO_PART_FRAME_OF_REFERENCE_TYPE_PART (1) ///< Part frame of reference.
2612 /**@}*/
2613 
2614 /**
2615  * @struct GoPartHeightThresholdDirection
2616  * @extends kValue
2617  * @note Supported with G2, G3
2618  * @ingroup GoSdk-Surface
2619  * @brief Represents a part detection height threshold direction.
2620  *
2621  * The following enumerators are defined:
2622  * - #GO_PART_HEIGHT_THRESHOLD_DIRECTION_ABOVE
2623  * - #GO_PART_HEIGHT_THRESHOLD_DIRECTION_BELOW
2624  */
2626 /** @name GoPartHeightThresholdDirection
2627  *@{*/
2628 #define GO_PART_HEIGHT_THRESHOLD_DIRECTION_ABOVE (0) ///< Height threshold direction is above the Z-axis.
2629 #define GO_PART_HEIGHT_THRESHOLD_DIRECTION_BELOW (1) ///< Height threshold direction is below the Z-axis.
2630 /**@}*/
2631 
2632 /**
2633  * @struct GoSurfaceGenerationType
2634  * @extends kValue
2635  * @note Supported with G2, G3
2636  * @ingroup GoSdk-Surface
2637  * @brief Represents a surface generation type.
2638  *
2639  * The following enumerators are defined:
2640  * - #GO_SURFACE_GENERATION_TYPE_CONTINUOUS
2641  * - #GO_SURFACE_GENERATION_TYPE_FIXED_LENGTH
2642  * - #GO_SURFACE_GENERATION_TYPE_VARIABLE_LENGTH
2643  * - #GO_SURFACE_GENERATION_TYPE_ROTATIONAL
2644  */
2646 /** @name GoSurfaceGenerationType
2647  *@{*/
2648 #define GO_SURFACE_GENERATION_TYPE_CONTINUOUS (0) ///< Continuous surface generation.
2649 #define GO_SURFACE_GENERATION_TYPE_FIXED_LENGTH (1) ///< Fixed length surface generation.
2650 #define GO_SURFACE_GENERATION_TYPE_VARIABLE_LENGTH (2) ///< Variable length surface generation.
2651 #define GO_SURFACE_GENERATION_TYPE_ROTATIONAL (3) ///< Rotational surface generation.
2652 /**@}*/
2653 
2654 /**
2655  * @struct GoSurfaceGenerationStartTrigger
2656  * @extends kValue
2657  * @note Supported with G2, G3
2658  * @ingroup GoSdk-Surface
2659  * @brief Represents a surface generation start trigger.
2660  *
2661  * The following enumerators are defined:
2662  * - #GO_SURFACE_GENERATION_START_TRIGGER_SEQUENTIAL
2663  * - #GO_SURFACE_GENERATION_START_TRIGGER_DIGITAL
2664  * - #GO_SURFACE_GENERATION_START_TRIGGER_SOFTWARE
2665  */
2667 /** @name GoSurfaceGenerationStartTrigger
2668  *@{*/
2669 #define GO_SURFACE_GENERATION_START_TRIGGER_SEQUENTIAL (0) ///< Sequential start trigger.
2670 #define GO_SURFACE_GENERATION_START_TRIGGER_DIGITAL (1) ///< Digital input start trigger.
2671 #define GO_SURFACE_GENERATION_START_TRIGGER_SOFTWARE (2) ///< Software start trigger.
2672  /**@}*/
2673 
2674 /**
2675  * @struct GoSurfaceLocation
2676  * @note Supported with G2, G3
2677  * @ingroup GoSdk-SurfaceTools
2678  * @brief Represents a surface location.
2679  *
2680  * The following enumerators are defined:
2681  * - #GO_SURFACE_LOCATION_TYPE_MAX
2682  * - #GO_SURFACE_LOCATION_TYPE_MIN
2683  * - #GO_SURFACE_LOCATION_TYPE_2D_CENTROID
2684  * - #GO_SURFACE_LOCATION_TYPE_3D_CENTROID
2685  * - #GO_SURFACE_LOCATION_TYPE_AVG
2686  * - #GO_SURFACE_LOCATION_TYPE_MEDIAN
2687  */
2688 typedef k32s GoSurfaceLocation;
2689 /** @name GoSurfaceLocation
2690  *@{*/
2691 #define GO_SURFACE_LOCATION_TYPE_MAX (0) ///< Location based on the maximum point.
2692 #define GO_SURFACE_LOCATION_TYPE_MIN (1) ///< Location based on the minimum point.
2693 #define GO_SURFACE_LOCATION_TYPE_2D_CENTROID (2) ///< Location based on a 2d centroid.
2694 #define GO_SURFACE_LOCATION_TYPE_3D_CENTROID (3) ///< Location based on a 3d centroid.
2695 #define GO_SURFACE_LOCATION_TYPE_AVG (4) ///< Location based on the average point.
2696 #define GO_SURFACE_LOCATION_TYPE_MEDIAN (5) ///< Location based on the median point.
2697 /**@}*/
2698 
2699 /**
2700  * @struct GoSurfaceFeatureType
2701  * @note Supported with G2, G3
2702  * @ingroup GoSdk-SurfaceTools
2703  * @brief Represents a surface feature type.
2704  *
2705  * The following enumerators are defined:
2706  * - #GO_SURFACE_FEATURE_TYPE_AVERAGE
2707  * - #GO_SURFACE_FEATURE_TYPE_CENTROID
2708  * - #GO_SURFACE_FEATURE_TYPE_X_MAX
2709  * - #GO_SURFACE_FEATURE_TYPE_X_MIN
2710  * - #GO_SURFACE_FEATURE_TYPE_Y_MAX
2711  * - #GO_SURFACE_FEATURE_TYPE_Y_MIN
2712  * - #GO_SURFACE_FEATURE_TYPE_Z_MAX
2713  * - #GO_SURFACE_FEATURE_TYPE_Z_MIN
2714  * - #GO_SURFACE_FEATURE_TYPE_MEDIAN
2715  */
2716 typedef k32s GoSurfaceFeatureType;
2717 /** @name GoSurfaceFeatureType
2718  *@{*/
2719 #define GO_SURFACE_FEATURE_TYPE_AVERAGE (0) ///< Feature based on the average.
2720 #define GO_SURFACE_FEATURE_TYPE_CENTROID (1) ///< Feature based on the centroid.
2721 #define GO_SURFACE_FEATURE_TYPE_X_MAX (2) ///< Feature based on the X maximum point.
2722 #define GO_SURFACE_FEATURE_TYPE_X_MIN (3) ///< Feature based on the X minimum point.
2723 #define GO_SURFACE_FEATURE_TYPE_Y_MAX (4) ///< Feature based on the Y maximum point.
2724 #define GO_SURFACE_FEATURE_TYPE_Y_MIN (5) ///< Feature based on the Y minimum point.
2725 #define GO_SURFACE_FEATURE_TYPE_Z_MAX (6) ///< Feature based on the Z maximum point.
2726 #define GO_SURFACE_FEATURE_TYPE_Z_MIN (7) ///< Feature based on the Z minimum point.
2727 #define GO_SURFACE_FEATURE_TYPE_MEDIAN (8) ///< Feature based on the median.
2728 /**@}*/
2729 
2730 /**
2731  * @struct GoSurfaceCountersunkHoleShape
2732  * @extends kValue
2733  * @note Supported with G2, G3
2734  * @ingroup GoSdk-SurfaceTools
2735  * @brief Represents a surface countersunk hole tool shape.
2736  *
2737  * The following enumerators are defined:
2738  * - #GO_SURFACE_COUNTERSUNK_HOLE_SHAPE_CONE
2739  * - #GO_SURFACE_COUNTERSUNK_HOLE_SHAPE_COUNTERBORE
2740  */
2742 /** @name GoSurfaceCountersunkHoleShape
2743  *@{*/
2744 #define GO_SURFACE_COUNTERSUNK_HOLE_SHAPE_CONE (0) ///< Cone shape.
2745 #define GO_SURFACE_COUNTERSUNK_HOLE_SHAPE_COUNTERBORE (1) ///< Counterbore shape.
2746 /**@}*/
2747 
2748 
2749 /**
2750  * @struct GoSurfaceOpeningType
2751  * @extends kValue
2752  * @note Supported with G2, G3
2753  * @ingroup GoSdk-SurfaceTools
2754  * @brief Represents a surface opening tool type.
2755  *
2756  * The following enumerators are defined:
2757  * - #GO_SURFACE_OPENING_TYPE_ROUNDED_SLOT
2758  * - #GO_SURFACE_OPENING_TYPE_ROUNDED_RECTANGLE
2759  */
2760 typedef k32s GoSurfaceOpeningType;
2761 /** @name GoSurfaceOpeningType
2762  *@{*/
2763 #define GO_SURFACE_OPENING_TYPE_ROUNDED_SLOT (0) ///< Rounded slot opening type.
2764 #define GO_SURFACE_OPENING_TYPE_ROUNDED_RECTANGLE (1) ///< Rectangular opening type.
2765 /**@}*/
2766 
2767 /**
2768 * @struct GoSurfaceRivetType
2769 * @extends kValue
2770 * @ingroup GoSdk-SurfaceTools
2771 * @brief Represents a surface rivet tool type.
2772 *
2773 * The following enumerators are defined:
2774 * - #GO_SURFACE_RIVET_TYPE_FLUSH
2775 * - #GO_SURFACE_RIVET_TYPE_RAISED
2776 */
2777 typedef k32s GoSurfaceRivetType;
2778 /** @name GoSurfaceRivetType
2779 *@{*/
2780 #define GO_SURFACE_RIVET_TYPE_FLUSH (0) ///< Flush rivet type.
2781 #define GO_SURFACE_RIVET_TYPE_RAISED (1) ///< Raised rivet type.
2782 /**@}*/
2783 
2784 /**
2785  * @struct GoPartMatchAlgorithm
2786  * @extends kValue
2787  * @note Supported with G2, G3
2788  * @ingroup GoSdk-Surface
2789  * @brief Represents a part matching algorithm.
2790  *
2791  * The following enumerators are defined:
2792  * - #GO_PART_MATCH_ALGORITHM_EDGE
2793  * - #GO_PART_MATCH_ALGORITHM_BOUNDING_BOX
2794  * - #GO_PART_MATCH_ALGORITHM_ELLIPSE
2795  */
2796 typedef k32s GoPartMatchAlgorithm;
2797 /** @name GoPartMatchAlgorithm
2798  *@{*/
2799 #define GO_PART_MATCH_ALGORITHM_EDGE (0) ///< Edge based part match algorithm.
2800 #define GO_PART_MATCH_ALGORITHM_BOUNDING_BOX (1) ///< Bounding box based part match algorithm.
2801 #define GO_PART_MATCH_ALGORITHM_ELLIPSE (2) ///< Ellipse based part match algorithm.
2802 /**@}*/
2803 
2804 
2805 /**
2806  * @struct GoBoxAsymmetryType
2807  * @extends kValue
2808  * @note Supported with G2, G3
2809  * @ingroup GoSdk-Surface
2810  * @brief Represents the bounding box part matching asymmetry detection type.
2811  *
2812  * The following enumerators are defined:
2813  * - #GO_BOX_ASYMMETRY_TYPE_NONE
2814  * - #GO_BOX_ASYMMETRY_TYPE_ALONG_LENGTH_AXIS
2815  * - #GO_BOX_ASYMMETRY_TYPE_ALONG_WIDTH_AXIS
2816  */
2817 typedef k32s GoBoxAsymmetryType;
2818 /** @name GoBoxAsymmetryType
2819  *@{*/
2820 #define GO_BOX_ASYMMETRY_TYPE_NONE (0) ///< None
2821 #define GO_BOX_ASYMMETRY_TYPE_ALONG_LENGTH_AXIS (1) ///< Along Length axis
2822 #define GO_BOX_ASYMMETRY_TYPE_ALONG_WIDTH_AXIS (2) ///< Along Width axis
2823 /**@}*/
2824 
2825 /**
2826  * @struct GoEllipseAsymmetryType
2827  * @extends kValue
2828  * @note Supported with G2, G3
2829  * @ingroup GoSdk-Surface
2830  * @brief Represents the bounding Ellipse part matching asymmetry detection type.
2831  *
2832  * The following enumerators are defined:
2833  * - #GO_ELLIPSE_ASYMMETRY_TYPE_NONE
2834  * - #GO_ELLIPSE_ASYMMETRY_TYPE_ALONG_MAJOR_AXIS
2835  * - #GO_ELLIPSE_ASYMMETRY_TYPE_ALONG_MINOR_AXIS
2836  */
2838 /** @name GoEllipseAsymmetryType
2839  *@{*/
2840 #define GO_ELLIPSE_ASYMMETRY_TYPE_NONE (0) ///< None
2841 #define GO_ELLIPSE_ASYMMETRY_TYPE_ALONG_MAJOR_AXIS (1) ///< Along Major axis
2842 #define GO_ELLIPSE_ASYMMETRY_TYPE_ALONG_MINOR_AXIS (2) ///< Along Minor axis
2843 /**@}*/
2844 
2845 
2846 #define GO_SURFACE_COUNTERSUNK_HOLE_MAX_REF_REGIONS (2) ///< The maximum number of reference regions permitted for the Surface Counter Sunk Hole Tool.
2847 #define GO_SURFACE_HOLE_MAX_REF_REGIONS (2) ///< The maximum number of reference regions permitted for the Surface Hole Tool.
2848 #define GO_SURFACE_OPENING_MAX_REF_REGIONS (2) ///< The maximum number of reference regions permitted for the Surface Opening Tool.
2849 #define GO_SURFACE_PLANE_MAX_REGIONS (4) ///< The maximum number of reference regions permitted for the Surface Plane Tool.
2850 #define GO_SURFACE_RIVET_MAX_REF_REGIONS (2) ///< The maximum number of reference regions permitted for the Surface Rivet Tool.
2851 #define GO_SURFACE_STUD_MAX_REF_REGIONS (2) ///< The maximum number of reference regions permitted for the Surface Stud Tool.
2852 
2853 /**
2854  * @struct GoImageType
2855  * @extends kValue
2856  * @note Supported with G2, G3
2857  * @ingroup GoSdk
2858  * @brief Represents an image type.
2859  *
2860  * The following enumerators are defined:
2861  * - #GO_IMAGE_TYPE_HEIGHTMAP
2862  * - #GO_IMAGE_TYPE_INTENSITY
2863  */
2864 typedef k32s GoImageType;
2865 /** @name GoImageType
2866  *@{*/
2867 #define GO_IMAGE_TYPE_HEIGHTMAP (0) ///< Heightmap image type.
2868 #define GO_IMAGE_TYPE_INTENSITY (1) ///< Intensity image type.
2869 /**@}*/
2870 
2871 /**
2872  * @struct GoSurfaceEncoding
2873  * @extends kValue
2874  * @note Supported with G2, G3
2875  * @ingroup GoSdk
2876  * @brief Represents a surface scanning engine encoding type
2877  *
2878  * The following enumerators are defined:
2879  * - #GO_SURFACE_ENCODING_STANDARD
2880  * - #GO_SURFACE_ENCODING_INTERREFLECTION
2881  */
2882 typedef k32s GoSurfaceEncoding;
2883 /** @name GoSurfaceEncoding
2884  *@{*/
2885 #define GO_SURFACE_ENCODING_STANDARD (0) ///< Standard Phase Encoding
2886 #define GO_SURFACE_ENCODING_INTERREFLECTION (1) ///< Interreflection Encoding (Advanced Users Only)
2887 /**@}*/
2888 
2889 /**
2890  * @struct GoSurfacePhaseFilter
2891  * @extends kValue
2892  * @note Supported with G2, G3
2893  * @ingroup GoSdk
2894  * @brief Represents a surface phase filter type
2895  *
2896  * The following enumerators are defined:
2897  * - #GO_SURFACE_PHASE_FILTER_NONE
2898  * - #GO_SURFACE_PHASE_FILTER_REFLECTIVE
2899  * - #GO_SURFACE_PHASE_FILTER_TRANSLUCENT
2900  */
2901 typedef k32s GoSurfacePhaseFilter;
2902 /** @name GoSurfacePhaseFilter
2903  *@{*/
2904 #define GO_SURFACE_PHASE_FILTER_NONE (0) ///< Standard
2905 #define GO_SURFACE_PHASE_FILTER_REFLECTIVE (1) ///< Reflective Phase Filters
2906 #define GO_SURFACE_PHASE_FILTER_TRANSLUCENT (2) ///< Translucent Phase Filters
2907 /**@}*/
2908 
2909 /**
2910  * @struct GoHdrMode
2911  * @extends kValue
2912  * @ingroup GoSdk
2913  * @brief Represents an HDR mode.
2914  *
2915  * The following enumerators are defined:
2916  * - #GO_HDR_MODE_DISABLED
2917  * - #GO_HDR_MODE_GAMMA
2918  */
2919 typedef k32s GoHdrMode;
2920 /** @name GoHdrMode
2921  *@{*/
2922 #define GO_HDR_MODE_DISABLED (0) ///< HDR mode disabled.
2923 #define GO_HDR_MODE_GAMMA (1) ///< HDR mode set to Gamma Compression
2924  /**@}*/
2925 
2926 /**
2927  * @struct GoGammaType
2928  * @extends kValue
2929  * @ingroup GoSdk
2930  * @brief Represents an advanced gamma type.
2931  *
2932  * The following enumerators are defined:
2933  * - #GO_GAMMA_TYPE_NONE
2934  * - #GO_GAMMA_TYPE_LOW
2935  * - #GO_GAMMA_TYPE_MEDIUM
2936  * - #GO_GAMMA_TYPE_HIGH
2937  */
2938 typedef k32s GoGammaType;
2939 /** @name GoGammaType
2940  *@{*/
2941 #define GO_GAMMA_TYPE_NONE (0) ///< None. No imager gamma / multi-slope configuration will occur.
2942 #define GO_GAMMA_TYPE_LOW (1) ///< Low.
2943 #define GO_GAMMA_TYPE_MEDIUM (2) ///< Medium.
2944 #define GO_GAMMA_TYPE_HIGH (3) ///< High.
2945 /**@}*/
2946 
2947 /**
2948  * @struct GoPatternSequenceType
2949  * @extends kValue
2950  * @ingroup GoSdk
2951  * @brief Represents a pattern sequence type.
2952  *
2953  * The following enumerators are defined:
2954  * - #GO_PATTERN_SEQUENCE_TYPE_DEFAULT
2955  * - #GO_PATTERN_SEQUENCE_TYPE_CUSTOM
2956  *
2957  */
2958 typedef k32s GoPatternSequenceType;
2959 /** @name GoPatternSequenceType
2960  *@{*/
2961 
2962 #define GO_PATTERN_SEQUENCE_TYPE_DEFAULT (0) ///< Default sequence pattern.
2963 #define GO_PATTERN_SEQUENCE_TYPE_CUSTOM (100) ///< Custom sequence pattern.
2964 #define GO_PATTERN_SEQUENCE_TYPE_FOCUS (101) ///< Focus pattern (G3506 only).
2965 #define GO_PATTERN_SEQUENCE_TYPE_STANDARD_SEQUENCE (102) ///< Standard sequence pattern (G3 only).
2966 #define GO_PATTERN_SEQUENCE_TYPE_PROJECTOR_OFF (103) ///< Pattern with disabled LED light (G3 only).
2967 /**@}*/
2968 
2969 #define GO_PATTERN_SEQUENCE_TYPE_FOCUS_AID (101) ///< @deprecated use GO_PATTERN_SEQUENCE_TYPE_FOCUS instead
2970 
2971 /**
2972  * @struct GoImplicitTriggerOverride
2973  * @extends kValue
2974  * @ingroup GoSdk
2975  * @brief Represents an EthernetIP implicit messaging trigger override.
2976  *
2977  * The following enumerators are defined:
2978  * - #GO_IMPLICIT_TRIGGER_OVERRIDE_OFF
2979  * - #GO_IMPLICIT_TRIGGER_OVERRIDE_CYCLIC
2980  * - #GO_IMPLICIT_TRIGGER_OVERRIDE_CHANGE_OF_STATE
2981  *
2982  */
2984 /** @name GoImplicitTriggerOverride
2985  *@{*/
2986 
2987 #define GO_IMPLICIT_TRIGGER_OVERRIDE_OFF (0) ///< Use the implicit output trigger specified in the connection header.
2988 #define GO_IMPLICIT_TRIGGER_OVERRIDE_CYCLIC (1) ///< Utilize cyclic implicit messaging trigger behavior regardless of what is specified in the connection header.
2989 #define GO_IMPLICIT_TRIGGER_OVERRIDE_CHANGE_OF_STATE (2) ///< Utilize change of state implicit messaging trigger behavior regardless of what is specified in the connection header.
2990 /**@}*/
2991 
2992 /**
2993  * @struct GoAlignmentStatus
2994  * @extends kValue
2995  * @ingroup GoSdk
2996  * @brief Represents the operation status of an alignment. GoAlignmentStatus is an extension
2997  * from kStatus, so it includes all of the status codes in kStatus.
2998  *
2999  * The following enumerators are defined:
3000  * - #GO_ALIGNMENT_STATUS_OK
3001  * - #GO_ALIGNMENT_STATUS_GENERAL_FAILURE
3002  * - #GO_ALIGNMENT_STATUS_STATIONARY_NO_DATA
3003  * - #GO_ALIGNMENT_STATUS_MOVING_INSUFFICIENT_DATA
3004  * - #GO_ALIGNMENT_STATUS_INVALID_TARGET
3005  * - #GO_ALIGNMENT_STATUS_UNEXPECTED_TARGET_POSITION
3006  * - #GO_ALIGNMENT_STATUS_BAR_HOLE_NOT_FOUND
3007  * - #GO_ALIGNMENT_STATUS_MOVING_NO_ENCODER_CHANGE
3008  * - #GO_ALIGNMENT_STATUS_TOO_FEW_PROFILES
3009  * - #GO_ALIGNMENT_STATUS_ABORT
3010  * - #GO_ALIGNMENT_STATUS_TIMEOUT
3011  * - #GO_ALIGNMENT_STATUS_INVALID_PARAMETER
3012  *
3013  */
3014 typedef k32s GoAlignmentStatus;
3015 /** @name GoAlignmentStatus
3016  *@{*/
3017 
3018 #define GO_ALIGNMENT_STATUS_OK (1) ///< Alignment operation succeeded.
3019 #define GO_ALIGNMENT_STATUS_GENERAL_FAILURE (0) ///< Alignment operation failed.
3020 #define GO_ALIGNMENT_STATUS_STATIONARY_NO_DATA (-1) ///< Stationary alignment failed due to no data being received. Please ensure the target is in range.
3021 #define GO_ALIGNMENT_STATUS_MOVING_INSUFFICIENT_DATA (-2) ///< Moving alignment failed due to insufficient data.
3022 #define GO_ALIGNMENT_STATUS_INVALID_TARGET (-3) ///< Invalid target detected. Examples include the target dimensions being too small, the target touches both sides of the field of view, or there is insufficient data after some internal filtering.
3023 #define GO_ALIGNMENT_STATUS_UNEXPECTED_TARGET_POSITION (-4) ///< Target detected in an unexpected position. Please ensure the target is stable and there are no obstructions.
3024 #define GO_ALIGNMENT_STATUS_BAR_HOLE_NOT_FOUND (-5) ///< No reference hole was found during bar alignment. Please ensure the holes can be seen and that the target parameters match their physical dimensions.
3025 #define GO_ALIGNMENT_STATUS_MOVING_NO_ENCODER_CHANGE (-6) ///< No change in encoder value occurred during moving alignment. Please ensure the encoder is connected and the target is moving.
3026 #define GO_ALIGNMENT_STATUS_TOO_FEW_PROFILES (-7) ///< The number of profiles are smaller than the minimal number of profiles needed, please ensure that there are enough profiles.
3027 #define GO_ALIGNMENT_STATUS_ABORT (kERROR_ABORT) ///< The alignment was aborted by the user.
3028 #define GO_ALIGNMENT_STATUS_TIMEOUT (kERROR_TIMEOUT) ///< The alignment timed out.
3029 #define GO_ALIGNMENT_STATUS_INVALID_PARAMETER (kERROR_PARAMETER) ///< The alignment failed due to incorrected parameters.
3030 /**@}*/
3031 
3032 typedef struct GoFeatureOption
3033 {
3034  kText64 name;
3035  kSize minCount;
3036  kSize maxCount;
3037  GoFeatureDataType dataType;
3038  kText64 type;
3039 } GoFeatureOption;
3040 
3041 typedef struct GoMeasurementOption
3042 {
3043  kText64 name;
3044  kSize minCount;
3045  kSize maxCount;
3046 } GoMeasurementOption;
3047 
3048 typedef struct GoToolDataOutputOption
3049 {
3050  kText64 name;
3051  kText64 type;
3052  GoDataType dataType;
3053  kSize minCount;
3054  kSize maxCount;
3055 } GoToolDataOutputOption;
3056 
3057 /**
3058  * @struct GoEventType
3059  * @extends kValue
3060  * @ingroup GoSdk
3061  * @brief Represents the event type represented by an event message.
3062  *
3063  * The following enumerator is defined:
3064  * - GO_EVENT_TYPE_EXPOSURE_END
3065  *
3066  */
3067 typedef k32s GoEventType;
3068 /** @name GoEventType
3069  *@{*/
3070 
3071 #define GO_EVENT_TYPE_EXPOSURE_END (1)
3072 /**@}*/
3073 
3074 /**
3075 * @struct GoOcclusionReductionAlg
3076 * @extends kValue
3077 * @ingroup GoSdk
3078 * @brief Represents an occlusion reduction algorithm.
3079 *
3080 * The following enumerators are defined:
3081 * - #GO_OCCLUSION_REDUCTION_NORMAL
3082 * - #GO_OCCLUSION_REDUCTION_HIGH_QUALITY
3083 */
3085 /** @name GoOcclusionReductionAlg
3086 *@{*/
3087 #define GO_OCCLUSION_REDUCTION_NORMAL (0) ///< Basic occlusion reduction.
3088 #define GO_OCCLUSION_REDUCTION_HIGH_QUALITY (1) ///< High quality occlusion reduction.
3089 /**@}*/
3090 
3091 /**
3092 * @struct GoDemosaicStyle
3093 * @extends kValue
3094 * @ingroup GoSdk
3095 * @brief Represents a Bayer demosaic algorithm style.
3096 *
3097 * The following enumerators are defined:
3098 * - #GO_DEMOSAIC_STYLE_REDUCE
3099 * - #GO_DEMOSAIC_STYLE_BILINEAR
3100 * - #GO_DEMOSAIC_STYLE_GRADIENT
3101 */
3102 typedef k32s GoDemosaicStyle;
3103 /** @name GoDemosaicStyle
3104 *@{*/
3105 #define GO_DEMOSAIC_STYLE_REDUCE (0) ///< Simple Reduce (Shrinks image width and height by a factor of 2)
3106 #define GO_DEMOSAIC_STYLE_BILINEAR (1) ///< Bilinear demosaic (Same size output)
3107 #define GO_DEMOSAIC_STYLE_GRADIENT (2) ///< Gradient demosaic (Same size output)
3108 /**@}*/
3109 
3110 /**
3111 * @struct GoDiscoveryOpMode
3112 * @extends kValue
3113 * @ingroup GoSdk-Discovery
3114 * @brief Represents operational mode of the main controller responding
3115 * to the discovery protocol.
3116 *
3117 * The following enumerators are defined:
3118 * - #GO_DISCOVERY_OP_MODE_NOT_AVAILABLE
3119 * - #GO_DISCOVERY_OP_MODE_STANDALONE
3120 * - #GO_DISCOVERY_OP_MODE_VIRTUAL
3121 * - #GO_DISCOVERY_OP_MODE_ACCELERATOR
3122 */
3123 typedef k8u GoDiscoveryOpMode;
3124 /** @name GoDiscoveryOpMode
3125 *@{*/
3126 #define GO_DISCOVERY_OP_MODE_NOT_AVAILABLE (0) ///< Not provided by sensor
3127 #define GO_DISCOVERY_OP_MODE_STANDALONE (1) ///< Sensor is running standalone
3128 #define GO_DISCOVERY_OP_MODE_VIRTUAL (2) ///< Sensor is a virtual sensor
3129 #define GO_DISCOVERY_OP_MODE_ACCELERATOR (3) ///< Sensor is accelerated
3130 /**@}*/
3131 
3132 #define GO_MESH_MSG_NUM_OF_SYSTEM_CHANNEL 6
3133 #define GO_MESH_MSG_NUM_OF_MAX_USER_CHANNEL 5
3134 
3135 typedef k32s GoMeshMsgChannelId;
3136 
3137 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_VERTEX (0)
3138 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_FACET (1)
3139 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_FACET_NORMAL (2)
3140 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_VERTEX_NORMAL (3)
3141 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_VERTEX_TEXTURE (4)
3142 #define GO_MESH_MSG_CHANNEL_ID_SYSTEM_VERTEX_CURVATURE (5)
3143 
3144 typedef k32u GoMeshMsgChannelType;
3145 
3146 #define GO_MESH_MSG_CHANNEL_TYPE_INVALID (0)
3147 #define GO_MESH_MSG_CHANNEL_TYPE_VERTEX (1)
3148 #define GO_MESH_MSG_CHANNEL_TYPE_FACET (2)
3149 #define GO_MESH_MSG_CHANNEL_TYPE_FACET_NORMAL (3)
3150 #define GO_MESH_MSG_CHANNEL_TYPE_VERTEX_NORMAL (4)
3151 #define GO_MESH_MSG_CHANNEL_TYPE_VERTEX_TEXTURE (5)
3152 #define GO_MESH_MSG_CHANNEL_TYPE_VERTEX_CURVATURE (6)
3153 
3154 typedef k32s GoMeshMsgChannelState;
3155 
3156 #define GO_MESH_MSG_CHANNEL_STATE_ERROR (-1)
3157 #define GO_MESH_MSG_CHANNEL_STATE_UNALLOCATED (0)
3158 #define GO_MESH_MSG_CHANNEL_STATE_ALLOCATED (1)
3159 #define GO_MESH_MSG_CHANNEL_STATE_EMPTY (2)
3160 #define GO_MESH_MSG_CHANNEL_STATE_PARTIAL (3)
3161 #define GO_MESH_MSG_CHANNEL_STATE_FULL (4)
3162 
3163 typedef struct GoFacet32u
3164 {
3165  k32u vertex1; // Index of first vertex
3166  k32u vertex2; // Index of second vertex
3167  k32u vertex3; // Index of third vertex
3168 } GoFacet32u;
3169 
3170 typedef struct Go3dTransform64f
3171 {
3172  k64f xx;
3173  k64f xy;
3174  k64f xz;
3175  k64f xt;
3176 
3177  k64f yx;
3178  k64f yy;
3179  k64f yz;
3180  k64f yt;
3181 
3182  k64f zx;
3183  k64f zy;
3184  k64f zz;
3185  k64f zt;
3186 } Go3dTransform64f;
3187 
3188 typedef struct GoMeshMsgChannel
3189 {
3190  GoMeshMsgChannelId id; // channel id
3191  GoMeshMsgChannelType type; // Type of channel
3192  GoMeshMsgChannelState state; // State of channel
3193  k32u flag; // User specified channel flag
3194  kSize allocatedCount; // Allocated buffer size
3195  kSize dataCount; // Actual used buffer size
3196  kType dataType; // buffer data type
3197  kArray1 buffer; // buffer, type of dataType
3198 } GoMeshMsgChannel;
3199 
3200 // Default min/max for the transmit limit GoSetup setting.
3201 #define GO_TRANSMIT_RATE_PERCENT_MIN (1)
3202 #define GO_TRANSMIT_RATE_PERCENT_MAX (100)
3203 
3204 #include <GoSdk/GoSdkDef.x.h>
3205 
3206 #endif
Represents a surface countersunk hole tool shape.
Represents an active area configuration element.
Definition: GoSdkDef.h:974
k64f yAngle
The Y angle of the transformation. (degrees)
Definition: GoSdkDef.h:996
Lists all tool types.
k64f y
The Y offset of the transformed data region. (mm)
Definition: GoSdkDef.h:1009
Sensor state, login, alignment information, recording state, playback source, uptime, playback information, and auto-start setting state.
Definition: GoSdkDef.h:836
Ports used from a source device.
Definition: GoSdkDef.h:877
Represents a data input source.
Represents an output delay domain.
Represents a 32-bit unsigned integer configuration element with a range and enabled state...
Definition: GoSdkDef.h:919
k32s playbackSource
The current playback source of the sensor.
Definition: GoSdkDef.h:843
Represents all possible sources of intensity data.
kBool enabled
Represents whether the element value is currently used.
Definition: GoSdkDef.h:936
k32s systemValue
The system value. (not always applicable)
Definition: GoSdkDef.h:937
Represents a surface feature type.
k16u dataPort
Data channel port.
Definition: GoSdkDef.h:882
Represents a playback seek direction.
kBool enabled
Represents whether the element value is currently used.
Definition: GoSdkDef.h:951
k64f max
The maximum allowable value that can be set for this element.
Definition: GoSdkDef.h:909
GoUser loginType
The logged in user.
Definition: GoSdkDef.h:839
Represents the replay export source type.
Represents an HDR mode.
Represents a prefilter type.
Represents a replay condition type.
k16u controlPort
Control channel port.
Definition: GoSdkDef.h:879
Represents data source selections. Used as a bitmask.
GoAlignmentRef alignmentReference
The alignment reference of the sensor.
Definition: GoSdkDef.h:840
Lists all measurement types.
GoElement64f value
The filter's configuration properties.
Definition: GoSdkDef.h:965
Represents the bounding Ellipse part matching asymmetry detection type.
Represents the possible measurement decision codes.
kBool isAccelerator
The accelerated state of the sensor.
Definition: GoSdkDef.h:849
Represents a surface generation start trigger.
Represents the supported Gocator hardware families.
Represents a surface phase filter type.
GoSecurityLevel security
The security level setup on the sensor: none/basic; when basic level does not allow anonymous users a...
Definition: GoSdkDef.h:853
GoDeviceState sensorState
The state of the sensor.
Definition: GoSdkDef.h:838
Represents possible branding types (for brand customization schemes).
Represents a user role. Use GO_ROLE_MAIN or GOROLE_BUDDYIDX(buddyidx)
kBool enabled
Represents whether the element value is currently used.
Definition: GoSdkDef.h:921
Represents a replay combine type.
Represents an alignment degree of freedom setting.
Represents a replay measurement result.
kBool useDhcp
Sensor uses DHCP?
Definition: GoSdkDef.h:865
Represents a ethernet output protocol.
Represents a surface opening tool type.
Represents a data stream which consists of a data step and ID.
Definition: GoSdkDef.h:1324
Represents a data source.
k32u playbackCount
The playback count.
Definition: GoSdkDef.h:847
Represents a transformed data region.
Definition: GoSdkDef.h:1006
GoElement64f length
The length of the active area. (mm)
Definition: GoSdkDef.h:980
k64f x
The X offset of the transformed data region. (mm)
Definition: GoSdkDef.h:1008
k32u uptimeSec
Sensor uptime in seconds.
Definition: GoSdkDef.h:844
Represents the measurement output decision values. Bit 0 represents the decision value, while bits 1 through 7 represent the decision code, outlined by GoDecisionCode.
GoAlignmentState alignmentState
The alignment state of the sensor.
Definition: GoSdkDef.h:841
Represents a trigger.
k64f y
The Y offset of the transformation. (mm)
Definition: GoSdkDef.h:993
Represents an endian output type.
Represents an alignment element.
Definition: GoSdkDef.h:990
Represents a surface scanning engine encoding type.
Represents a material acquisition type.
Represents either 48V or 24V (with cable length) operation. Only relevant on G3210.
Lists all feature types.
k64f value
The element's double field value.
Definition: GoSdkDef.h:908
Represents a part detection frame of reference.
Lists all feature data types.
Represents a composite data source.
Definition: GoSdkDef.h:1022
GoBuddyState state
Buddy state of this device.
Definition: GoSdkDef.h:895
Represents a profile generation start trigger.
GoElement64f width
The width of the active area. (mm)
Definition: GoSdkDef.h:981
GoElement64f z
The Z offset of the active area. (mm)
Definition: GoSdkDef.h:978
Represents an alignment state.
kBool recordingEnabled
The current state of recording on the sensor.
Definition: GoSdkDef.h:842
kIpAddress gateway
Sensor gateway address.
Definition: GoSdkDef.h:868
Represents operational mode of the main controller responding to the discovery protocol.
kBool autoStartEnabled
The auto-start enabled state.
Definition: GoSdkDef.h:848
Selects which reference direction to use for the round corner tool.
Represents a surface generation type.
Represents a profile edge type.
GoElement64f y
The Y offset of the active area. (mm)
Definition: GoSdkDef.h:977
Determines which groove to select when multiple are present.
Represents a data stream id which consists of a data step, step id and source id. ...
Definition: GoSdkDef.h:1336
k64f min
The minimum allowable value that can be set for this element.
Definition: GoSdkDef.h:910
Represents an advanced gamma type.
Represents a surface location.
Represents an analog output trigger.
Represents an image type.
Represents a 32-bit signed integer configuration element with a range and enabled state...
Definition: GoSdkDef.h:934
Represents all possible intensity generation modes for multiple exposures.
Represents a video message pixel type.
Represents a filter configuration element.
Definition: GoSdkDef.h:962
Represents the status of the Accelerator connection. These are applicable only when using the GoAccel...
Represents an EthernetIP implicit messaging trigger override.
kObject GoAccelerator
Forward declaration for GoAccelerator.
Definition: GoSdkDef.h:233
kIpAddress address
Sensor IP address.
Definition: GoSdkDef.h:866
Represents a Bayer demosaic algorithm style.
Represents a profile strip tool base type.
kBool enabled
Represents whether the element value is currently used. (not always applicable)
Definition: GoSdkDef.h:906
Represents a translucent spot threading mode.
Buddy related status of another sensor.
Definition: GoSdkDef.h:892
Represents the operation status of an alignment. GoAlignmentStatus is an extension from kStatus...
GoBrandingType brandingType
The branding type of the sensor; (for brand customization schemes).
Definition: GoSdkDef.h:854
k64f width
The width of the transformed data region. (mm)
Definition: GoSdkDef.h:1011
Represents a profile strip tool edge type.
Represents the system's primary synchronization domain.
Represents an encoder's triggering behavior.
Represents an ASCII standard format type.
kBool systemValue
The system value. (not always applicable)
Definition: GoSdkDef.h:952
Corner parameters for polygon corner alignment.
Definition: GoSdkDef.h:663
Lists all data message types.
Represents a surface rivet tool type.
k64f progress
Upgrade progress (percentage).
Definition: GoSdkDef.h:73
Represents a sensor orientation type.
Represents a user id.
k32u id
Serial number of the device.
Definition: GoSdkDef.h:894
Determines which groove position to return.
Represents the acceleration status of a sensor that is available or being accelerated by the local ho...
k32u min
The minimum allowable value that can be set for this element.
Definition: GoSdkDef.h:925
Represents an alignment target type.
Represents all possible exposure modes.
k32s min
The minimum allowable value that can be set for this element.
Definition: GoSdkDef.h:940
Represents a replay range count case.
Represents an alignment reference.
Represents output sources.
k64f zAngle
The Z angle of the transformation. (degrees)
Definition: GoSdkDef.h:997
k32s value
The element's 32-bit signed field value.
Definition: GoSdkDef.h:938
k32u value
The element's 32-bit unsigned field value.
Definition: GoSdkDef.h:923
Represents a pattern sequence type.
k32u cableLength
The length of the cable (in millimeters) from the Sensor to the Master.
Definition: GoSdkDef.h:851
Represents an ASCII protocol operational type.
Represents a analog output event.
kIpAddress mask
Sensor subnet bit-mask.
Definition: GoSdkDef.h:867
Represents arguments provided to an upgrade callback function.
Definition: GoSdkDef.h:71
Represents a 64-bit floating point configuration element with a range and enabled state...
Definition: GoSdkDef.h:904
Represents a digital output signal type.
Represents a trigger source type.
Represents spacing interval types.
Represents a profile gap measurement axis.
GoElement64f height
The height of the active area. (mm)
Definition: GoSdkDef.h:979
k32u max
The maximum allowable value that can be set for this element.
Definition: GoSdkDef.h:924
Represents an alignment type.
kBool used
Represents whether the filter field is currently used.
Definition: GoSdkDef.h:964
Represents a profile generation type.
Represents a boolean configuration element with an enabled state.
Definition: GoSdkDef.h:949
Represents the current maximum frame rate limiting source.
Represents an occlusion reduction algorithm.
k16u webPort
Web channel port.
Definition: GoSdkDef.h:881
Determines which Strip to select when multiple are present.
Represents a scan mode.
GoVoltageSetting voltage
Power Source Voltage: 24 or 48 V.
Definition: GoSdkDef.h:850
Represents a digital output event.
k64f systemValue
The system value. (not always applicable)
Definition: GoSdkDef.h:907
GoDataSource dataSource
The data source of the composite data source.
Definition: GoSdkDef.h:1025
Represents the event type represented by an event message.
k64f x
The X offset of the transformation. (mm)
Definition: GoSdkDef.h:992
k32s max
The maximum allowable value that can be set for this element.
Definition: GoSdkDef.h:939
Determines which Strip position to return.
k32u systemValue
The system value. (not always applicable)
Definition: GoSdkDef.h:922
Represents a spot selection type.
k32u uptimeMicrosec
Sensor uptime in microseconds.
Definition: GoSdkDef.h:845
Represents the bounding box part matching asymmetry detection type.
Represents a part detection height threshold direction.
k32u playbackPos
The playback position index.
Definition: GoSdkDef.h:846
Determines how to calculate profile area.
Represents the sensor operational state. Maps to sensor's GsDeviceState.
Represents the selcom format followed on the serial output.
k32s id
The ID of the underlying data source.
Definition: GoSdkDef.h:1024
k16u upgradePort
Upgrade channel port.
Definition: GoSdkDef.h:880
kBool quickEditEnabled
The current state of editing.
Definition: GoSdkDef.h:852
Represents possible data streams.
kBool value
The element's boolean field value.
Definition: GoSdkDef.h:953
k64f length
The length of the transformed data region. (mm)
Definition: GoSdkDef.h:1012
k16u healthPort
Health channel port.
Definition: GoSdkDef.h:883
Determines whether to use a line based on a Profile Line fit, or based on the x-axis.
Represents advanced acquisition type.
GoElement64f x
The X offset of the active area. (mm)
Definition: GoSdkDef.h:976
k64f z
The Z offset of the transformation. (mm)
Definition: GoSdkDef.h:994
k64f height
The height of the transformed data region. (mm)
Definition: GoSdkDef.h:1013
Represents a profile edge type.
Represents a profile feature point type.
k64f z
The Z offset of the transformed data region. (mm)
Definition: GoSdkDef.h:1010
k64f xAngle
The X angle of the transformation. (degrees)
Definition: GoSdkDef.h:995
Lists all sensor acceleration states that a sensor can be in. When a sensor is being accelerated...
Represents the choices of the filter length (ie. how many prefilter coefficients to use for the prefi...
Represents a digital output condition.
Sensor network address settings.
Definition: GoSdkDef.h:863
Represents all serial output protocols.
Represents a part matching algorithm.
Represents the current state of a sensor object.
Represents the current encoder period limiting source.