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

Description

Represents a ...

+ Inheritance diagram for GoProfileGroove:

Public Member Functions

k64f GoProfileGroove_MaxWidth (GoProfileGroove tool)
 Gets the groove width maximum. More...
 
k64f GoProfileGroove_MinDepth (GoProfileGroove tool)
 Gets the groove depth minimum. More...
 
k64f GoProfileGroove_MinWidth (GoProfileGroove tool)
 Gets the groove width minimum value. More...
 
GoProfileRegion GoProfileGroove_Region (GoProfileGroove tool)
 Gets the profile region. More...
 
kStatus GoProfileGroove_SetMaxWidth (GoProfileGroove tool, k64f width)
 Sets the groove width maximum. More...
 
kStatus GoProfileGroove_SetMinDepth (GoProfileGroove tool, k64f depth)
 Sets the groove depth minimum. More...
 
kStatus GoProfileGroove_SetMinWidth (GoProfileGroove tool, k64f width)
 Sets the groove width minimum. More...
 
kStatus GoProfileGroove_SetShape (GoProfileGroove tool, GoProfileGrooveShape shape)
 Sets the groove determination shape. More...
 
GoProfileGrooveShape GoProfileGroove_Shape (GoProfileGroove tool)
 Gets the current groove determination shape. More...
 
k32u GoProfileGrooveDepth_SelectIndex (GoProfileGrooveDepth measurement)
 Gets the current selected groove index. More...
 
GoProfileGrooveSelectType GoProfileGrooveDepth_SelectType (GoProfileGrooveDepth measurement)
 Gets the current groove selection type. More...
 
kStatus GoProfileGrooveDepth_SetSelectIndex (GoProfileGrooveDepth measurement, k32u selectN)
 Sets the selected groove index. More...
 
kStatus GoProfileGrooveDepth_SetSelectType (GoProfileGrooveDepth measurement, GoProfileGrooveSelectType selectType)
 Sets the groove selection type. More...
 
k32u GoProfileGrooveWidth_SelectIndex (GoProfileGrooveWidth measurement)
 Gets the current selected groove index. More...
 
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType (GoProfileGrooveWidth measurement)
 Gets the current groove selection type. More...
 
kStatus GoProfileGrooveWidth_SetSelectIndex (GoProfileGrooveWidth measurement, k32u selectN)
 Sets the selected groove index. More...
 
kStatus GoProfileGrooveWidth_SetSelectType (GoProfileGrooveWidth measurement, GoProfileGrooveSelectType selectType)
 Sets the groove selection type. More...
 
k32u GoProfileGrooveX_SelectIndex (GoProfileGrooveX measurement)
 Gets the current selected groove index. More...
 
GoProfileGrooveSelectType GoProfileGrooveX_SelectType (GoProfileGrooveX measurement)
 Gets the current groove selection type. More...
 
kStatus GoProfileGrooveX_SetSelectIndex (GoProfileGrooveX measurement, k32u selectN)
 Sets the selected groove index. More...
 
kStatus GoProfileGrooveX_SetSelectType (GoProfileGrooveX measurement, GoProfileGrooveSelectType selectType)
 Sets the groove selection type. More...
 
k32u GoProfileGrooveZ_SelectIndex (GoProfileGrooveZ measurement)
 Gets the current selected groove index. More...
 
GoProfileGrooveSelectType GoProfileGrooveZ_SelectType (GoProfileGrooveZ measurement)
 Gets the current groove selection type. More...
 
kStatus GoProfileGrooveZ_SetSelectIndex (GoProfileGrooveZ measurement, k32u selectN)
 Sets the selected groove index. More...
 
kStatus GoProfileGrooveZ_SetSelectType (GoProfileGrooveZ measurement, GoProfileGrooveSelectType selectType)
 Sets the groove selection type. 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

k64f GoProfileGroove_MaxWidth ( GoProfileGroove  tool)

Gets the groove width maximum.

Parameters
toolGoProfileGroove object.
Returns
The groove width maximum value.
k64f GoProfileGroove_MinDepth ( GoProfileGroove  tool)

Gets the groove depth minimum.

Parameters
toolGoProfileGroove object.
Returns
The groove depth minimum value.
k64f GoProfileGroove_MinWidth ( GoProfileGroove  tool)

Gets the groove width minimum value.

Parameters
toolGoProfileGroove object.
Returns
The groove width minimum.
GoProfileRegion GoProfileGroove_Region ( GoProfileGroove  tool)

Gets the profile region.

Parameters
toolGoProfileGroove object.
Returns
The profile region.
kStatus GoProfileGroove_SetMaxWidth ( GoProfileGroove  tool,
k64f  width 
)

Sets the groove width maximum.

Parameters
toolGoProfileGroove object.
widthThe maximum groove width value to set.
Returns
Operation status.
kStatus GoProfileGroove_SetMinDepth ( GoProfileGroove  tool,
k64f  depth 
)

Sets the groove depth minimum.

