SRM Reference Manual
Functions
SRM NaturalRegion
extern SRM_Status_Code
SRM_NaturalRegion
(
constSRM_SRF_Parameters *source_SRF_params_ptr, (notes)
SRM_SRF_Parameters *dest_SRF_params_ptr, (notes)
constSRM_Coordinate *source_coord_ptr (notes)
);

Definition

Given a GD SRF, a coordinate defined in that SRF, and a target SRF (specified by the dimensionality and spatial_reference_frame fields of *dest_SRF_params_ptr) determines the 'natural region' of that coordinate.

The current implementation supports only geodetic (GD) source and GCS destination coordinates. The current version of this function supports only cell id mappings that require no horizontal datum transforms.


Returns

SRM_STAT_CODE_SUCCESS and *dest_SRF_params_ptr is set to the 'natural region' of *source_coord_ptr in the target SRF, if valid parameters were passed in.
SRM_STAT_CODE_INVALID_SOURCE_SRF_PARAMETERS and no changes are made, if
  1. source_SRF_params_ptr is NULL,
  2. *source_SRF_params_ptr is not a valid GD SRF, or
  3. *source_SRF_params_ptr is not specified using the WGS84 horizontal datum.
SRM_STAT_CODE_INVALID_SOURCE_COORD and no changes are made, if source_coord_ptr is NULL, or if *source_coord_ptr is not a valid GD coordinate.
SRM_STAT_CODE_INVALID_DEST_SRF_PARAMETERS and no changes are made, if dest_SRF_params_ptr is NULL.


Parameters Notes


source_SRF_params_ptr

 source SRF; must be GD, defined with
    WGS84 horizontal datum; required for coordinate to be checked

dest_SRF_params_ptr

 must be passed in with a valid dimensionality and
    spatial_reference_frame; this function will fill in the
    rest of the structure

source_coord_ptr

 coordinate for which the natural region is to be
    found; must be GD


Prev: SRM_Matrix4x4Sub. Next: SRM_PrintAECCoordinate3D. Up:Index.

Last updated: October 1, 2002 Copyright © 2002 SEDRIS™