pipRadInit - spatial_geostan - 2024.00

Spatial+ Reference for Windows, UNIX/Linux, z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > Spatial+
Version
2024.00
Language
English
Product name
Spatial+
Title
Spatial+ Reference for Windows, UNIX/Linux, z/OS
Copyright
2024
First publish date
1994
Last updated
2024-05-07
Published on
2024-05-07T22:16:04.316305

Initializes the radial subsystem.

Syntax

intl pipRadInit ( pipHandle h, intl coordSys, pipRadial *rad_h );

Arguments

The handle returned by pipInit for the current instance of Spatial+. Input.

coordSys Indicates whether lat/lon or user coordinates will be used. Input.

*rad_h A radial handle is returned by the function. This handle should be used by all other pipRad_ functions. Output.

Return Value

PIP_OK PIP_ERROR

pipInit.

Prerequisites

Alternates

None.

Notes

This function sets up the Spatial+ library to process a Radial search.

The coordSys parameter is used to indicate which type of coordinates the points and responses will be given in. There are two possible settings:

PIP_COORDS_USER Coordinates are user defined, and Euclidean distances are returned in user units.
PIP_COORDS_LL Coordinates are in millionths of degrees, and distances are returned in feet.

It is important to remember that coordinate type and distance must be maintained for all subsequent Radial calls.

This function returns, via a pointer, a pipRadial handle. This handle should be used for all other pipRad_ functions.