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