Gocator API
GoLayout.h
Go to the documentation of this file.
1 /**
2  * @file GoLayout.h
3  * @brief Declares the GoLayout 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_LAYOUT_H
11 #define GO_LAYOUT_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 
15 /**
16  * @class GoLayout
17  * @extends kObject
18  * @ingroup GoSdk
19  * @brief Represents a layout related sensor configuration.
20  */
21 typedef kObject GoLayout;
22 
23 /**
24  * Sets the buddied sensor configuration orientation.
25  *
26  * @public @memberof GoLayout
27  * @version Introduced in firmware 4.0.10.27
28  * @param layout GoLayout object.
29  * @param orientation The orientation to set.
30  * @return Operation status.
31  */
32 GoFx(kStatus) GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation);
33 
34 /**
35  * Returns the current orientation used when buddied.
36  *
37  * @public @memberof GoLayout
38  * @version Introduced in firmware 4.0.10.27
39  * @param layout GoLayout object.
40  * @return Buddied device orientation.
41  */
43 
44 /**
45  * Returns the transformed data region X-component value.
46  *
47  * @public @memberof GoLayout
48  * @version Introduced in firmware 4.0.10.27
49  * @param layout GoLayout object.
50  * @return Transformed data region value.
51  */
53 
54 /**
55  * Returns the transformed data region Y-component value.
56  *
57  * @public @memberof GoLayout
58  * @version Introduced in firmware 4.0.10.27
59  * @param layout GoLayout object.
60  * @return Transformed data region value.
61  */
63 
64 /**
65  * Returns the transformed data region Z-component value.
66  *
67  * @public @memberof GoLayout
68  * @version Introduced in firmware 4.0.10.27
69  * @param layout GoLayout object.
70  * @return Transformed data region value.
71  */
73 
74 /**
75  * Returns the transformed data region width value. (mm)
76  *
77  * @public @memberof GoLayout
78  * @version Introduced in firmware 4.0.10.27
79  * @param layout GoLayout object.
80  * @return Transformed data region value.
81  */
83 
84 /**
85  * Returns the transformed data region length value. (mm)
86  *
87  * @public @memberof GoLayout
88  * @version Introduced in firmware 4.0.10.27
89  * @param layout GoLayout object.
90  * @return Transformed data region value.
91  */
93 
94 /**
95  * Returns the transformed data region height value. (mm)
96  *
97  * @public @memberof GoLayout
98  * @version Introduced in firmware 4.0.10.27
99  * @param layout GoLayout object.
100  * @return Transformed data region value.
101  */
103 
104 /**
105  * Returns the layout specific X spacing count value.
106  *
107  * @public @memberof GoLayout
108  * @version Introduced in firmware 4.1.3.106
109  * @param layout GoLayout object.
110  * @return X spacing count value.
111  * @see GoSetup_XSpacingCount
112  */
113 GoFx(k64f) GoLayout_XSpacingCount(GoLayout layout);
114 
115 /**
116  * Returns the layout specific Y spacing count value.
117  *
118  * @public @memberof GoLayout
119  * @version Introduced in firmware 4.1.3.106
120  * @param layout GoLayout object.
121  * @return Y spacing count value.
122  * @see GoSetup_YSpacingCount
123  */
124 GoFx(k64f) GoLayout_YSpacingCount(GoLayout layout);
125 
126 
127 /**
128  * Returns a boolean value representing whether or not multiplexing is
129  * enabled in a buddied configuration.
130  *
131  * @public @memberof GoLayout
132  * @note Supported with G1, G2
133  * @version Introduced in firmware 4.0.10.27
134  * @param layout GoLayout object.
135  * @return kTRUE if multiplexing is enabled for a buddied configuration. kFALSE otherwise.
136  */
138 
139 /**
140  * Enables buddied sensor multiplexing with automated parameter calculation.
141  *
142  * @public @memberof GoLayout
143  * @note Supported with G1, G2
144  * @version Introduced in firmware 4.0.10.27
145  * @param layout GoLayout object.
146  * @param enable kTRUE to enable, or kFALSE to disable.
147  * @return Operation status.
148  */
150 
151 /**
152  * Returns a boolean value representing whether or not multiplexing is
153  * enabled in a single device configuration.
154  *
155  * @public @memberof GoLayout
156  * @note Supported with G1, G2
157  * @version Introduced in firmware 4.0.10.27
158  * @param layout GoLayout object.
159  * @return kTRUE if multiplexing is enabled. kFALSE otherwise.
160  */
162 
163 /**
164  * Enables single sensor(not buddied) configuration multiplexing.
165  *
166  * @public @memberof GoLayout
167  * @note Supported with G1, G2
168  * @version Introduced in firmware 4.0.10.27
169  * @param layout GoLayout object.
170  * @param enabled kTRUE to enable, or kFALSE to disable.
171  * @return Operation status.
172  */
174 
175 /**
176  * Returns a value representing the multiplexing delay in a single device sensor configuration. (microseconds)
177  *
178  * @public @memberof GoLayout
179  * @note Supported with G1, G2
180  * @version Introduced in firmware 4.0.10.27
181  * @param layout GoLayout object.
182  * @return Single device multiplexing delay.
183  */
185 
186 /**
187  * Sets the single sensor multiplexing delay. (microseconds)
188  *
189  * @public @memberof GoLayout
190  * @note Supported with G1, G2
191  * @version Introduced in firmware 4.0.10.27
192  * @param layout GoLayout object.
193  * @param value The delay (in uS) to set.
194  * @return Operation status.
195  */
197 
198 /**
199  * Returns a value representing the multiplexing period in a single device sensor configuration. (microseconds)
200  *
201  * @public @memberof GoLayout
202  * @note Supported with G1, G2
203  * @version Introduced in firmware 4.0.10.27
204  * @param layout GoLayout object.
205  * @return Single device multiplexing period.
206  */
208 
209 /**
210 * Returns a value representing the minimum multiplexing period in a single device sensor configuration. (microseconds)
211 *
212 * @public @memberof GoLayout
213 * @note Supported with G1, G2
214 * @version Introduced in firmware 4.0.10.27
215 * @param layout GoLayout object.
216 * @return Single device multiplexing period minimum value.
217 */
219 
220 /**
221  * Sets the single sensor multiplexing period. (microseconds)
222  *
223  * @public @memberof GoLayout
224  * @note Supported with G1, G2
225  * @version Introduced in firmware 4.0.10.27
226  * @param layout GoLayout object.
227  * @param value The multiplexing period (in uS) to set.
228  * @return Operation status.
229  */
231 
232 /**
233  * Returns a value representing the multiplexing exposure duration in a single device sensor configuration. (microseconds)
234  *
235  * @public @memberof GoLayout
236  * @note Supported with G1, G2
237  * @version Introduced in firmware 4.0.10.27
238  * @param layout GoLayout object.
239  * @return Single device multiplexing exposure duration.
240  */
242 
243 #include <GoSdk/GoLayout.x.h>
244 
245 #endif
kBool GoLayout_MultiplexBuddyEnabled(GoLayout layout)
Returns a boolean value representing whether or not multiplexing is enabled in a buddied configuratio...
k64f GoLayout_TransformedDataRegionZ(GoLayout layout)
Returns the transformed data region Z-component value.
kStatus GoLayout_EnableMultiplexBuddy(GoLayout layout, kBool enable)
Enables buddied sensor multiplexing with automated parameter calculation.
k64f GoLayout_YSpacingCount(GoLayout layout)
Returns the layout specific Y spacing count value.
k64f GoLayout_MultiplexSingleDelay(GoLayout layout)
Returns a value representing the multiplexing delay in a single device sensor configuration.
Represents a layout related sensor configuration.
kStatus GoLayout_SetMultiplexSingleDelay(GoLayout layout, k64f value)
Sets the single sensor multiplexing delay.
k64f GoLayout_MultiplexSinglePeriodMin(GoLayout layout)
Returns a value representing the minimum multiplexing period in a single device sensor configuration.
Essential SDK declarations.
k64f GoLayout_TransformedDataRegionY(GoLayout layout)
Returns the transformed data region Y-component value.
k64f GoLayout_TransformedDataRegionX(GoLayout layout)
Returns the transformed data region X-component value.
k64f GoLayout_TransformedDataRegionWidth(GoLayout layout)
Returns the transformed data region width value.
kStatus GoLayout_EnableMultiplexSingle(GoLayout layout, kBool enabled)
Enables single sensor(not buddied) configuration multiplexing.
kStatus GoLayout_SetMultiplexSinglePeriod(GoLayout layout, k64f value)
Sets the single sensor multiplexing period.
k64f GoLayout_TransformedDataRegionLength(GoLayout layout)
Returns the transformed data region length value.
k64f GoLayout_MultiplexSinglePeriod(GoLayout layout)
Returns a value representing the multiplexing period in a single device sensor configuration.
Represents a sensor orientation type.
k64f GoLayout_XSpacingCount(GoLayout layout)
Returns the layout specific X spacing count value.
k64f GoLayout_TransformedDataRegionHeight(GoLayout layout)
Returns the transformed data region height value.
k64f GoLayout_MultiplexSingleExposureDuration(GoLayout layout)
Returns a value representing the multiplexing exposure duration in a single device sensor configurati...
kStatus GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation)
Sets the buddied sensor configuration orientation.
GoOrientation GoLayout_Orientation(GoLayout layout)
Returns the current orientation used when buddied.
kBool GoLayout_MultiplexSingleEnabled(GoLayout layout)
Returns a boolean value representing whether or not multiplexing is enabled in a single device config...