SRM ChangeCoordinateSRF

SRM Reference Manual Functions SRM ChangeCoordinateSRF

extern SRM_Status_Code
SRM_ChangeCoordinateSRF
(
const	SRM_SRF_Parameters_Pair		coord_op_params_ptr,	(notes)
const	SRM_Coordinate	*	source_coord_ptr,	(notes)
	SRM_Coordinate	*	dest_coord_ptr	(notes)
);

Definition

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

Returns

SRM_STAT_CODE_SUCCESS and *dest_coord_ptr is set to the appropriate operation result, if valid parameters were passed in and the coordinate operation succeeded.

SRM_STAT_CODE_EXTENDED_SOURCE_COORD and *dest_coord_ptr is set to the appropriate operation result, if the operation succeeded, but the source coordinate fell within the "extended" range of the source SRF.

SRM_STAT_CODE_EXTENDED_DEST_COORD and *dest_coord_ptr is set to the appropriate operation result, 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.

SRM_STAT_CODE_EXTENDED_SOURCE_AND_DEST_COORD and *dest_coord_ptr is set to the appropriate operation result, 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.

SRM_STAT_CODE_UNSUPPORTED and *dest_coord_ptr is left unchanged, if the coordinate operation (conversion and/or transformation) is unsupported.

SRM_STAT_CODE_INVALID_SRF_PAIR and *dest_coord_ptr is left unchanged, if coord_op_params_ptr was NULL or invalid.

SRM_STAT_CODE_INVALID_SOURCE_COORD and *dest_coord_ptr is left unchanged, if source_coord_ptr is NULL or points to an invalid value with respect to the source SRF.

SRM_STAT_CODE_INVALID_DEST_COORD and *dest_coord_ptr is left unchanged, 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.

SRM_STAT_CODE_FAILURE and *dest_coord_ptr is left unchanged, if the coordinate operation failed for reasons unspecified.

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.

SRM_STAT_CODE_SUCCESS	and *dest_coord_ptr is set to the appropriate operation result, if valid parameters were passed in and the coordinate operation succeeded.
SRM_STAT_CODE_EXTENDED_SOURCE_COORD	and *dest_coord_ptr is set to the appropriate operation result, if the operation succeeded, but the source coordinate fell within the "extended" range of the source SRF.
SRM_STAT_CODE_EXTENDED_DEST_COORD	and *dest_coord_ptr is set to the appropriate operation result, 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.
SRM_STAT_CODE_EXTENDED_SOURCE_AND_DEST_COORD	and *dest_coord_ptr is set to the appropriate operation result, 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.
SRM_STAT_CODE_UNSUPPORTED	and *dest_coord_ptr is left unchanged, if the coordinate operation (conversion and/or transformation) is unsupported.
SRM_STAT_CODE_INVALID_SRF_PAIR	and *dest_coord_ptr is left unchanged, if coord_op_params_ptr was NULL or invalid.
SRM_STAT_CODE_INVALID_SOURCE_COORD	and *dest_coord_ptr is left unchanged, if source_coord_ptr is NULL or points to an invalid value with respect to the source SRF.
SRM_STAT_CODE_INVALID_DEST_COORD	and *dest_coord_ptr is left unchanged, 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.
SRM_STAT_CODE_FAILURE	and *dest_coord_ptr is left unchanged, if the coordinate operation failed for reasons unspecified.