Gocator API
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-2019 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 /**
16  * @class GoTracheid
17  * @extends kObject
18  * @ingroup GoSdk
19  * @brief Represents tracheid data.
20  */
21 typedef kObject GoTracheid;
22 
23 /**
24  * Returns a boolean representing whether tracheid is used.
25  *
26  * @public @memberof GoTracheid
27  * @version Introduced in firmware 4.5.3.57
28  * @param tracheid GoTracheid object.
29  * @return kTRUE if used, or kFALSE if not used.
30  */
31 GoFx(kBool) GoTracheid_Used(GoTracheid tracheid);
32 
33 /**
34  * Sets the exposure to use for tracheids.
35  *
36  * @public @memberof GoTracheid
37  * @version Introduced in firmware 4.5.3.57
38  * @param tracheid GoTracheid object.
39  * @param exposure Exposure value (microseconds).
40  * @return Operation status.
41  */
42 GoFx(kStatus) GoTracheid_SetExposure(GoTracheid tracheid, k64f exposure);
43 
44 /**
45  * Gets the exposure used for tracheids.
46  *
47  * @public @memberof GoTracheid
48  * @version Introduced in firmware 4.5.3.57
49  * @param tracheid GoTracheid object.
50  * @return Exposure value (microseconds).
51  */
52 GoFx(k64f) GoTracheid_Exposure(GoTracheid tracheid);
53 
54 /**
55  * Enables or disables tracheid exposure.
56  *
57  * @public @memberof GoTracheid
58  * @version Introduced in firmware 4.5.3.57
59  * @param tracheid GoTracheid object.
60  * @param enable kTRUE to enable it and kFALSE to disable it.
61  * @return Operation status.
62  */
63 GoFx(kStatus) GoTracheid_EnableExposure(GoTracheid tracheid, kBool enable);
64 
65 /**
66  * Determines if tracheid exposure is enabled.
67  *
68  * @public @memberof GoTracheid
69  * @version Introduced in firmware 4.5.3.57
70  * @param tracheid GoTracheid object.
71  * @return kTRUE if enabled and kFALSE otherwise.
72  */
74 
75 /**
76  * Sets the camera threshold.
77  *
78  * @public @memberof GoTracheid
79  * @version Introduced in firmware 4.5.3.57
80  * @param tracheid GoTracheid object.
81  * @param cameraIndex Camera index (0 or 1).
82  * @param threshold Threshold value.
83  * @return Operation status.
84  */
85 GoFx(kStatus) GoTracheid_SetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s threshold);
86 
87 /**
88  * Gets the camera threshold.
89  *
90  * @public @memberof GoTracheid
91  * @version Introduced in firmware 4.5.3.57
92  * @param tracheid GoTracheid object.
93  * @param cameraIndex Camera index (0 or 1).
94  * @param threshold A reference to be updated with the threshold value.
95  * @return Operation status.
96  */
97 GoFx(kStatus) GoTracheid_GetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s* threshold);
98 
99 #include <GoSdk/GoTracheid.x.h>
100 
101 #endif
kStatus GoTracheid_SetExposure(GoTracheid tracheid, k64f exposure)
Sets the exposure to use for tracheids.
Represents tracheid data.
k64f GoTracheid_Exposure(GoTracheid tracheid)
Gets the exposure used for tracheids.
Essential SDK declarations.
kStatus GoTracheid_GetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s *threshold)
Gets the camera threshold.
kStatus GoTracheid_SetCameraThresholdAt(GoTracheid tracheid, kSize cameraIndex, k32s threshold)
Sets the camera threshold.
kStatus GoTracheid_EnableExposure(GoTracheid tracheid, kBool enable)
Enables or disables tracheid exposure.
kBool GoTracheid_ExposureEnabled(GoTracheid tracheid)
Determines if tracheid exposure is enabled.
kBool GoTracheid_Used(GoTracheid tracheid)
Returns a boolean representing whether tracheid is used.