Create Coord Conversion Constants

Function Name: Create Coord Conversion Constants

Definition

This function converts parameters from a given (source, destination) pair of SRFs into an internal structure that will be used to optimize repeated coordinate conversion calls between those two SRFs.

Note that horizontal and vertical datum transformations are not currently supported.

Returns

SE_COORD_SUCCESS - if valid parameters were passed in. In this case, *coord_op_params_ptr will be set to point to a structure allocated by this function. The structure will contain the optimized parameters for converting between the two SRFs. Do not attempt to access or modify this structure. Simply call SE_FreeCoordConversionConstants() when finished with this structure (when you no longer need to convert coordinates between the two SRFs) in order to free the memory used by this structure.

SE_COORD_INVALID_SOURCE_SRF_PARAMETERS - and *coord_op_params_ptr is set to NULL, if source_SRF_params_ptr is NULL or if the source SRF parameters are invalid.

SE_COORD_INVALID_DEST_SRF_PARAMETERS - and *coord_op_params_ptr is set to NULL, if dest_SRF_params_ptr is NULL or if the destination SRF parameters are invalid.

SE_COORD_INVALID_SRF_PAIR - if coord_op_params_ptr was NULL.

SE_COORD_UNSUPPORTED - and *coord_op_params_ptr is set to NULL, if a conversion is specified that is not supported.

SE_COORD_FAILURE - and *coord_op_params_ptr is set to NULL, if a structure to store the optimized conversion parameters cannot be allocated (if the program is out of memory).

Prototype

extern SE_COORD_STATUS_CODE_ENUM
SE_CreateCoordConversionConstants
(
const	SE_SRF_PARAMETERS	*	source_SRF_params_ptr,	(notes)
const	SE_SRF_PARAMETERS	*	dest_SRF_params_ptr,
	SE_CONVERT_COORD_SYSTEM_PAIR	*	coord_op_params_ptr	(notes)
);

Parameters Notes

source_SRF_params_ptr

 the inputs. Pointers to SE_SRF_PARAMETERS structures
    already filled out by the user for the source and destination SRFs that
    the user needs to convert between.

coord_op_params_ptr

 a pointer to an SE_CONVERT_COORD_SYSTEM_PAIR in the user's memory space
 that will be initialized by this call.

Prev: Coord Equal. Next: Cross Product. Up:Index.