Gocator API
 All Classes Files Functions Variables Typedefs Macros Modules Pages
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-2022 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  * This is the number of resampled profile points in the layout
107  * for the configured X-axis range and X-axis increment/step within the range.
108  *
109  * @public @memberof GoLayout
110  * @version Introduced in firmware 4.1.3.106
111  * @param layout GoLayout object.
112  * @return X spacing count value.
113  * @see GoSetup_XSpacingCount
114  */
115 GoFx(k64f) GoLayout_XSpacingCount(GoLayout layout);
116 
117 /**
118  * Returns the layout specific Y spacing count value.
119  *
120  * @public @memberof GoLayout
121  * @version Introduced in firmware 4.1.3.106
122  * @param layout GoLayout object.
123  * @return Y spacing count value.
124  * @see GoSetup_YSpacingCount
125  */
126 GoFx(k64f) GoLayout_YSpacingCount(GoLayout layout);
127 
128 
129 /**
130  * Returns a boolean value representing whether or not multiplexing is
131  * enabled in a buddied configuration.
132  *
133  * @public @memberof GoLayout
134  * @note Supported with G1, G2
135  * @version Introduced in firmware 4.0.10.27
136  * @param layout GoLayout object.
137  * @return kTRUE if multiplexing is enabled for a buddied configuration. kFALSE otherwise.
138  */
140 
141 /**
142  * Enables buddied sensor multiplexing with automated parameter calculation.
143  *
144  * @public @memberof GoLayout
145  * @note Supported with G1, G2
146  * @version Introduced in firmware 4.0.10.27
147  * @param layout GoLayout object.
148  * @param enable kTRUE to enable, or kFALSE to disable.
149  * @return Operation status.
150  */
152 
153 /**
154  * Returns a boolean value representing whether or not multiplexing is
155  * enabled in a single device configuration.
156  *
157  * @public @memberof GoLayout
158  * @note Supported with G1, G2
159  * @version Introduced in firmware 4.0.10.27
160  * @param layout GoLayout object.
161  * @return kTRUE if multiplexing is enabled. kFALSE otherwise.
162  */
164 
165 /**
166  * Enables single sensor(not buddied) configuration multiplexing.
167  *
168  * @public @memberof GoLayout
169  * @note Supported with G1, G2
170  * @version Introduced in firmware 4.0.10.27
171  * @param layout GoLayout object.
172  * @param enabled kTRUE to enable, or kFALSE to disable.
173  * @return Operation status.
174  */
176 
177 /**
178  * Returns a value representing the multiplexing delay in a single device sensor configuration. (microseconds)
179  *
180  * @public @memberof GoLayout
181  * @note Supported with G1, G2
182  * @version Introduced in firmware 4.0.10.27
183  * @param layout GoLayout object.
184  * @return Single device multiplexing delay.
185  */
187 
188 /**
189  * Sets the single sensor multiplexing delay. (microseconds)
190  *
191  * @public @memberof GoLayout
192  * @note Supported with G1, G2
193  * @version Introduced in firmware 4.0.10.27
194  * @param layout GoLayout object.
195  * @param value The delay (in uS) to set.
196  * @return Operation status.
197  */
199 
200 /**
201  * Returns a value representing the multiplexing period in a single device sensor configuration. (microseconds)
202  *
203  * @public @memberof GoLayout
204  * @note Supported with G1, G2
205  * @version Introduced in firmware 4.0.10.27
206  * @param layout GoLayout object.
207  * @return Single device multiplexing period.
208  */
210 
211 /**
212 * Returns a value representing the minimum multiplexing period in a single device sensor configuration. (microseconds)
213 *
214 * @public @memberof GoLayout
215 * @note Supported with G1, G2
216 * @version Introduced in firmware 4.0.10.27
217 * @param layout GoLayout object.
218 * @return Single device multiplexing period minimum value.
219 */
221 
222 /**
223  * Sets the single sensor multiplexing period. (microseconds)
224  *
225  * @public @memberof GoLayout
226  * @note Supported with G1, G2
227  * @version Introduced in firmware 4.0.10.27
228  * @param layout GoLayout object.
229  * @param value The multiplexing period (in uS) to set.
230  * @return Operation status.
231  */
233 
234 /**
235  * Returns a value representing the multiplexing exposure duration in a single device sensor configuration. (microseconds)
236  *
237  * @public @memberof GoLayout
238  * @note Supported with G1, G2
239  * @version Introduced in firmware 4.0.10.27
240  * @param layout GoLayout object.
241  * @return Single device multiplexing exposure duration.
242  */
244 
245 /**
246  * Sets number of columns being configured (may not be applicable or used) on device in n-buddy system
247  *
248  * @public @memberof GoLayout
249  * @version Introduced in firmware 6.0.18.7
250  * @note Supported with G1, G2
251  * @param layout GoLayout object.
252  * @param value The number of column
253  * @return Operation status.
254  */
255 GoFx(kStatus) GoLayout_SetGridColumnCount(GoLayout layout, k32u value);
256 
257 /**
258  * Returns number of columns being configured (may not be applicable or used) on device in n-buddy system.
259  *
260  * @public @memberof GoLayout
261  * @version Introduced in firmware 6.0.18.7
262  * @note Supported with G1, G2
263  * @param layout GoLayout object.
264  * @return The number of column
265  */
267 
268 /**
269  * Returns number of columns system value being used on device in n-buddy system
270  *
271  * @public @memberof GoLayout
272  * @version Introduced in firmware 6.0.18.7
273  * @note Supported with G1, G2
274  * @param layout GoLayout object.
275  * @return The number of column system value
276  */
278 
279 #include <GoSdk/GoLayout.x.h>
280 
281 #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.
k32u GoLayout_GridColumnCountSystemValue(GoLayout layout)
Returns number of columns system value being used on device in n-buddy system.
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_SetGridColumnCount(GoLayout layout, k32u value)
Sets number of columns being configured (may not be applicable or used) on device in n-buddy system...
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...
k32u GoLayout_GridColumnCount(GoLayout layout)
Returns number of columns being configured (may not be applicable or used) on device in n-buddy syste...