SRM DeriveCoordinate3DFrom2DForGivenElevation

SRM Reference Manual Functions SRM DeriveCoordinate3DFrom2DForGivenElevation

extern SRM_Status_Code
SRM_DeriveCoordinate3DFrom2DForGivenElevation
(
const	SRM_Coordinate_2D	*	coord_2d_ptr,	(notes)
	SRM_Long_Float		elevation,	(notes)
	SRM_Coordinate_3D	*	coord_3d_ptr	(notes)
);

Definition

Given a 2D coordinate, expressed in an SRF that has a corresponding 3D SRF, and given a z/elevation, constructs the corresponding 3D representation of the given coordinate.

Returns

SRM_STAT_CODE_SUCCESS and *coord_3d_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.

SRM_STAT_CODE_INVALID_DEST_COORD and *coord_3d_ptr is left unaltered, if coord_3d_ptr is NULL.

SRM_STAT_CODE_INVALID_SOURCE_COORD and *coord_3d_ptr is left unaltered, if coord_2d_ptr is NULL or is expressed in a 2D SRF that has no corresponding 3D SRF.

Parameters Notes

coord_2d_ptr

 pointer to the 2D coordinate for which we are obtaining a
 corresponding 3D coordinate.

elevation

 given z/elevation

coord_3d_ptr

 pointer to the 3D coordinate that we are deriving.

SRM_STAT_CODE_SUCCESS	and *coord_3d_ptr is set appropriately, if valid parameters were passed in and all operations succeeded.
SRM_STAT_CODE_INVALID_DEST_COORD	and *coord_3d_ptr is left unaltered, if coord_3d_ptr is NULL.
SRM_STAT_CODE_INVALID_SOURCE_COORD	and *coord_3d_ptr is left unaltered, if coord_2d_ptr is NULL or is expressed in a 2D SRF that has no corresponding 3D SRF.