MIL_ID ResultId, | //in |
MIL_INT LabelOrIndex, | //in |
MIL_INT64 ResultType, | //in |
void *ResultArrayPtr | //out |
This function retrieves all results of the specified type from a metrology result buffer, after an MmetCalculate() call. The result entries are ordered by label value.
If your target image was associated with a calibration context, positional and dimensional results are, by default, returned with respect to the relative coordinate system of the image. Otherwise, these results are returned in pixels, relative to the top-left pixel in the target image.
If your target image was associated with a calibration context but you want to retrieve positional and dimensional results in pixel units, use MmetControl() with the M_RESULT_OUTPUT_UNITS control type set to M_PIXEL. However, note that if you set M_RESULT_OUTPUT_UNITS to M_WORLD without specifying a calibrated image in which to calculate the results, MmetGetResult() will generate an error.
All results are returned relative to the output reference frame that you set using MmetControl() with M_OUTPUT_FRAME.
Specifies the feature or geometric tolerance for which to get results. Labels must be greater than 0 while indices can be equal to 0.
To specify a context, feature, geometric tolerance, or result buffer, select the following.
For specifying a context, feature,
tolerance, or result buffer
|
|||||||||||||||||||||||||||||||||||||||
Value |
Description
|
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Same as M_GENERAL. |
||||||||||||||||||||||||||||||||||||||
Specifies the index value of an existing individual feature for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index. |
|||||||||||||||||||||||||||||||||||||||
Specifies the label of an existing individual feature for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label. |
|||||||||||||||||||||||||||||||||||||||
Specifies the index value of an existing individual tolerance for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index. |
|||||||||||||||||||||||||||||||||||||||
Specifies the label value of an existing individual tolerance for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label. |
|||||||||||||||||||||||||||||||||||||||
M_ALL_FEATURES |
Specifies to return results about all features. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_ALL_TOLERANCES |
Specifies to return results about all tolerances. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_CONSTRUCTED_FEATURES |
Specifies to return results about all constructed features. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_GENERAL |
Specifies that the results relating to the entire metrology context will be returned. |
||||||||||||||||||||||||||||||||||||||
M_GLOBAL_FRAME |
Specifies that information about the global frame of the context will be returned. |
||||||||||||||||||||||||||||||||||||||
M_MEASURED_FEATURES |
Specifies to return results about all measured features. (more details...) |
Specifies the type of result to retrieve.
See the Parameter associations section for possible values that can be specified.
Specifies the address of the first element of the array in which to write the requested information.
See the Parameter associations section for possible values that can be returned.
The tables below list possible values for the ResultType parameter and possible values returned to the ResultArrayPtr parameter.
To retrieve general results, the LabelOrIndex parameter must be set to M_GENERAL.
Unless otherwise specified, the following values require that you pass the ResultArrayPtr parameter the address of a MIL_DOUBLE.
For retrieving general
results
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_CONSTRUCTED_FEATURES + |
Retrieves the number of constructed features. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_FEATURES + |
Retrieves the total number of features. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_FEATURES_FAIL + |
Retrieves the number of features that are not successfully calculated. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_FEATURES_PASS + |
Retrieves the number of features that are successfully calculated. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_MEASURED_FEATURES + |
Retrieves the number of measured features. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_TOLERANCES + |
Retrieves the number of tolerances. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_TOLERANCES_FAIL + |
Retrieves the number of tolerances that have the status M_FAIL, which is the resulting status when tolerance values are smaller than M_VALUE_MIN or greater than M_VALUE_MAX. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_TOLERANCES_PASS + |
Retrieves the number of tolerances that have the status M_PASS, which is the resulting status when it is not M_FAIL or M_WARNING. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_OF_TOLERANCES_WARNING + |
Retrieves the number of tolerances that have the status M_WARNING, which is the resulting status when tolerance values are greater or equal to M_VALUE_MIN and lower than M_VALUE_WARNING_MIN. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_TIMEOUT_END + |
Retrieves whether the timeout has been reached. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FALSE |
Specifies that the timeout has not been reached. |
||||||||||||||||||||||||||||||||||||||
M_TRUE |
Specifies that the timeout has been reached. |
To retrieve results for features, the LabelOrIndex parameter can be set to M_GLOBAL_FRAME or an existing feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX().
Unless otherwise specified, the following values require that you pass the ResultArrayPtr parameter the address of a MIL_DOUBLE.
For retrieving results for
features
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_ANGLE + |
Retrieves the aperture of an arc or the angle of a segment, a line, or a local frame. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_ANGLE_END + |
Retrieves the end angle of an arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_ANGLE_START + |
Retrieves the start angle of an arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_COVERAGE + |
Retrieves the portion of the feature that was covered by the fitted edgels, as a percentage. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_LENGTH + |
Retrieves the perimeter of a circle or the length of a segment or arc feature. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_LINE_A + |
Retrieves the coefficient A of the equation for a constructed line. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_LINE_B + |
Retrieves the coefficient B of the equation for a constructed line. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_LINE_C + |
Retrieves the coefficient C of the equation for a constructed line. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER + |
Retrieves the number of subfeatures in a multiple feature or the number of edgels in an edgel feature. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_END_X + |
Retrieves the X-coordinate of the ending point of a segment or arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_END_Y + |
Retrieves the Y-coordinate of the ending point of a segment or arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_START_X + |
Retrieves the X-coordinate of the starting point of a segment or arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_START_Y + |
Retrieves the Y-coordinate of the starting point of a segment or arc. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_X + |
Retrieves the X-coordinate of a point or edgel, the X-coordinate of the center of a circle or arc, or the X-coordinate of the origin of a local frame. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_Y + |
Retrieves the Y-coordinate of a point or edgel, the Y-coordinate of the center of a circle or arc, or the Y-coordinate of the origin of a local frame. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_RADIUS + |
Retrieves the radius of a circle or arc feature. (more details...) |
To retrieve tolerance results, the LabelOrIndex parameter can be set to an existing tolerance label or index using M_TOLERANCE_LABEL() or using M_TOLERANCE_INDEX().
Unless otherwise specified, the following values require that you pass the ResultArrayPtr parameter the address of a MIL_DOUBLE.
For retrieving results for
tolerances
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_TOLERANCE_VALUE + |
Retrieves the calculated geometric tolerance value. (more details...) |
To retrieve results for features, the LabelOrIndex parameter can be set to M_GLOBAL_FRAME or an existing feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX(). To retrieve tolerance results, the LabelOrIndex parameter can be set to an existing tolerance label or index using M_TOLERANCE_LABEL() or using M_TOLERANCE_INDEX().
Unless otherwise specified, the following values require that you pass the ResultArrayPtr parameter the address of a MIL_DOUBLE.
For retrieving results for features or
tolerances
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_LABEL_VALUE + |
Retrieves the label of a specific feature or a specific tolerance. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_STATUS + |
Retrieves the status of the calculation of features and tolerances. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies that the feature was not calculated successfully, and/or the tolerance has not passed all restrictions. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies that the feature was calculated successfully, and/or the geometric tolerance has passed all restrictions. |
||||||||||||||||||||||||||||||||||||||
M_WARNING |
Specifies that the geometric tolerance has passed all restrictions, with a warning. (more details...) |
You can add the following value to the above-mentioned values to determine whether a result is available.
For determining whether results are
available
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_AVAILABLE |
Retrieves whether a result is available to be returned. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
Data
type: MIL_DOUBLE |
||||||||||||||||||||||||||||||||||||||
M_NULL |
Specifies that the result is not available to be retrieved. |
||||||||||||||||||||||||||||||||||||||
Value != 0 |
Specifies that the result is available to be retrieved. |
You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.
For specifying the data type
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_DOUBLE |
Casts the requested results to a MIL_DOUBLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_ID |
Casts the requested results to a MIL_ID. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT |
Casts the requested results to a MIL_INT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT32 |
Casts the requested results to a MIL_INT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT64 |
Casts the requested results to a MIL_INT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
ResultArrayPtr data type info |
|
Header | Include mil.h. |
Library | Use mil.lib; milmetrol.lib. |
DLL | Requires mil.dll; milmetrol.dll. |