|
SRM Reference Manual
Functions SRM GetWGS84GeoidalSeparation |
|---|
| extern SRM_Status_Code | ||||
| SRM_GetWGS84GeoidalSeparation | ||||
| ( | ||||
| const | SRM_GD_Coordinate_2D | * | WGS84GeodeticLocation_ptr, | (notes) |
| SRM_Long_Float | * | GeoidalSeparation_ptr | (notes) | |
| ); | ||||
Returns the height of the WGS84 geoid above or below the WGS84 ellipsoid, at the specified geodetic coordinates, using a grid of height adjustments from the EGM96 gravity model.
This grid of height adjustments must be specified by the environmental variable $SE_WW15MGH_GRD_PATH at run time.
| SRM_STAT_CODE_SUCCESS | and sets *GeoidalSeparation_ptr to the height of the WGS84 geoid above or below the WGS84 ellipsoid, at the specified coordinates. |
| SRM_STAT_CODE_INVALID_SOURCE_COORD | and *GeoidalSeparation_ptr is left unaltered, if WGS84GeodeticLocation_ptr is NULL. |
| SRM_STAT_CODE_INVALID_DEST_COORD | and *GeoidalSeparation_ptr is left unaltered, if *GeoidalSeparation_ptr is NULL. |
| SRM_STAT_CODE_MISSING_WGS84_GEOID_SEPARATION_FILE | and *GeoidalSeparation_ptr is left unaltered, if the environmental variable $SE_WW15MGH_GRD_PATH has not been set, or if the file at that location cannot be located or successfully opened. |
| SRM_STAT_CODE_INVALID_WGS84_GEOID_SEPARATION_FILE | and *GeoidalSeparation_ptr is left unaltered, if the geoidal separation file is not in a valid format. |
| SRM_STAT_CODE_FAILURE | and *GeoidalSeparation_ptr is left unaltered, if the internal geoidal separation table cannot be allocated. |
pointer to a Geodetic location on the WGS84
geoid, for which we want the geoidal separation from the WGS84
ellipsoid.
pointer to an SRM_Long_Float variable in the user's
memory space, into which the geoidal separation at the specified
location will be copied.
Prev: SRM_GetUnits.
Next: SRM_LocalTransformation.
Up:Index.
|