Function Name: Convert Coord To Given System

Definition

This function converts a coordinate in one spatial reference frame (SRF) to an equivalent coordinate in another SRF.

Returns

SE_COORD_SUCCESS - if valid parameters were passed in and the coordinate operation succeeded. In this case, *dest_coord_ptr is set to the appropriate operation result.

SE_COORD_EXTENDED_SOURCE_COORD - if the operation succeeded, but the source coordinate fell within the "extended" range of the source SRF. In this case, *dest_coord_ptr is set to the appropriate operation result.

SE_COORD_EXTENDED_DEST_COORD - if the operation succeeded, but the source coordinate after being converted fell within the "extended" range for the destination SRF, e.g. a GD coordinate converted to a UTM SRF and falling just outside the specified UTM zone, but not so far outside as to become invalid. In this case, *dest_coord_ptr is set to the appropriate operation result.

SE_COORD_EXTENDED_SOURCE_AND_DEST_COORD - if the operation succeeded, but the source coordinate fell within the "extended" range of the source SRF, and after being converted also fell within the "extended" range for the destination SRF. In this case, *dest_coord_ptr is set to the appropriate operation result.

SE_COORD_UNSUPPORTED - if the coordinate operation (conversion and/or transformation) is unsupported. In this case, *dest_coord_ptr is left unchanged.

SE_COORD_INVALID_SRF_PAIR - if coord_op_params_ptr was NULL or invalid. In this case, *dest_coord_ptr is left unchanged.

SE_COORD_INVALID_SOURCE_COORD - if source_coord_ptr is NULL or points to an invalid value with respect to the source SRF. In this case, *dest_coord_ptr is left unchanged.

SE_COORD_INVALID_DEST_COORD - if dest_coord_ptr is NULL, or the source coordinate after being converted is invalid for the destination SRF, e.g. a GD coordinate of latitude 85 degrees to a UTM SRF. In this case, *dest_coord_ptr is left unchanged.

SE_COORD_FAILURE - if the coordinate operation failed for reasons unspecified. In this case, *dest_coord_ptr is left unchanged.

Prototype


extern SE_COORD_STATUS_CODE_ENUM
SE_ConvertCoordToGivenSystem
(
constSE_CONVERT_COORD_SYSTEM_PAIR coord_op_params_ptr, (notes)
constSE_COORD *source_coord_ptr, (notes)
SE_COORD *dest_coord_ptr (notes)
);

Parameters Notes

coord_op_params_ptr

 a pointer to the optimized coordinate operations parameters.

source_coord_ptr

 a pointer to the incoming coordinate, the coordinate to convert

dest_coord_ptr

 a pointer to where the converted coordinate will be stored. This
 can be the same location that source_coord_ptr points to, but it
 does not have to be.

Prev: Convert Coord Array. Next: Convert Coord To Given System Without Boundary Checking. Up:Index.