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

Description

Represents a ...

+ Inheritance diagram for GoProfileGrooveDepth:

Public Member Functions

kStatus GoMeasurement_ClearId (GoMeasurement measurement)
 Clears the ID for the given measurement. More...
 
k64f GoMeasurement_DecisionMax (GoMeasurement measurement)
 Gets the maximum decision value for the given measurement. More...
 
k64f GoMeasurement_DecisionMin (GoMeasurement measurement)
 Gets the minimum decision value for the given measurement. More...
 
kStatus GoMeasurement_Enable (GoMeasurement measurement, kBool enable)
 Enables the given measurement for output. More...
 
kBool GoMeasurement_Enabled (GoMeasurement measurement)
 Returns whether the given measurement is enabled. More...
 
kBool GoMeasurement_HasId (GoMeasurement measurement)
 Returns whether or not the given measurement has an ID assigned to it. More...
 
k32s GoMeasurement_Id (GoMeasurement measurement)
 Gets the ID for the given measurement. More...
 
kStatus GoMeasurement_SetDecisionMax (GoMeasurement measurement, k64f max)
 Sets the maximum decision value for the given measurement. More...
 
kStatus GoMeasurement_SetDecisionMin (GoMeasurement measurement, k64f min)
 Sets the minimum decision value for the given measurement. More...
 
kStatus GoMeasurement_SetId (GoMeasurement measurement, k32u id)
 Sets an ID number for the given measurement. More...
 
kObject GoMeasurement_SourceTool (GoMeasurement measurement)
 Returns the source tool of the given measurement. More...
 
kStatus GoTools_AssignMeasurementId (GoTools tools, GoMeasurement measurement)
 Given an enabled measurement with a negative ID, update the measurement to utilize a valid ID. More...
 

Member Function Documentation

kStatus GoMeasurement_ClearId ( GoMeasurement  measurement)
inherited

Clears the ID for the given measurement.

Parameters
measurementGoMeasurement object.
Returns
Operation status.
k64f GoMeasurement_DecisionMax ( GoMeasurement  measurement)
inherited

Gets the maximum decision value for the given measurement.

Parameters
measurementGoMeasurement object.
Returns
The maximum decision value.
k64f GoMeasurement_DecisionMin ( GoMeasurement  measurement)
inherited

Gets the minimum decision value for the given measurement.

Parameters
measurementGoMeasurement object.
Returns
The minimum decision value.
kStatus GoMeasurement_Enable ( GoMeasurement  measurement,
kBool  enable 
)
inherited

Enables the given measurement for output.

Parameters
measurementGoMeasurement object.
enableSet to kTRUE to enable the measurement, kFALSE to disable it.
Returns
Operation status.
kBool GoMeasurement_Enabled ( GoMeasurement  measurement)
inherited

Returns whether the given measurement is enabled.

Parameters
measurementGoMeasurement object.
Returns
kTRUE if enabled; kFALSE otherwise.
kBool GoMeasurement_HasId ( GoMeasurement  measurement)
inherited

Returns whether or not the given measurement has an ID assigned to it.

Parameters
measurementGoMeasurement object.
Returns
kTRUE if t here is an ID; kFALSE otherwise.
k32s GoMeasurement_Id ( GoMeasurement  measurement)
inherited

Gets the ID for the given measurement.

Parameters
measurementGoMeasurement object.
Returns
The ID value if there is one assigned. Otherwise, -1 is returned.
kStatus GoMeasurement_SetDecisionMax ( GoMeasurement  measurement,
k64f  max 
)
inherited

Sets the maximum decision value for the given measurement.

Parameters
measurementGoMeasurement object.
maxThe maximum decision value to set.
Returns
The maximum decision value.
kStatus GoMeasurement_SetDecisionMin ( GoMeasurement  measurement,
k64f  min 
)
inherited

Sets the minimum decision value for the given measurement.

Parameters
measurementGoMeasurement object.
minThe minimum decision value to set.
Returns
Operation status.
kStatus GoMeasurement_SetId ( GoMeasurement  measurement,
k32u  id 
)
inherited

Sets an ID number for the given measurement.

Parameters
measurementGoMeasurement object.
idThe ID value to set for the measurement.
Returns
Operation status.
kObject GoMeasurement_SourceTool ( GoMeasurement  measurement)
inherited

Returns the source tool of the given measurement.

Parameters
measurementGoMeasurement object.
Returns
A pointer to the source tool for the measurement.
kStatus GoTools_AssignMeasurementId ( GoTools  tools,
GoMeasurement  measurement 
)
inherited

Given an enabled measurement with a negative ID, update the measurement to utilize a valid ID.

Parameters
toolsGoTools object to use in order to get an available ID
measurementGoMeasurement object to update.
Returns
Operation status.

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