Gocator API

- Home
- Categories
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Groups Pages
GoMeasurement.h
Go to the documentation of this file.
1 /**
2 * @file GoMeasurement.h
3 * @brief Declares the GoMeasurement 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_MEASUREMENT_H
11 #define GO_MEASUREMENT_H
12
13 #include <GoSdk/GoSdkDef.h>
14
15 kBeginHeader()
16
17 /**
18 * @class GoMeasurement
19 * @extends kObject
20 * @ingroup GoSdk
21 * @brief Represents the base class for a tool measurement or script output.
22 */
23 typedef kObject GoMeasurement;
24
25
26 /**
27 * Returns whether or not the given measurement has a valid ID assigned to it.
28 *
29 * @public @memberof GoMeasurement
30 * @param measurement GoMeasurement object.
31 * @return kTRUE if there is an ID; kFALSE otherwise.
32 */
33 GoFx(kBool) GoMeasurement_HasId(GoMeasurement measurement);
34
35 /**
36 * Clears the assigned ID for the given measurement.
37 *
38 * @public @memberof GoMeasurement
39 * @param measurement GoMeasurement object.
40 * @return Operation status.
41 */
42 GoFx(kStatus) GoMeasurement_ClearId(GoMeasurement measurement);
43
44 /**
45 * Sets an ID number for the given measurement.
46 *
47 * @public @memberof GoMeasurement
48 * @param measurement GoMeasurement object.
49 * @param id The ID value to set for the measurement.
50 * @return Operation status.
51 */
52 GoFx(kStatus) GoMeasurement_SetId(GoMeasurement measurement, k32u id);
53
54 /**
55 * Gets the ID for the given measurement.
56 *
57 * @public @memberof GoMeasurement
58 * @param measurement GoMeasurement object.
59 * @return The ID value if there is one assigned. Otherwise, -1 is returned.
60 */
61 GoFx(k32s) GoMeasurement_Id(GoMeasurement measurement);
62
63 /**
64 * Gets the name for the given measurement.
65 *
66 * @public @memberof GoMeasurement
67 * @param measurement GoMeasurement object.
68 * @return A character array pointer for the measurement name.
69 */
70 GoFx(const kChar*) GoMeasurement_Name(GoMeasurement measurement);
71
72 /**
73 * Sets the name for the given measurement.
74 *
75 * @public @memberof GoMeasurement
76 * @param measurement GoMeasurement object.
77 * @param name The name to assign to the measurement.
78 * @return Operation status.
79 */
80 GoFx(kStatus) GoMeasurement_SetName(GoMeasurement measurement, const kChar* name);
81
82 /**
83 * Returns the source tool of the given measurement.
84 *
85 * @public @memberof GoMeasurement
86 * @param measurement GoMeasurement object.
87 * @return A pointer to the source tool for the measurement.
88 */
89 GoFx(kObject) GoMeasurement_SourceTool(GoMeasurement measurement);
90
91 /**
92 * Enables the given measurement for output.
93 *
94 * @public @memberof GoMeasurement
95 * @param measurement GoMeasurement object.
96 * @param enable Set to kTRUE to enable the measurement, kFALSE to disable it.
97 * @return Operation status.
98 */
99 GoFx(kStatus) GoMeasurement_Enable(GoMeasurement measurement, kBool enable);
100
101 /**
102 * Returns a boolean value representing whether the given measurement is enabled.
103 *
104 * @public @memberof GoMeasurement
105 * @param measurement GoMeasurement object.
106 * @return kTRUE if enabled; kFALSE otherwise.
107 */
108 GoFx(kBool) GoMeasurement_Enabled(GoMeasurement measurement);
109
110 /**
111 * Sets the minimum decision value for the given measurement.
112 *
113 * @public @memberof GoMeasurement
114 * @param measurement GoMeasurement object.
115 * @param min The minimum decision value to set.
116 * @return Operation status.
117 */
118 GoFx(kStatus) GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min);
119
120 /**
121 * Gets the minimum decision value for the given measurement.
122 *
123 * @public @memberof GoMeasurement
124 * @param measurement GoMeasurement object.
125 * @return The minimum decision value.
126 */
127 GoFx(k64f) GoMeasurement_DecisionMin(GoMeasurement measurement);
128
129 /**
130 * Sets the maximum decision value for the given measurement.
131 *
132 * @public @memberof GoMeasurement
133 * @param measurement GoMeasurement object.
134 * @param max The maximum decision value to set.
135 * @return Operation status.
136 */
137 GoFx(kStatus) GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max);
138
139 /**
140 * Gets the maximum decision value for the given measurement.
141 *
142 * @public @memberof GoMeasurement
143 * @param measurement GoMeasurement object.
144 * @return The maximum decision value.
145 */
146 GoFx(k64f) GoMeasurement_DecisionMax(GoMeasurement measurement);
147
148 /**
149 * Sets measurement value hold for the given measurement.
150 *
151 * @public @memberof GoMeasurement
152 * @param measurement GoMeasurement object.
153 * @param enable kTRUE to enable measurement value hold, kFALSE to disable it.
154 * @return Operation status.
155 */
156 GoFx(kStatus) GoMeasurement_EnableHold(GoMeasurement measurement, kBool enable);
157
158 /**
159 * Returns a boolean value representing the current state of measurement value hold.
160 *
161 * @public @memberof GoMeasurement
162 * @param measurement GoMeasurement object.
163 * @return kTRUE if enabled and kFALSE if disabled.
164 */
165 GoFx(kBool) GoMeasurement_HoldEnabled(GoMeasurement measurement);
166
167 /**
168 * Sets measurement value smoothing for the given measurement.
169 *
170 * @public @memberof GoMeasurement
171 * @param measurement GoMeasurement object.
172 * @param enable kTRUE to enable measurement value smoothing, kFALSE to disable it.
173 * @return Operation status.
174 */
175 GoFx(kStatus) GoMeasurement_EnableSmoothing(GoMeasurement measurement, kBool enable);
176
177 /**
178 * Returns a boolean value representing the current state of measurement value smoothing.
179 *
180 * @public @memberof GoMeasurement
181 * @param measurement GoMeasurement object.
182 * @return kTRUE if enabled and kFALSE if disabled.
183 */
184 GoFx(kBool) GoMeasurement_SmoothingEnabled(GoMeasurement measurement);
185
186 /**
187 * Sets the measurement value smoothing window for the given measurement.
188 *
189 * @public @memberof GoMeasurement
190 * @param measurement GoMeasurement object.
191 * @param value The intended size of the smoothing window.
192 * @return Operation status.
193 */
194 GoFx(kStatus) GoMeasurement_SetSmoothingWindow(GoMeasurement measurement, k64s value);
195
196 /**
197 * Returns the current measurement value smoothing window size.
198 *
199 * @public @memberof GoMeasurement
200 * @param measurement GoMeasurement object.
201 * @return Smoothing window size.
202 */
203 GoFx(k64s) GoMeasurement_SmoothingWindow(GoMeasurement measurement);
204
205 /**
206 * Sets the measurement value scaling for the given measurement.
207 *
208 * @public @memberof GoMeasurement
209 * @param measurement GoMeasurement object.
210 * @param value The intended measurement value scaling factor.
211 * @return Operation status.
212 */
213 GoFx(kStatus) GoMeasurement_SetScale(GoMeasurement measurement, k64f value);
214
215 /**
216 * Returns the current measurement value scaling factor.
217 *
218 * @public @memberof GoMeasurement
219 * @param measurement GoMeasurement object.
220 * @return The measurement value scaling factor.
221 */
222 GoFx(k64f) GoMeasurement_Scale(GoMeasurement measurement);
223
224 /**
225 * Sets the measurement value offset for the given measurement.
226 *
227 * @public @memberof GoMeasurement
228 * @param measurement GoMeasurement object.
229 * @param value The measurement offset to set.
230 * @return Operation status.
231 */
232 GoFx(kStatus) GoMeasurement_SetOffset(GoMeasurement measurement, k64f value);
233
234 /**
235 * Returns the measurement value offset.
236 *
237 * @public @memberof GoMeasurement
238 * @param measurement GoMeasurement object.
239 * @return Measurement value offset.
240 */
241 GoFx(k64f) GoMeasurement_Offset(GoMeasurement measurement);
242
243 /**
244 * Gets the measurement type for the given measurement.
245 *
246 * @public @memberof GoMeasurement
247 * @param measurement GoMeasurement object.
248 * @return The measurement value type enumerator value.
249 */
250 GoFx(GoMeasurementType) GoMeasurement_Type(GoMeasurement measurement);
251
252 kEndHeader()
253 #include <GoSdk/Tools/GoMeasurement.x.h>
254
255 #endif
GoMeasurement::GoMeasurement_DecisionMax
k64f GoMeasurement_DecisionMax(GoMeasurement measurement)
Gets the maximum decision value for the given measurement.
GoMeasurement::GoMeasurement_SetSmoothingWindow
kStatus GoMeasurement_SetSmoothingWindow(GoMeasurement measurement, k64s value)
Sets the measurement value smoothing window for the given measurement.
GoMeasurement::GoMeasurement_Type
GoMeasurementType GoMeasurement_Type(GoMeasurement measurement)
Gets the measurement type for the given measurement.
GoMeasurement
Represents the base class for a tool measurement or script output.
Definition: GoMeasurement.h:15
GoMeasurement::GoMeasurement_SetOffset
kStatus GoMeasurement_SetOffset(GoMeasurement measurement, k64f value)
Sets the measurement value offset for the given measurement.
GoMeasurement::GoMeasurement_DecisionMin
k64f GoMeasurement_DecisionMin(GoMeasurement measurement)
Gets the minimum decision value for the given measurement.
GoMeasurement::GoMeasurement_SetId
kStatus GoMeasurement_SetId(GoMeasurement measurement, k32u id)
Sets an ID number for the given measurement.
GoMeasurement::GoMeasurement_Enabled
kBool GoMeasurement_Enabled(GoMeasurement measurement)
Returns a boolean value representing whether the given measurement is enabled.
GoMeasurementType
Lists all measurement types.
GoMeasurement::GoMeasurement_Scale
k64f GoMeasurement_Scale(GoMeasurement measurement)
Returns the current measurement value scaling factor.
GoMeasurement::GoMeasurement_SetScale
kStatus GoMeasurement_SetScale(GoMeasurement measurement, k64f value)
Sets the measurement value scaling for the given measurement.
GoMeasurement::GoMeasurement_SmoothingWindow
k64s GoMeasurement_SmoothingWindow(GoMeasurement measurement)
Returns the current measurement value smoothing window size.
GoMeasurement::GoMeasurement_Id
k32s GoMeasurement_Id(GoMeasurement measurement)
Gets the ID for the given measurement.
GoMeasurement::GoMeasurement_SetName
kStatus GoMeasurement_SetName(GoMeasurement measurement, const kChar *name)
Sets the name for the given measurement.
GoMeasurement::GoMeasurement_HasId
kBool GoMeasurement_HasId(GoMeasurement measurement)
Returns whether or not the given measurement has a valid ID assigned to it.
GoMeasurement::GoMeasurement_EnableHold
kStatus GoMeasurement_EnableHold(GoMeasurement measurement, kBool enable)
Sets measurement value hold for the given measurement.
GoSdkDef.h
Essential SDK declarations.
GoMeasurement::GoMeasurement_SetDecisionMax
kStatus GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max)
Sets the maximum decision value for the given measurement.
kBeginHeader
kBeginHeader() kStatus GoSdk_Construct(kAssembly *assembly)
Constructs the Gocator SDK library.
GoMeasurement::GoMeasurement_Offset
k64f GoMeasurement_Offset(GoMeasurement measurement)
Returns the measurement value offset.
GoMeasurement::GoMeasurement_SmoothingEnabled
kBool GoMeasurement_SmoothingEnabled(GoMeasurement measurement)
Returns a boolean value representing the current state of measurement value smoothing.
GoMeasurement::GoMeasurement_SetDecisionMin
kStatus GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min)
Sets the minimum decision value for the given measurement.
GoMeasurement::GoMeasurement_HoldEnabled
kBool GoMeasurement_HoldEnabled(GoMeasurement measurement)
Returns a boolean value representing the current state of measurement value hold. ...
GoMeasurement::GoMeasurement_SourceTool
kObject GoMeasurement_SourceTool(GoMeasurement measurement)
Returns the source tool of the given measurement.
GoMeasurement::GoMeasurement_EnableSmoothing
kStatus GoMeasurement_EnableSmoothing(GoMeasurement measurement, kBool enable)
Sets measurement value smoothing for the given measurement.
GoMeasurement::GoMeasurement_Name
const kChar * GoMeasurement_Name(GoMeasurement measurement)
Gets the name for the given measurement.
GoMeasurement::GoMeasurement_Enable
kStatus GoMeasurement_Enable(GoMeasurement measurement, kBool enable)
Enables the given measurement for output.
GoMeasurement::GoMeasurement_ClearId
kStatus GoMeasurement_ClearId(GoMeasurement measurement)
Clears the assigned ID for the given measurement.