pipRadFindFirstInRadius - 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

Finds the first point within a given radius.

Syntax

intl pipRadFindFirstInRadius ( pipRadial rad_h, intl lonCenter, intl

latCenter, intl radius, intl *lon, intl *lat, pstr name, intl nameSize );

Arguments

rad_h The handle returned by pipRadInit for the current radial analysis. Input.

lonCenter The x coordinate or longitude of the center of the circle. Input. latCenter The y coordinate or latitude of the center of the circle. Input. radius The radius, in feet or user units, depending upon the coordSys set

in pipRadInit Maximum search radius is 715,827,882 feet.

Input.

*lon A pointer to the x coordinate or longitude of the located point.

Output.

*lat A pointer to the y coordinate or latitude of the located point.

Output.

name A pointer to a buffer to be filled with the name of the located point.

Output.

nameSize The size, in bytes, of the name of the located point. Input.

Prerequisites

pipRadInsertPoint or pipRadLoadPoints.

Alternates

None.

Return Value

PIP_OK PIP_NOT_FOUND PIP_ERROR

Notes

This function returns the first point found in the radial search tree that falls within the circle described by lonCenter, latCenter, and radius. Points are returned in no particular order (the point returned is not necessarily the nearest to the target point).

To get distance and bearing to the returned point, use pipDistance.

If no point is found within a given radius, the function returns PIP_NOT_FOUND.