Gocator API
 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) 2011-2012 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 a base tool measurement or script output.
22  */
23 typedef kObject GoMeasurement;
24 
25 
26 /**
27  * Returns whether or not the given measurement has an ID assigned to it.
28  *
29  * @public @memberof GoMeasurement
30  * @param measurement GoMeasurement object.
31  * @return kTRUE if t here is an ID; kFALSE otherwise.
32  */
33 GoFx(kBool) GoMeasurement_HasId(GoMeasurement measurement);
34 
35 /**
36  * Clears the 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 GoFx(const kChar*) GoMeasurement_Name(GoMeasurement measurement);
64 GoFx(kStatus) GoMeasurement_SetName(GoMeasurement measurement, const kChar* name);
65 
66 /**
67  * Returns the source tool of the given measurement.
68  *
69  * @public @memberof GoMeasurement
70  * @param measurement GoMeasurement object.
71  * @return A pointer to the source tool for the measurement.
72  */
73 GoFx(kObject) GoMeasurement_SourceTool(GoMeasurement measurement);
74 
75 /**
76  * Enables the given measurement for output.
77  *
78  * @public @memberof GoMeasurement
79  * @param measurement GoMeasurement object.
80  * @param enable Set to kTRUE to enable the measurement, kFALSE to disable it.
81  * @return Operation status.
82  */
83 GoFx(kStatus) GoMeasurement_Enable(GoMeasurement measurement, kBool enable);
84 
85 /**
86  * Returns whether the given measurement is enabled.
87  *
88  * @public @memberof GoMeasurement
89  * @param measurement GoMeasurement object.
90  * @return kTRUE if enabled; kFALSE otherwise.
91  */
92 GoFx(kBool) GoMeasurement_Enabled(GoMeasurement measurement);
93 
94 /**
95  * Sets the minimum decision value for the given measurement.
96  *
97  * @public @memberof GoMeasurement
98  * @param measurement GoMeasurement object.
99  * @param min The minimum decision value to set.
100  * @return Operation status.
101  */
102 GoFx(kStatus) GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min);
103 
104 /**
105  * Gets the minimum decision value for the given measurement.
106  *
107  * @public @memberof GoMeasurement
108  * @param measurement GoMeasurement object.
109  * @return The minimum decision value.
110  */
111 GoFx(k64f) GoMeasurement_DecisionMin(GoMeasurement measurement);
112 
113 /**
114  * Sets the maximum decision value for the given measurement.
115  *
116  * @public @memberof GoMeasurement
117  * @param measurement GoMeasurement object.
118  * @param max The maximum decision value to set.
119  * @return The maximum decision value.
120  */
121 GoFx(kStatus) GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max);
122 
123 /**
124  * Gets the maximum decision value for the given measurement.
125  *
126  * @public @memberof GoMeasurement
127  * @param measurement GoMeasurement object.
128  * @return The maximum decision value.
129  */
130 GoFx(k64f) GoMeasurement_DecisionMax(GoMeasurement measurement);
131 
132 GoFx(kStatus) GoMeasurement_EnableHold(GoMeasurement measurement, kBool enable);
133 GoFx(kBool) GoMeasurement_HoldEnabled(GoMeasurement measurement);
134 
135 GoFx(kStatus) GoMeasurement_EnableSmoothing(GoMeasurement measurement, kBool enable);
136 GoFx(kBool) GoMeasurement_SmoothingEnabled(GoMeasurement measurement);
137 
138 GoFx(kStatus) GoMeasurement_SetSmoothingWindow(GoMeasurement measurement, k64s value);
139 GoFx(k64s) GoMeasurement_SmoothingWindow(GoMeasurement measurement);
140 
141 GoFx(kStatus) GoMeasurement_SetScale(GoMeasurement measurement, k64f value);
142 GoFx(k64f) GoMeasurement_Scale(GoMeasurement measurement);
143 
144 GoFx(kStatus) GoMeasurement_SetOffset(GoMeasurement measurement, k64f value);
145 GoFx(k64f) GoMeasurement_Offset(GoMeasurement measurement);
146 
147 GoFx(GoMeasurementType) GoMeasurement_Type(GoMeasurement measurement);
148 
149 kEndHeader()
150 #include <GoSdk/GoMeasurement.x.h>
151 
152 #endif
k64f GoMeasurement_DecisionMax(GoMeasurement measurement)
Gets the maximum decision value for the given measurement.
Represents a base tool measurement or script output.
Definition: GoMeasurement.h:15
k64f GoMeasurement_DecisionMin(GoMeasurement measurement)
Gets the minimum decision value for the given measurement.
kStatus GoMeasurement_SetId(GoMeasurement measurement, k32u id)
Sets an ID number for the given measurement.
kBool GoMeasurement_Enabled(GoMeasurement measurement)
Returns whether the given measurement is enabled.
k32s GoMeasurement_Id(GoMeasurement measurement)
Gets the ID for the given measurement.
kBool GoMeasurement_HasId(GoMeasurement measurement)
Returns whether or not the given measurement has an ID assigned to it.
Essential API declarations.
kStatus GoMeasurement_SetDecisionMax(GoMeasurement measurement, k64f max)
Sets the maximum decision value for the given measurement.
kStatus GoMeasurement_SetDecisionMin(GoMeasurement measurement, k64f min)
Sets the minimum decision value for the given measurement.
kObject GoMeasurement_SourceTool(GoMeasurement measurement)
Returns the source tool of the given measurement.
kStatus GoMeasurement_Enable(GoMeasurement measurement, kBool enable)
Enables the given measurement for output.
kStatus GoMeasurement_ClearId(GoMeasurement measurement)
Clears the ID for the given measurement.