Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups 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) 2014 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 * Returns a boolean value representing whether or not multiplexing is
27 * enabled in a buddied configuration.
28 *
29 * @public @memberof GoLayout
30 * @param layout GoLayout object.
31 * @return kTRUE if multiplexing is enabled for a buddied configuration. kFALSE otherwise.
32 */
33 GoFx(kBool) GoLayout_MultiplexBuddyEnabled(GoLayout layout);
34
35 /**
36 * Enables buddied sensor multiplexing with automated parameter calculation.
37 *
38 * @public @memberof GoLayout
39 * @param layout GoLayout object.
40 * @param enable kTRUE to enable, or kFALSE to disable.
41 * @return Operation status.
42 */
43 GoFx(kStatus) GoLayout_EnableMultiplexBuddy(GoLayout layout, kBool enable);
44
45 /**
46 * Returns a boolean value representing whether or not multiplexing is
47 * enabled in a single device configuration.
48 *
49 * @public @memberof GoLayout
50 * @param layout GoLayout object.
51 * @return kTRUE if multiplexing is enabled. kFALSE otherwise.
52 */
53 GoFx(kBool) GoLayout_MultiplexSingleEnabled(GoLayout layout);
54
55 /**
56 * Enables single sensor(not buddied) configuration multiplexing.
57 *
58 * @public @memberof GoLayout
59 * @param layout GoLayout object.
60 * @param enabled kTRUE to enable, or kFALSE to disable.
61 * @return Operation status.
62 */
63 GoFx(kStatus) GoLayout_EnableMultiplexSingle(GoLayout layout, kBool enabled);
64
65 /**
66 * Returns a value representing the multiplexing delay in a single device sensor configuration.
67 *
68 * @public @memberof GoLayout
69 * @param layout GoLayout object.
70 * @return Single device multiplexing delay.
71 */
72 GoFx(k64f) GoLayout_MultiplexSingleDelay(GoLayout layout);
73
74 /**
75 * Sets the single sensor multiplexing delay.
76 *
77 * @public @memberof GoLayout
78 * @param layout GoLayout object.
79 * @param value The delay (in uS) to set.
80 * @return Operation status.
81 */
82 GoFx(kStatus) GoLayout_SetMultiplexSingleDelay(GoLayout layout, k64f value);
83
84 /**
85 * Returns a value representing the multiplexing period in a single device sensor configuration.
86 *
87 * @public @memberof GoLayout
88 * @param layout GoLayout object.
89 * @return Single device multiplexing period.
90 */
91 GoFx(k64f) GoLayout_MultiplexSinglePeriod(GoLayout layout);
92
93 /**
94 * Returns a value representing the minimum multiplexing period in a single device sensor configuration.
95 *
96 * @public @memberof GoLayout
97 * @param layout GoLayout object.
98 * @return Single device multiplexing period minimum value.
99 */
100 GoFx(k64f) GoLayout_MultiplexSinglePeriodMin(GoLayout layout);
101
102 /**
103 * Sets the single sensor multiplexing period.
104 *
105 * @public @memberof GoLayout
106 * @param layout GoLayout object.
107 * @param value The multiplexing period (in uS) to set.
108 * @return Operation status.
109 */
110 GoFx(kStatus) GoLayout_SetMultiplexSinglePeriod(GoLayout layout, k64f value);
111
112 /**
113 * Returns a value representing the multiplexing exposure duration in a single device sensor configuration.
114 *
115 * @public @memberof GoLayout
116 * @param layout GoLayout object.
117 * @return Single device multiplexing exposure duration.
118 */
119 GoFx(k64f) GoLayout_MultiplexSingleExposureDuration(GoLayout layout);
120
121 /**
122 * Sets the buddied sensor configuration orientation.
123 *
124 * @public @memberof GoLayout
125 * @param layout GoLayout object.
126 * @param orientation The orientation to set.
127 * @return Operation status.
128 */
129 GoFx(kStatus) GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation);
130
131 /**
132 * Returns the current orientation used when buddied.
133 *
134 * @public @memberof GoLayout
135 * @param layout GoLayout object.
136 * @return Buddied device orientation.
137 */
138 GoFx(GoOrientation) GoLayout_Orientation(GoLayout layout);
139
140 /**
141 * Returns the transformed data region X-component value.
142 *
143 * @public @memberof GoLayout
144 * @param layout GoLayout object.
145 * @return Transformed data region value.
146 */
147 GoFx(k64f) GoLayout_TransformedDataRegionX(GoLayout layout);
148
149 /**
150 * Returns the transformed data region Y-component value.
151 *
152 * @public @memberof GoLayout
153 * @param layout GoLayout object.
154 * @return Transformed data region value.
155 */
156 GoFx(k64f) GoLayout_TransformedDataRegionY(GoLayout layout);
157
158 /**
159 * Returns the transformed data region Z-component value.
160 *
161 * @public @memberof GoLayout
162 * @param layout GoLayout object.
163 * @return Transformed data region value.
164 */
165 GoFx(k64f) GoLayout_TransformedDataRegionZ(GoLayout layout);
166
167 /**
168 * Returns the transformed data region width value.
169 *
170 * @public @memberof GoLayout
171 * @param layout GoLayout object.
172 * @return Transformed data region value.
173 */
174 GoFx(k64f) GoLayout_TransformedDataRegionWidth(GoLayout layout);
175
176 /**
177 * Returns the transformed data region length value.
178 *
179 * @public @memberof GoLayout
180 * @param layout GoLayout object.
181 * @return Transformed data region value.
182 */
183 GoFx(k64f) GoLayout_TransformedDataRegionLength(GoLayout layout);
184
185 /**
186 * Returns the transformed data region height value.
187 *
188 * @public @memberof GoLayout
189 * @param layout GoLayout object.
190 * @return Transformed data region value.
191 */
192 GoFx(k64f) GoLayout_TransformedDataRegionHeight(GoLayout layout);
193
194 kEndHeader()
195 #include <GoSdk/GoLayout.x.h>
196
197 #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_MultiplexSinglePeriodMin
k64f GoLayout_MultiplexSinglePeriodMin(GoLayout layout)
Returns a value representing the minimum multiplexing period in a single device sensor configuration...
GoLayout::GoLayout_EnableMultiplexBuddy
kStatus GoLayout_EnableMultiplexBuddy(GoLayout layout, kBool enable)
Enables buddied sensor multiplexing with automated parameter calculation.
GoLayout::GoLayout_TransformedDataRegionY
k64f GoLayout_TransformedDataRegionY(GoLayout layout)
Returns the transformed data region Y-component value.
GoLayout
Represents a layout related sensor configuration.
Definition: GoLayout.h:15
GoSdkDef.h
Essential SDK declarations.
GoLayout::GoLayout_EnableMultiplexSingle
kStatus GoLayout_EnableMultiplexSingle(GoLayout layout, kBool enabled)
Enables single sensor(not buddied) configuration multiplexing.
GoLayout::GoLayout_MultiplexSinglePeriod
k64f GoLayout_MultiplexSinglePeriod(GoLayout layout)
Returns a value representing the multiplexing period in a single device sensor configuration.
GoLayout::GoLayout_MultiplexSingleExposureDuration
k64f GoLayout_MultiplexSingleExposureDuration(GoLayout layout)
Returns a value representing the multiplexing exposure duration in a single device sensor configurati...
GoLayout::GoLayout_SetMultiplexSinglePeriod
kStatus GoLayout_SetMultiplexSinglePeriod(GoLayout layout, k64f value)
Sets the single sensor multiplexing period.
GoOrientation
Represents a sensor orientation type.
GoLayout::GoLayout_TransformedDataRegionZ
k64f GoLayout_TransformedDataRegionZ(GoLayout layout)
Returns the transformed data region Z-component value.
GoLayout::GoLayout_TransformedDataRegionHeight
k64f GoLayout_TransformedDataRegionHeight(GoLayout layout)
Returns the transformed data region height value.
GoLayout::GoLayout_Orientation
GoOrientation GoLayout_Orientation(GoLayout layout)
Returns the current orientation used when buddied.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoLayout::GoLayout_TransformedDataRegionWidth
k64f GoLayout_TransformedDataRegionWidth(GoLayout layout)
Returns the transformed data region width value.
GoLayout::GoLayout_TransformedDataRegionX
k64f GoLayout_TransformedDataRegionX(GoLayout layout)
Returns the transformed data region X-component value.
GoLayout::GoLayout_MultiplexSingleEnabled
kBool GoLayout_MultiplexSingleEnabled(GoLayout layout)
Returns a boolean value representing whether or not multiplexing is enabled in a single device config...
GoLayout::GoLayout_MultiplexSingleDelay
k64f GoLayout_MultiplexSingleDelay(GoLayout layout)
Returns a value representing the multiplexing delay in a single device sensor configuration.
GoLayout::GoLayout_TransformedDataRegionLength
k64f GoLayout_TransformedDataRegionLength(GoLayout layout)
Returns the transformed data region length value.
GoLayout::GoLayout_SetMultiplexSingleDelay
kStatus GoLayout_SetMultiplexSingleDelay(GoLayout layout, k64f value)
Sets the single sensor multiplexing delay.
GoLayout::GoLayout_SetOrientation
kStatus GoLayout_SetOrientation(GoLayout layout, GoOrientation orientation)
Sets the buddied sensor configuration orientation.