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