|
SRM Reference Manual
Functions SRM ValidateCoordinate |
|---|
| extern SRM_Status_Code | ||||
| SRM_ValidateCoordinate | ||||
| ( | ||||
| const | SRM_SRF_Template_Parameters | * | SRF_params_ptr, | (notes) |
| const | SRM_Coord | * | source_coord_ptr | (notes) |
| ); | ||||
This function determines whether a coordinate is valid, extended, or invalid with respect to a SRF. "Extended" coordinates fall outside of the well-defined extents of the SRF, however coordinate operations are supported on them but with reduced accuracy (for a variety of reasons). Invalid coordinates fall outside of the range of "extension" and are completely unsupported for use in coordinate operations.
| SRM_STAT_CODE_SUCCESS | if the coordinate is valid in the specified SRF. |
| SRM_STAT_CODE_INVALID_SOURCE_COORDINATE | if source_coord_ptr is NULL or points to a coordinate which is invalid with respect to the source SRF. |
| SRM_STAT_CODE_INVALID_SOURCE_SRF | if SRF_params_ptr is NULL, or points to SRF parameters which are invalid. |
| SRM_STAT_CODE_INACTIONABLE | if the coordinate operation failed for reasons unspecified. |
a pointer to the SRF parameters.
a pointer to the coordinate to be checked.
Prev: SRM_ValidVOSCode.
Next: SRM_VectorMagnitude.
Up:Index.
|