Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSurfacePosition Class Reference

Description

Represents a ...

+ Inheritance diagram for GoSurfacePosition:

Public Member Functions

GoMeasurement GoSurfacePosition_XMeasurement (GoSurfacePosition tool)
 Returns a GoSurfacePosition X measurement object. More...
 
GoMeasurement GoSurfacePosition_YMeasurement (GoSurfacePosition tool)
 Returns a GoSurfacePosition Y measurement object. More...
 
GoMeasurement GoSurfacePosition_ZMeasurement (GoSurfacePosition tool)
 Returns a GoSurfacePosition Z measurement object. More...
 
kStatus GoSurfaceTool_SetSource (GoSurfaceTool tool, GoDataSource source)
 Sets the surface data source. More...
 
GoDataSource GoSurfaceTool_Source (GoSurfaceTool tool)
 Gets the surface data source. More...
 
GoMeasurement GoTool_FindMeasurementByType (GoTool tool, GoMeasurementType type)
 Retrieves the first found instance of a measurement for a given type. More...
 
GoMeasurement GoTool_MeasurementAt (GoTool tool, kSize index)
 Retrieves the measurement at the given index. More...
 
kSize GoTool_MeasurementCount (GoTool tool)
 Returns the measurement count. More...
 
kStatus GoTool_Name (GoTool tool, kChar *name, kSize capacity)
 Retrieves the name of the tool. More...
 
kStatus GoTool_SetName (GoTool tool, const kChar *name)
 Sets the name of the tool. More...
 

Member Function Documentation

GoMeasurement GoSurfacePosition_XMeasurement ( GoSurfacePosition  tool)

Returns a GoSurfacePosition X measurement object.

Parameters
toolGoSurfacePosition object.
Returns
A GoSurfacePosition X measurement.
GoMeasurement GoSurfacePosition_YMeasurement ( GoSurfacePosition  tool)

Returns a GoSurfacePosition Y measurement object.

Parameters
toolGoSurfacePosition object.
Returns
A GoSurfacePosition Y measurement.
GoMeasurement GoSurfacePosition_ZMeasurement ( GoSurfacePosition  tool)

Returns a GoSurfacePosition Z measurement object.

Parameters
toolGoSurfacePosition object.
Returns
A GoSurfacePosition Z measurement.
kStatus GoSurfaceTool_SetSource ( GoSurfaceTool  tool,
GoDataSource  source 
)
inherited

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.

Parameters
toolGoSurfaceTool object.
sourceGoDataSource object.
Returns
Operation status.
GoDataSource GoSurfaceTool_Source ( GoSurfaceTool  tool)
inherited

Gets the surface data source.

Parameters
toolGoSurfaceTool object.
Returns
The surface data source.
GoMeasurement GoTool_FindMeasurementByType ( GoTool  tool,
GoMeasurementType  type 
)
inherited

Retrieves the first found instance of a measurement for a given type.

Parameters
toolGoTool object.
typeA GoMeasurementType representing the measurement type to find in the given tool.
Returns
A measurement object if one is found, otherwise kNULL.
GoMeasurement GoTool_MeasurementAt ( GoTool  tool,
kSize  index 
)
inherited

Retrieves the measurement at the given index.

Parameters
toolGoTool object.
indexThe index of the measurement.
Returns
The measurement.
kSize GoTool_MeasurementCount ( GoTool  tool)
inherited

Returns the measurement count.

Parameters
toolGoTool object.
Returns
The measurement count.
kStatus GoTool_Name ( GoTool  tool,
kChar *  name,
kSize  capacity 
)
inherited

Retrieves the name of the tool.

Parameters
toolGoTool object.
nameReceives the name of the tool.
capacityThe maximum capacity of the name array.
Returns
Operation status.
kStatus GoTool_SetName ( GoTool  tool,
const kChar *  name 
)
inherited

Sets the name of the tool.

Parameters
toolGoTool object.
nameThe name to be set for the tool.
Returns
Operation status.

The documentation for this class was generated from the following file: