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

Description

Represents a ...

+ Inheritance diagram for GoProfilePosition:

Public Member Functions

GoProfileFeature GoProfilePosition_Feature (GoProfilePosition tool)
 Gets the profile feature. More...
 
GoMeasurement GoProfilePosition_XMeasurement (GoProfilePosition tool)
 Returns a GoProfilePosition X measurement object. More...
 
GoMeasurement GoProfilePosition_ZMeasurement (GoProfilePosition tool)
 Returns a GoProfilePosition Z measurement object. More...
 
kStatus GoProfileTool_SetSource (GoProfileTool tool, GoDataSource source)
 Sets the profile data source. More...
 
GoDataSource GoProfileTool_Source (GoProfileTool tool)
 Gets the profile 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

GoProfileFeature GoProfilePosition_Feature ( GoProfilePosition  tool)

Gets the profile feature.

Parameters
toolGoProfilePos object.
Returns
The profile feature.
GoMeasurement GoProfilePosition_XMeasurement ( GoProfilePosition  tool)

Returns a GoProfilePosition X measurement object.

Parameters
toolGoProfilePosition object.
Returns
A GoProfilePosition X measurement.
GoMeasurement GoProfilePosition_ZMeasurement ( GoProfilePosition  tool)

Returns a GoProfilePosition Z measurement object.

Parameters
toolGoProfilePosition object.
Returns
A GoProfilePosition Z measurement.
kStatus GoProfileTool_SetSource ( GoProfileTool  tool,
GoDataSource  source 
)
inherited

Sets the profile data source.

Parameters
toolGoProfileTool object.
sourceGoDataSource object.
Returns
Operation status.
GoDataSource GoProfileTool_Source ( GoProfileTool  tool)
inherited

Gets the profile data source.

Parameters
toolGoProfileTool object.
Returns
The profile 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: