Function Name: Check Coordinate In SRF

Definition

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.

Returns

SE_COORD_SUCCESS - if the coordinate in valid in the specified SRF.

SE_COORD_EXTENDED_SOURCE_COORD - if the coordinate fell within the "extended" range of the specified SRF.

SE_COORD_INVALID_SOURCE_COORD - if source_coord_ptr is NULL or points to a coordinate which is invalid with respect to the source SRF.

SE_COORD_INVALID_SOURCE_SRF_PARAMETERS - if SRF_params_ptr is NULL, or points to SRF parameters which are invalid.

SE_COORD_FAILURE - if the coordinate operation failed for reasons unspecified.

Prototype


extern SE_COORD_STATUS_CODE_ENUM
SRM_CheckCoordinateInSRF
(
constSE_SRF_PARAMETERS *SRF_params_ptr, (notes)
constSE_COORD *source_coord_ptr (notes)
);

Parameters Notes

SRF_params_ptr

 a pointer to the SRF parameters.

source_coord_ptr

 a pointer to the coordinate to be checked.

Prev: CMY to CMYK. Next: Convergence Of Meridian. Up:Index.