Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoTracheid.h
Go to the documentation of this file.
1 /**
2 * @file GoTracheid.h
3 * @brief Declares the GoTransform class.
4 *
5 * @internal
6 * Copyright (C) 2016 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_TRACHEID_H
11 #define GO_TRACHEID_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @class GoTracheid
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents tracheid data.
22 */
23 typedef kObject GoTracheid;
24
25 /**
26 * Returns a boolean representing whether tracheid is used.
27 *
28 * @public @memberof GoTracheid
29 * @version Introduced in firmware 4.5.3.57
30 * @param tracheid GoTracheid object.
31 * @return kTRUE if used, or kFALSE if not used.
32 */
33 GoFx(kBool) GoTracheid_Used(GoTracheid tracheid);
34
35 /**
36 * Sets the exposure to use for tracheids.
37 *
38 * @public @memberof GoTracheid
39 * @version Introduced in firmware 4.5.3.57
40 * @param tracheid GoTracheid object.
41 * @param exposure Exposure value (microseconds).
42 * @return Operation status.
43 */
44 GoFx(kStatus) GoTracheid_SetExposure(GoTracheid tracheid, k64f exposure);
45
46 /**
47 * Gets the exposure used for tracheids.
48 *
49 * @public @memberof GoTracheid
50 * @version Introduced in firmware 4.5.3.57
51 * @param tracheid GoTracheid object.
52 * @return Exposure value (microseconds).
53 */
54 GoFx(k64f) GoTracheid_Exposure(GoTracheid tracheid);
55
56 /**
57 * Enables or disables tracheid exposure.
58 *
59 * @public @memberof GoTracheid
60 * @version Introduced in firmware 4.5.3.57
61 * @param tracheid GoTracheid object.
62 * @param enable kTRUE to enable it and kFALSE to disable it.
63 * @return Operation status.
64 */
65 GoFx(kStatus) GoTracheid_EnableExposure(GoTracheid tracheid, kBool enable);
66
67 /**
68 * Determines if tracheid exposure is enabled.
69 *
70 * @public @memberof GoTracheid
71 * @version Introduced in firmware 4.5.3.57
72 * @param tracheid GoTracheid object.
73 * @return kTRUE if enabled and kFALSE otherwise.
74 */
75 GoFx(kBool) GoTracheid_ExposureEnabled(GoTracheid tracheid);
76
77 /**
78 * Sets the camera threshold.
79 *
80 * @public @memberof GoTracheid
81 * @version Introduced in firmware 4.5.3.57
82 * @param tracheid GoTracheid object.
83 * @param cameraIndex Camera index (0 or 1).
84 * @param threshold Threshold value.
85 * @return Operation status.
86 */
87 GoFx(kStatus) GoTracheid_SetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s threshold);
88
89 /**
90 * Gets the camera threshold.
91 *
92 * @public @memberof GoTracheid
93 * @version Introduced in firmware 4.5.3.57
94 * @param tracheid GoTracheid object.
95 * @param cameraIndex Camera index (0 or 1).
96 * @param threshold A reference to be updated with the threshold value.
97 * @return Operation status.
98 */
99 GoFx(kStatus) GoTracheid_GetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s* threshold);
100
101
102 kEndHeader()
103 #include <GoSdk/GoTracheid.x.h>
104
105 #endif
GoTracheid::GoTracheid_SetExposure
kStatus GoTracheid_SetExposure(GoTracheid tracheid, k64f exposure)
Sets the exposure to use for tracheids.
GoTracheid
Represents tracheid data.
kSize
GoTracheid::GoTracheid_Exposure
k64f GoTracheid_Exposure(GoTracheid tracheid)
Gets the exposure used for tracheids.
GoSdkDef.h
Essential SDK declarations.
GoTracheid::GoTracheid_GetCameraThresholdAt
kStatus GoTracheid_GetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s *threshold)
Gets the camera threshold.
GoTracheid::GoTracheid_SetCameraThresholdAt
kStatus GoTracheid_SetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s threshold)
Sets the camera threshold.
k32s
GoTracheid::GoTracheid_EnableExposure
kStatus GoTracheid_EnableExposure(GoTracheid tracheid, kBool enable)
Enables or disables tracheid exposure.
GoTracheid::GoTracheid_ExposureEnabled
kBool GoTracheid_ExposureEnabled(GoTracheid tracheid)
Determines if tracheid exposure is enabled.
kObject
kStatus
k64f
kBool
GoTracheid::GoTracheid_Used
kBool GoTracheid_Used(GoTracheid tracheid)
Returns a boolean representing whether tracheid is used.