Parameters
toolGoProfileGroove object.
depthThe minimum groove depth value to set.
Returns
Operation status.
kStatus GoProfileGroove_SetMinWidth ( GoProfileGroove  tool,
k64f  width 
)

Sets the groove width minimum.

Parameters
toolGoProfileGroove object.
widthThe minimum groove width value to set.
Returns
Operation status.
kStatus GoProfileGroove_SetShape ( GoProfileGroove  tool,
GoProfileGrooveShape  shape 
)

Sets the groove determination shape.

Parameters
toolGoProfileGroove object.
shapeThe intended profile groove shape.
Returns
Operation status.
GoProfileGrooveShape GoProfileGroove_Shape ( GoProfileGroove  tool)

Gets the current groove determination shape.

Parameters
toolGoProfileGroove object.
Returns
The profile groove shape.
k32u GoProfileGrooveDepth_SelectIndex ( GoProfileGrooveDepth  measurement)

Gets the current selected groove index.

Parameters
measurementGoProfileGrooveDepth object.
Returns
The current groove index.
GoProfileGrooveSelectType GoProfileGrooveDepth_SelectType ( GoProfileGrooveDepth  measurement)

Gets the current groove selection type.

Parameters
measurementGoProfileGrooveDepth object.
Returns
The profile groove selection type.
kStatus GoProfileGrooveDepth_SetSelectIndex ( GoProfileGrooveDepth  measurement,
k32u  selectN 
)

Sets the selected groove index.

Parameters
measurementGoProfileGrooveDepth object.
selectNThe selected groove index.
Returns
Operation status.
kStatus GoProfileGrooveDepth_SetSelectType ( GoProfileGrooveDepth  measurement,
GoProfileGrooveSelectType  selectType 
)

Sets the groove selection type.

Parameters
measurementGoProfileGrooveDepth object.
selectTypeThe profile groove type.
Returns
Operation status.
k32u GoProfileGrooveWidth_SelectIndex ( GoProfileGrooveWidth  measurement)

Gets the current selected groove index.

Parameters
measurementGoProfileGrooveWidth object.
Returns
The current groove index.
GoProfileGrooveSelectType GoProfileGrooveWidth_SelectType ( GoProfileGrooveWidth  measurement)

Gets the current groove selection type.

Parameters
measurementGoProfileGrooveWidth object.
Returns
The profile groove selection type.
kStatus GoProfileGrooveWidth_SetSelectIndex ( GoProfileGrooveWidth  measurement,
k32u  selectN 
)

Sets the selected groove index.

Parameters
measurementGoProfileGrooveWidth object.
selectNThe selected groove index.
Returns
Operation status.
kStatus GoProfileGrooveWidth_SetSelectType ( GoProfileGrooveWidth  measurement,
GoProfileGrooveSelectType  selectType 
)

Sets the groove selection type.

Parameters
measurementGoProfileGrooveWidth object.
selectTypeThe profile groove type.
Returns
Operation status.
k32u GoProfileGrooveX_SelectIndex ( GoProfileGrooveX  measurement)

Gets the current selected groove index.

Parameters
measurementGoProfileGrooveX object.
Returns
The current groove index.
GoProfileGrooveSelectType GoProfileGrooveX_SelectType ( GoProfileGrooveX  measurement)

Gets the current groove selection type.

Parameters
measurementGoProfileGrooveX object.
Returns
The profile groove selection type.
kStatus GoProfileGrooveX_SetSelectIndex ( GoProfileGrooveX  measurement,
k32u  selectN 
)

Sets the selected groove index.

Parameters
measurementGoProfileGrooveX object.
selectNThe selected groove index.
Returns
Operation status.
kStatus GoProfileGrooveX_SetSelectType ( GoProfileGrooveX  measurement,
GoProfileGrooveSelectType  selectType 
)

Sets the groove selection type.

Parameters
measurementGoProfileGrooveX object.
selectTypeThe profile groove type.
Returns
Operation status.
k32u GoProfileGrooveZ_SelectIndex ( GoProfileGrooveZ  measurement)

Gets the current selected groove index.

Parameters
measurementGoProfileGrooveZ object.
Returns
The current groove index.
GoProfileGrooveSelectType GoProfileGrooveZ_SelectType ( GoProfileGrooveZ  measurement)

Gets the current groove selection type.

Parameters
measurementGoProfileGrooveZ object.
Returns
The profile groove selection type.
kStatus GoProfileGrooveZ_SetSelectIndex ( GoProfileGrooveZ  measurement,
k32u  selectN 
)

Sets the selected groove index.

Parameters
measurementGoProfileGrooveZ object.
selectNThe selected groove index.
Returns
Operation status.
kStatus GoProfileGrooveZ_SetSelectType ( GoProfileGrooveZ  measurement,
GoProfileGrooveSelectType  selectType 
)

Sets the groove selection type.

Parameters
measurementGoProfileGrooveZ object.
selectTypeThe profile groove type.
Returns
Operation status.
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 files: