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