Represents a base tool measurement or script output.
Inherits kObject.
Inherited by GoProfileAreaArea, GoProfileAreaCentroidX, GoProfileAreaCentroidZ, GoProfileCircleRadius, GoProfileCircleX, GoProfileCircleZ, GoProfileDimCenterX, GoProfileDimCenterZ, GoProfileDimDistance, GoProfileDimHeight, GoProfileDimWidth, GoProfileGrooveDepth, GoProfileGrooveWidth, GoProfileGrooveX, GoProfileGrooveZ, GoProfileIntersectAngle, GoProfileIntersectX, GoProfileIntersectZ, GoProfileLineMaxError, GoProfileLineMinError, GoProfileLinePercentile, GoProfileLineStdDev, GoProfilePanelFlush, GoProfilePanelGap, GoProfilePositionX, GoProfilePositionZ, GoProfileStripHeight, GoProfileStripWidth, GoProfileStripX, GoProfileStripZ, GoSurfaceBoxGlobalX, GoSurfaceBoxGlobalY, GoSurfaceBoxHeight, GoSurfaceBoxLength, GoSurfaceBoxWidth, GoSurfaceBoxX, GoSurfaceBoxY, GoSurfaceBoxZ, GoSurfaceBoxZAngle, GoSurfaceEllipseMajor, GoSurfaceEllipseMinor, GoSurfaceEllipseRatio, GoSurfaceEllipseZAngle, GoSurfaceHoleRadius, GoSurfaceHoleX, GoSurfaceHoleY, GoSurfaceHoleZ, GoSurfaceOpeningAngle, GoSurfaceOpeningLength, GoSurfaceOpeningWidth, GoSurfaceOpeningX, GoSurfaceOpeningY, GoSurfaceOpeningZ, GoSurfacePlaneXAngle, GoSurfacePlaneYAngle, GoSurfacePlaneZOffset, GoSurfacePositionX, GoSurfacePositionY, GoSurfacePositionZ, GoSurfaceStudBaseX, GoSurfaceStudBaseY, GoSurfaceStudBaseZ, GoSurfaceStudRadius, GoSurfaceStudTipX, GoSurfaceStudTipY, GoSurfaceStudTipZ, GoSurfaceVolumeArea, GoSurfaceVolumeThickness, and GoSurfaceVolumeVolume.
Clears the ID for the given measurement.
- Parameters
-
- Returns
- Operation status.
Gets the maximum decision value for the given measurement.
- Parameters
-
- Returns
- The maximum decision value.
Gets the minimum decision value for the given measurement.
- Parameters
-
- Returns
- The minimum decision value.
kStatus GoMeasurement_Enable |
( |
GoMeasurement |
measurement, |
|
|
kBool |
enable |
|
) |
| |
Enables the given measurement for output.
- Parameters
-
measurement | GoMeasurement object. |
enable | Set to kTRUE to enable the measurement, kFALSE to disable it. |
- Returns
- Operation status.
Returns whether the given measurement is enabled.
- Parameters
-
- Returns
- kTRUE if enabled; kFALSE otherwise.
Returns whether or not the given measurement has an ID assigned to it.
- Parameters
-
- Returns
- kTRUE if t here is an ID; kFALSE otherwise.
Gets the ID for the given measurement.
- Parameters
-
- Returns
- The ID value if there is one assigned. Otherwise, -1 is returned.
kStatus GoMeasurement_SetDecisionMax |
( |
GoMeasurement |
measurement, |
|
|
k64f |
max |
|
) |
| |
Sets the maximum decision value for the given measurement.
- Parameters
-
measurement | GoMeasurement object. |
max | The maximum decision value to set. |
- Returns
- The maximum decision value.
kStatus GoMeasurement_SetDecisionMin |
( |
GoMeasurement |
measurement, |
|
|
k64f |
min |
|
) |
| |
Sets the minimum decision value for the given measurement.
- Parameters
-
measurement | GoMeasurement object. |
min | The minimum decision value to set. |
- Returns
- Operation status.
kStatus GoMeasurement_SetId |
( |
GoMeasurement |
measurement, |
|
|
k32u |
id |
|
) |
| |
Sets an ID number for the given measurement.
- Parameters
-
measurement | GoMeasurement object. |
id | The ID value to set for the measurement. |
- Returns
- Operation status.
Returns the source tool of the given measurement.
- Parameters
-
- Returns
- A pointer to the source tool for the measurement.
Given an enabled measurement with a negative ID, update the measurement to utilize a valid ID.
- Parameters
-
tools | GoTools object to use in order to get an available ID |
measurement | GoMeasurement object to update. |
- Returns
- Operation status.
The documentation for this class was generated from the following files: