Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoTransform.h
Go to the documentation of this file.
1 /**
2 * @file GoTransform.h
3 * @brief Declares the GoTransform 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_TRANSFORM_H
11 #define GO_TRANSFORM_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @class GoTransform
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents a sensor transformation.
22 */
23 typedef kObject GoTransform;
24
25 /**
26 * Gets the encoder resolution.
27 *
28 * @public @memberof GoTransform
29 * @param transform GoTransform object.
30 * @return The encoder resolution in mm/tick.
31 */
32 GoFx(k64f) GoTransform_EncoderResolution(GoTransform transform);
33
34 /**
35 * Sets the encoder resolution.
36 *
37 * @public @memberof GoTransform
38 * @param transform GoTransform object.
39 * @param value Encoder resolution in mm/tick.
40 * @return Operation status.
41 */
42 GoFx(kStatus) GoTransform_SetEncoderResolution(GoTransform transform, k64f value);
43
44 /**
45 * Gets the encoder speed.
46 *
47 * @public @memberof GoTransform
48 * @param transform GoTransform object.
49 * @return The encoder speed in mm/sec.
50 */
51 GoFx(k64f) GoTransform_Speed(GoTransform transform);
52
53 /**
54 * Sets the encoder speed.
55 *
56 * @public @memberof GoTransform
57 * @param transform GoTransform object.
58 * @param value Encoder resolution in mm/sec.
59 * @return Operation status.
60 */
61 GoFx(kStatus) GoTransform_SetSpeed(GoTransform transform, k64f value);
62
63 /**
64 * Gets the X component of the transformation.
65 *
66 * @public @memberof GoTransform
67 * @param transform GoTransform object.
68 * @param role The sensor role transformation to retrieve the value from.
69 * @return The transformation X component.
70 */
71 GoFx(k64f) GoTransform_X(GoTransform transform, GoRole role);
72
73 /**
74 * Sets the transformation X component.
75 *
76 * @public @memberof GoTransform
77 * @param transform GoTransform object.
78 * @param role The sensor role transformation entry to update.
79 * @param offset The transformation X component to set.
80 * @return Operation status.
81 */
82 GoFx(kStatus) GoTransform_SetX(GoTransform transform, GoRole role, k64f offset);
83
84 /**
85 * Gets the Y component of the transformation.
86 *
87 * @public @memberof GoTransform
88 * @param transform GoTransform object.
89 * @param role The sensor role transformation to retrieve the value from.
90 * @return The transformation Y component.
91 */
92 GoFx(k64f) GoTransform_Y(GoTransform transform, GoRole role);
93
94 /**
95 * Sets the transformation Y component.
96 *
97 * @public @memberof GoTransform
98 * @param transform GoTransform object.
99 * @param role The sensor role transformation entry to update.
100 * @param offset The transformation Y component to set.
101 * @return Operation status.
102 */
103 GoFx(kStatus) GoTransform_SetY(GoTransform transform, GoRole role, k64f offset);
104
105 /**
106 * Gets the Z component of the transformation.
107 *
108 * @public @memberof GoTransform
109 * @param transform GoTransform object.
110 * @param role The sensor role transformation to retrieve the value from.
111 * @return The transformation Z component.
112 */
113 GoFx(k64f) GoTransform_Z(GoTransform transform, GoRole role);
114
115 /**
116 * Sets the transformation Z component.
117 *
118 * @public @memberof GoTransform
119 * @param transform GoTransform object.
120 * @param role The sensor role transformation entry to update.
121 * @param offset The transformation Z component to set.
122 * @return Operation status.
123 */
124 GoFx(kStatus) GoTransform_SetZ(GoTransform transform, GoRole role, k64f offset);
125
126 /**
127 * Gets the X-angle of the transformation.
128 *
129 * @public @memberof GoTransform
130 * @param transform GoTransform object.
131 * @param role The sensor role transformation to retrieve the value from.
132 * @return The transformation X-angle.
133 */
134 GoFx(k64f) GoTransform_XAngle(GoTransform transform, GoRole role);
135
136 /**
137 * Sets the transformation X-angle.
138 *
139 * @public @memberof GoTransform
140 * @param transform GoTransform object.
141 * @param role The sensor role transformation entry to update.
142 * @param offset The transformation X-angle to set.
143 * @return Operation status.
144 */
145 GoFx(kStatus) GoTransform_SetXAngle(GoTransform transform, GoRole role, k64f offset);
146
147 /**
148 * Gets the Y-angle of the transformation.
149 *
150 * @public @memberof GoTransform
151 * @param transform GoTransform object.
152 * @param role The sensor role transformation to retrieve the value from.
153 * @return The transformation Y-angle component.
154 */
155 GoFx(k64f) GoTransform_YAngle(GoTransform transform, GoRole role);
156
157 /**
158 * Sets the transformation Y-angle.
159 *
160 * @public @memberof GoTransform
161 * @param transform GoTransform object.
162 * @param role The sensor role transformation entry to update.
163 * @param offset The transformation Y-angle to set.
164 * @return Operation status.
165 */
166 GoFx(kStatus) GoTransform_SetYAngle(GoTransform transform, GoRole role, k64f offset);
167
168 /**
169 * Gets the Z-angle of the transformation.
170 *
171 * @public @memberof GoTransform
172 * @param transform GoTransform object.
173 * @param role The sensor role transformation to retrieve the value from.
174 * @return The transformation Z-angle component.
175 */
176 GoFx(k64f) GoTransform_ZAngle(GoTransform transform, GoRole role);
177
178 /**
179 * Sets the transformation Z-angle.
180 *
181 * @public @memberof GoTransform
182 * @param transform GoTransform object.
183 * @param role The sensor role transformation entry to update.
184 * @param offset The transformation Z-angle to set.
185 * @return Operation status.
186 */
187 GoFx(kStatus) GoTransform_SetZAngle(GoTransform transform, GoRole role, k64f offset);
188
189
190 kEndHeader()
191 #include <GoSdk/GoTransform.x.h>
192
193 #endif
GoTransform::GoTransform_XAngle
k64f GoTransform_XAngle(GoTransform transform, GoRole role)
Gets the X-angle of the transformation.
GoTransform::GoTransform_YAngle
k64f GoTransform_YAngle(GoTransform transform, GoRole role)
Gets the Y-angle of the transformation.
GoTransform::GoTransform_Z
k64f GoTransform_Z(GoTransform transform, GoRole role)
Gets the Z component of the transformation.
GoRole
Represents a user role.
GoTransform::GoTransform_EncoderResolution
k64f GoTransform_EncoderResolution(GoTransform transform)
Gets the encoder resolution.
GoTransform::GoTransform_X
k64f GoTransform_X(GoTransform transform, GoRole role)
Gets the X component of the transformation.
GoTransform::GoTransform_SetZAngle
kStatus GoTransform_SetZAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Z-angle.
GoTransform::GoTransform_SetZ
kStatus GoTransform_SetZ(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Z component.
GoSdkDef.h
Essential SDK declarations.
GoTransform::GoTransform_SetXAngle
kStatus GoTransform_SetXAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation X-angle.
GoTransform::GoTransform_ZAngle
k64f GoTransform_ZAngle(GoTransform transform, GoRole role)
Gets the Z-angle of the transformation.
GoTransform::GoTransform_Y
k64f GoTransform_Y(GoTransform transform, GoRole role)
Gets the Y component of the transformation.
GoTransform::GoTransform_SetSpeed
kStatus GoTransform_SetSpeed(GoTransform transform, k64f value)
Sets the encoder speed.
GoTransform::GoTransform_SetY
kStatus GoTransform_SetY(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Y component.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoTransform::GoTransform_SetYAngle
kStatus GoTransform_SetYAngle(GoTransform transform, GoRole role, k64f offset)
Sets the transformation Y-angle.
GoTransform::GoTransform_SetX
kStatus GoTransform_SetX(GoTransform transform, GoRole role, k64f offset)
Sets the transformation X component.
GoTransform
Represents a sensor transformation.
Definition: GoTransform.h:15
GoTransform::GoTransform_Speed
k64f GoTransform_Speed(GoTransform transform)
Gets the encoder speed.
GoTransform::GoTransform_SetEncoderResolution
kStatus GoTransform_SetEncoderResolution(GoTransform transform, k64f value)
Sets the encoder resolution.