Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoTool.h
Go to the documentation of this file.
1 /**
2  * @file GoTool.h
3  * @brief Declares the GoTool 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_TOOL_H
11 #define GO_TOOL_H
12 
13 #include <GoSdk/GoSdkDef.h>
14 #include <GoSdk/GoProfileTypes.h>
15 #include <GoSdk/GoSurfaceTypes.h>
16 #include <GoSdk/GoMeasurements.h>
17 #include <kApi/Data/kXml.h>
18 kBeginHeader()
19 
20 /**
21  * @class GoTool
22  * @extends kObject
23  * @ingroup GoSdk
24  * @brief Represents a ...
25  */
26 typedef kObject GoTool;
27 
28 /**
29  * Returns the measurement count.
30  *
31  * @public @memberof GoTool
32  * @param tool GoTool object.
33  * @return The measurement count.
34  */
35 GoFx(kSize) GoTool_MeasurementCount(GoTool tool);
36 
37 /**
38  * Retrieves the measurement at the given index.
39  *
40  * @public @memberof GoTool
41  * @param tool GoTool object.
42  * @param index The index of the measurement.
43  * @return The measurement.
44  */
45 GoFx(GoMeasurement) GoTool_MeasurementAt(GoTool tool, kSize index);
46 
47 /**
48  * Sets the name of the tool.
49  *
50  * @public @memberof GoTool
51  * @param tool GoTool object.
52  * @param name The name to be set for the tool.
53  * @return Operation status.
54  */
55 GoFx(kStatus) GoTool_SetName(GoTool tool, const kChar* name);
56 
57 /**
58  * Retrieves the name of the tool.
59  *
60  * @public @memberof GoTool
61  * @param tool GoTool object.
62  * @param name Receives the name of the tool.
63  * @param capacity The maximum capacity of the name array.
64  * @return Operation status.
65  */
66 GoFx(kStatus) GoTool_Name(GoTool tool, kChar* name, kSize capacity);
67 
68 GoFx(GoToolType) GoTool_Type(GoTool tool);
69 
70 /**
71  * Retrieves the first found instance of a measurement for a given type.
72  *
73  * @public @memberof GoTool
74  * @param tool GoTool object.
75  * @param type A GoMeasurementType representing the measurement type to find in the given tool.
76  * @return A measurement object if one is found, otherwise kNULL.
77  */
78 GoFx(GoMeasurement) GoTool_FindMeasurementByType(GoTool tool, GoMeasurementType type);
79 
80 
81 /// @cond Gocator_1x00
82 
83 /**
84  * @class GoRangeTool
85  * @extends GoTool
86  * @ingroup GoSdk
87  * @brief Represents a ...
88  */
89 typedef GoTool GoRangeTool;
90 
91 /**
92  * Sets the range data source.
93  *
94  * @public @memberof GoRangeTool
95  * @param tool GoRangeTool object.
96  * @param source GoDataSource object.
97  * @return Operation status.
98  */
99 GoFx(kStatus) GoRangeTool_SetSource(GoRangeTool tool, GoDataSource source);
100 
101 /**
102  * Gets the range data source.
103  *
104  * @public @memberof GoRangeTool
105  * @param tool GoRangeTool object.
106  * @return The range data source.
107  */
108 GoFx(GoDataSource) GoRangeTool_Source(GoRangeTool tool);
109 
110 GoFx(kSize) GoRangeTool_SourceOptionCount(GoRangeTool tool);
111 GoFx(k32u) GoRangeTool_SourceOptionAt(GoRangeTool tool, kSize index);
112 
113 /// @endcond
114 
115 
116 /// @cond Gocator_2x00
117 
118 /**
119  * @class GoProfileTool
120  * @extends GoTool
121  * @ingroup GoSdk
122  * @brief Represents a ...
123  */
124 typedef GoTool GoProfileTool;
125 
126 /**
127  * Sets the profile data source.
128  *
129  * @public @memberof GoProfileTool
130  * @param tool GoProfileTool object.
131  * @param source GoDataSource object.
132  * @return Operation status.
133  */
134 GoFx(kStatus) GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source);
135 
136 /**
137  * Gets the profile data source.
138  *
139  * @public @memberof GoProfileTool
140  * @param tool GoProfileTool object.
141  * @return The profile data source.
142  */
143 GoFx(GoDataSource) GoProfileTool_Source(GoProfileTool tool);
144 
145 GoFx(kSize) GoProfileTool_SourceOptionCount(GoProfileTool tool);
146 GoFx(k32u) GoProfileTool_SourceOptionAt(GoProfileTool tool, kSize index);
147 
148 GoFx(kSize) GoProfileTool_XAnchorSourceCount(GoProfileTool tool);
149 GoFx(k32u) GoProfileTool_XAnchorSourceAt(GoProfileTool tool, kSize index);
150 GoFx(k32s) GoProfileTool_XAnchor(GoProfileTool tool);
151 GoFx(kStatus) GoProfileTool_SetXAnchor(GoProfileTool tool, k32s id);
152 GoFx(kBool) GoProfileTool_XAnchorEnabled(GoProfileTool tool);
153 
154 GoFx(kSize) GoProfileTool_ZAnchorSourceCount(GoProfileTool tool);
155 GoFx(k32u) GoProfileTool_ZAnchorSourceAt(GoProfileTool tool, kSize index);
156 GoFx(kStatus) GoProfileTool_SetZAnchor(GoProfileTool tool, k32s id);
157 GoFx(kBool) GoProfileTool_ZAnchorEnabled(GoProfileTool tool);
158 GoFx(k32s) GoProfileTool_ZAnchor(GoProfileTool tool);
159 
160 /// @endcond
161 
162 
163 /// @cond (Gocator_2x00 || Gocator_3x00)
164 
165 /**
166  * @class GoSurfaceTool
167  * @extends GoTool
168  * @ingroup GoSdk
169  * @brief Represents a ...
170  */
171 typedef GoTool GoSurfaceTool;
172 
173 /**
174  * Sets the surface data source. NOTE: The tool must have been added to the GoTools tool list (with a valid source) in order to call this function successfully.
175  *
176  * @public @memberof GoSurfaceTool
177  * @param tool GoSurfaceTool object.
178  * @param source GoDataSource object.
179  * @return Operation status.
180  */
181 GoFx(kStatus) GoSurfaceTool_SetSource(GoSurfaceTool tool, GoDataSource source);
182 
183 /**
184  * Gets the surface data source.
185  *
186  * @public @memberof GoSurfaceTool
187  * @param tool GoSurfaceTool object.
188  * @return The surface data source.
189  */
190 GoFx(GoDataSource) GoSurfaceTool_Source(GoSurfaceTool tool);
191 
192 GoFx(kSize) GoSurfaceTool_SourceOptionCount(GoSurfaceTool tool);
193 GoFx(k32u) GoSurfaceTool_SourceOptionAt(GoSurfaceTool tool, kSize index);
194 
195 GoFx(kSize) GoSurfaceTool_XAnchorOptionCount(GoSurfaceTool tool);
196 GoFx(k32u) GoSurfaceTool_XAnchorOptionAt(GoSurfaceTool tool, kSize index);
197 GoFx(k32s) GoSurfaceTool_XAnchor(GoSurfaceTool tool);
198 GoFx(kStatus) GoSurfaceTool_SetXAnchor(GoSurfaceTool tool, k32s id);
199 GoFx(kBool) GoSurfaceTool_XAnchorEnabled(GoSurfaceTool tool);
200 
201 GoFx(kSize) GoSurfaceTool_YAnchorOptionCount(GoSurfaceTool tool);
202 GoFx(k32u) GoSurfaceTool_YAnchorOptionAt(GoSurfaceTool tool, kSize index);
203 GoFx(k32s) GoSurfaceTool_YAnchor(GoSurfaceTool tool);
204 GoFx(kStatus) GoSurfaceTool_SetYAnchor(GoSurfaceTool tool, k32s id);
205 GoFx(kBool) GoSurfaceTool_YAnchorEnabled(GoSurfaceTool tool);
206 
207 GoFx(kSize) GoSurfaceTool_ZAnchorOptionCount(GoSurfaceTool tool);
208 GoFx(k32u) GoSurfaceTool_ZAnchorOptionAt(GoSurfaceTool tool, kSize index);
209 GoFx(kStatus) GoSurfaceTool_SetZAnchor(GoSurfaceTool tool, k32s id);
210 GoFx(kBool) GoSurfaceTool_ZAnchorEnabled(GoSurfaceTool tool);
211 GoFx(k32s) GoSurfaceTool_ZAnchor(GoSurfaceTool tool);
212 
213 /// @endcond
214 
215 kEndHeader()
216 #include <GoSdk/GoTool.x.h>
217 
218 #endif
GoMeasurement GoTool_FindMeasurementByType(GoTool tool, GoMeasurementType type)
Retrieves the first found instance of a measurement for a given type.
Represents a base tool measurement or script output.
Definition: GoMeasurement.h:15
GoDataSource GoSurfaceTool_Source(GoSurfaceTool tool)
Gets the surface data source.
GoDataSource GoProfileTool_Source(GoProfileTool tool)
Gets the profile data source.
Declares the GoProfileType classes.
Represents a data source.
kStatus GoTool_Name(GoTool tool, kChar *name, kSize capacity)
Retrieves the name of the tool.
kStatus GoProfileTool_SetSource(GoProfileTool tool, GoDataSource source)
Sets the profile data source.
kStatus GoTool_SetName(GoTool tool, const kChar *name)
Sets the name of the tool.
kSize GoTool_MeasurementCount(GoTool tool)
Returns the measurement count.
Essential API declarations.
Declares the GoMeasurement classes.
Represents a ...
Definition: GoTool.h:18
Represents a ...
GoMeasurement GoTool_MeasurementAt(GoTool tool, kSize index)
Retrieves the measurement at the given index.
kStatus GoSurfaceTool_SetSource(GoSurfaceTool tool, GoDataSource source)
Sets the surface data source.
Represents a ...
Declares the GoSurfaceType classes.