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