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-2020 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 kBeginHeader()
16
17 /**
18 * @class GoLayout
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents a layout related sensor configuration.
22 */
23 typedef kObject GoLayout;
24
25 /**
26 * Sets the buddied sensor configuration orientation.
27 *
28 * @public @memberof GoLayout
29 * @version Introduced in firmware 4.0.10.27
30 * @param layout GoLayout object.
31 * @param orientation The orientation to set.
32 * @return Operation status.
33 */
34 GoFx(kStatus) GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation);
35
36 /**
37 * Returns the current orientation used when buddied.
38 *
39 * @public @memberof GoLayout
40 * @version Introduced in firmware 4.0.10.27
41 * @param layout GoLayout object.
42 * @return Buddied device orientation.
43 */
44 GoFx(GoOrientation) GoLayout_Orientation(GoLayout layout);
45
46 /**
47 * Returns the transformed data region X-component value.
48 *
49 * @public @memberof GoLayout
50 * @version Introduced in firmware 4.0.10.27
51 * @param layout GoLayout object.
52 * @return Transformed data region value.
53 */
54 GoFx(k64f) GoLayout_TransformedDataRegionX(GoLayout layout);
55
56 /**
57 * Returns the transformed data region Y-component value.
58 *
59 * @public @memberof GoLayout
60 * @version Introduced in firmware 4.0.10.27
61 * @param layout GoLayout object.
62 * @return Transformed data region value.
63 */
64 GoFx(k64f) GoLayout_TransformedDataRegionY(GoLayout layout);
65
66 /**
67 * Returns the transformed data region Z-component value.
68 *
69 * @public @memberof GoLayout
70 * @version Introduced in firmware 4.0.10.27
71 * @param layout GoLayout object.
72 * @return Transformed data region value.
73 */
74 GoFx(k64f) GoLayout_TransformedDataRegionZ(GoLayout layout);
75
76 /**
77 * Returns the transformed data region width value. (mm)
78 *
79 * @public @memberof GoLayout
80 * @version Introduced in firmware 4.0.10.27
81 * @param layout GoLayout object.
82 * @return Transformed data region value.
83 */
84 GoFx(k64f) GoLayout_TransformedDataRegionWidth(GoLayout layout);
85
86 /**
87 * Returns the transformed data region length value. (mm)
88 *
89 * @public @memberof GoLayout
90 * @version Introduced in firmware 4.0.10.27
91 * @param layout GoLayout object.
92 * @return Transformed data region value.
93 */
94 GoFx(k64f) GoLayout_TransformedDataRegionLength(GoLayout layout);
95
96 /**
97 * Returns the transformed data region height value. (mm)
98 *
99 * @public @memberof GoLayout
100 * @version Introduced in firmware 4.0.10.27
101 * @param layout GoLayout object.
102 * @return Transformed data region value.
103 */
104 GoFx(k64f) GoLayout_TransformedDataRegionHeight(GoLayout layout);
105
106 /**
107 * Returns the layout specific X spacing count value.
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 /// @cond (Gocator_1x00 || Gocator_2x00)
130
131 /**
132 * Returns a boolean value representing whether or not multiplexing is
133 * enabled in a buddied configuration.
134 *
135 * @public @memberof GoLayout
136 * @version Introduced in firmware 4.0.10.27
137 * @param layout GoLayout object.
138 * @return kTRUE if multiplexing is enabled for a buddied configuration. kFALSE otherwise.
139 */
140 GoFx(kBool) GoLayout_MultiplexBuddyEnabled(GoLayout layout);
141
142 /**
143 * Enables buddied sensor multiplexing with automated parameter calculation.
144 *
145 * @public @memberof GoLayout
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 */
151 GoFx(kStatus) GoLayout_EnableMultiplexBuddy(GoLayout layout, kBool enable);
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 * @version Introduced in firmware 4.0.10.27
159 * @param layout GoLayout object.
160 * @return kTRUE if multiplexing is enabled. kFALSE otherwise.
161 */
162 GoFx(kBool) GoLayout_MultiplexSingleEnabled(GoLayout layout);
163
164 /**
165 * Enables single sensor(not buddied) configuration multiplexing.
166 *
167 * @public @memberof GoLayout
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 */
173 GoFx(kStatus) GoLayout_EnableMultiplexSingle(GoLayout layout, kBool enabled);
174
175 /**
176 * Returns a value representing the multiplexing delay in a single device sensor configuration. (microseconds)
177 *
178 * @public @memberof GoLayout
179 * @version Introduced in firmware 4.0.10.27
180 * @param layout GoLayout object.
181 * @return Single device multiplexing delay.
182 */
183 GoFx(k64f) GoLayout_MultiplexSingleDelay(GoLayout layout);
184
185 /**
186 * Sets the single sensor multiplexing delay. (microseconds)
187 *
188 * @public @memberof GoLayout
189 * @version Introduced in firmware 4.0.10.27
190 * @param layout GoLayout object.
191 * @param value The delay (in uS) to set.
192 * @return Operation status.
193 */
194 GoFx(kStatus) GoLayout_SetMultiplexSingleDelay(GoLayout layout, k64f value);
195
196 /**
197 * Returns a value representing the multiplexing period in a single device sensor configuration. (microseconds)
198 *
199 * @public @memberof GoLayout
200 * @version Introduced in firmware 4.0.10.27
201 * @param layout GoLayout object.
202 * @return Single device multiplexing period.
203 */
204 GoFx(k64f) GoLayout_MultiplexSinglePeriod(GoLayout layout);
205
206 /**
207 * Returns a value representing the minimum multiplexing period in a single device sensor configuration. (microseconds)
208 *
209 * @public @memberof GoLayout
210 * @version Introduced in firmware 4.0.10.27
211 * @param layout GoLayout object.
212 * @return Single device multiplexing period minimum value.
213 */
214 GoFx(k64f) GoLayout_MultiplexSinglePeriodMin(GoLayout layout);
215
216 /**
217 * Sets the single sensor multiplexing period. (microseconds)
218 *
219 * @public @memberof GoLayout
220 * @version Introduced in firmware 4.0.10.27
221 * @param layout GoLayout object.
222 * @param value The multiplexing period (in uS) to set.
223 * @return Operation status.
224 */
225 GoFx(kStatus) GoLayout_SetMultiplexSinglePeriod(GoLayout layout, k64f value);
226
227 /**
228 * Returns a value representing the multiplexing exposure duration in a single device sensor configuration. (microseconds)
229 *
230 * @public @memberof GoLayout
231 * @version Introduced in firmware 4.0.10.27
232 * @param layout GoLayout object.
233 * @return Single device multiplexing exposure duration.
234 */
235 GoFx(k64f) GoLayout_MultiplexSingleExposureDuration(GoLayout layout);
236
237 /// @endcond
238
239
240 kEndHeader()
241 #include <GoSdk/GoLayout.x.h>
242
243 #endif
GoLayout::GoLayout_MultiplexBuddyEnabled
kBool GoLayout_MultiplexBuddyEnabled(GoLayout layout)
Returns a boolean value representing whether or not multiplexing is enabled in a buddied configuratio...
GoLayout::GoLayout_TransformedDataRegionZ
k64f GoLayout_TransformedDataRegionZ(GoLayout layout)
Returns the transformed data region Z-component value.
GoLayout::GoLayout_EnableMultiplexBuddy
kStatus GoLayout_EnableMultiplexBuddy(GoLayout layout, kBool enable)
Enables buddied sensor multiplexing with automated parameter calculation.
GoLayout::GoLayout_YSpacingCount
k64f GoLayout_YSpacingCount(GoLayout layout)
Returns the layout specific Y spacing count value.
GoLayout::GoLayout_MultiplexSingleDelay
k64f GoLayout_MultiplexSingleDelay(GoLayout layout)
Returns a value representing the multiplexing delay in a single device sensor configuration.
GoLayout
Represents a layout related sensor configuration.
GoLayout::GoLayout_SetMultiplexSingleDelay
kStatus GoLayout_SetMultiplexSingleDelay(GoLayout layout, k64f value)
Sets the single sensor multiplexing delay.
GoLayout::GoLayout_MultiplexSinglePeriodMin
k64f GoLayout_MultiplexSinglePeriodMin(GoLayout layout)
Returns a value representing the minimum multiplexing period in a single device sensor configuration.
GoSdkDef.h
Essential SDK declarations.
GoLayout::GoLayout_TransformedDataRegionY
k64f GoLayout_TransformedDataRegionY(GoLayout layout)
Returns the transformed data region Y-component value.
GoLayout::GoLayout_TransformedDataRegionX
k64f GoLayout_TransformedDataRegionX(GoLayout layout)
Returns the transformed data region X-component value.
GoLayout::GoLayout_TransformedDataRegionWidth
k64f GoLayout_TransformedDataRegionWidth(GoLayout layout)
Returns the transformed data region width value.
GoLayout::GoLayout_EnableMultiplexSingle
kStatus GoLayout_EnableMultiplexSingle(GoLayout layout, kBool enabled)
Enables single sensor(not buddied) configuration multiplexing.
GoLayout::GoLayout_SetMultiplexSinglePeriod
kStatus GoLayout_SetMultiplexSinglePeriod(GoLayout layout, k64f value)
Sets the single sensor multiplexing period.
GoLayout::GoLayout_TransformedDataRegionLength
k64f GoLayout_TransformedDataRegionLength(GoLayout layout)
Returns the transformed data region length value.
GoLayout::GoLayout_MultiplexSinglePeriod
k64f GoLayout_MultiplexSinglePeriod(GoLayout layout)
Returns a value representing the multiplexing period in a single device sensor configuration.
GoOrientation
Represents a sensor orientation type.
GoLayout::GoLayout_XSpacingCount
k64f GoLayout_XSpacingCount(GoLayout layout)
Returns the layout specific X spacing count value.
GoLayout::GoLayout_TransformedDataRegionHeight
k64f GoLayout_TransformedDataRegionHeight(GoLayout layout)
Returns the transformed data region height value.
GoLayout::GoLayout_MultiplexSingleExposureDuration
k64f GoLayout_MultiplexSingleExposureDuration(GoLayout layout)
Returns a value representing the multiplexing exposure duration in a single device sensor configurati...
GoLayout::GoLayout_SetOrientation
kStatus GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation)
Sets the buddied sensor configuration orientation.
kObject
kStatus
k64f
kBool
GoLayout::GoLayout_Orientation
GoOrientation GoLayout_Orientation(GoLayout layout)
Returns the current orientation used when buddied.
GoLayout::GoLayout_MultiplexSingleEnabled
kBool GoLayout_MultiplexSingleEnabled(GoLayout layout)
Returns a boolean value representing whether or not multiplexing is enabled in a single device config...