Quick Reference - 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

This section describes the Spatial+ C functions, grouped by purpose.

Spatial+ Library Management Functions

pipInit

Initializes the Spatial+ library.

pipTerm

Terminates the Spatial+ library.

pipErrorGet

Returns details about most recent error or message.

pipErrorShow

Enables/disables immediate display of error message.

Importing Functions

pipImportInit

Creates and opens a GSB file; initializes the import subsystem.

pipImportInitEx

Allows the user to store and retrieve additional meta data in the GSB file.

pipImportOpenBNA

Opens ESRI Atlas GIS BNA file for import.

pipImportOpenMIF2

Opens MapInfo® MIF/MID file for import specifying two name fields.

pipImportOpenShape

Opens a set of Shape files for importing (ESRI file format).

pipImportOpenTab

Opens a set of Tab files for importing (MapInfo file format).

pipImportRead

During import, reads and write into the object file the next object from a BNA, MIF/MID, SHP, or TAB file.

pipImportInsert

Writes an object into an object file that was not from a BNA, MIF/MID, SHP, or TAB file.

pipImportClose

Closes the import MIF/MID, BNA, SHP, or TAB file.

pipImportTerm

Cleans up and deletes the pipImporter resources and determines whether the object file is to be kept or discarded. Terminates the import subsystem.

Exporting Functions

pipExportInitBNA

Creates and opens a BNA file for writing; initializes the export subsystem.

pipExportInitMIF

Creates and opens a MIF/MID file for writing; initializes the export subsystem.

pipExportInitShape

Creates and opens a set of Shape files for writing; initializes the export subsystem.

pipExportInitTab

Creates and opens a set of Tab files for writing; initializes the export subsystem.

pipExportOpen

Opens a GSB file whose contents is exported to a BNA, MIF/MID, SHP, or TAB file.

pipExportWrite

Writes an object from a GSB file to a BNA, MIF/MID, SHP, or TAB file.

pipExportInsert

Writes an object that was not from a GSB file to a BNA, MIF/MID, SHP, or TAB file.

pipExportClose

Closes the GSB file used for export.

pipExportTerm

Cleans up and deletes the pipExporter resources, and determines whether the export file is to be kept or discarded. Terminates the export subsystem.

Basic PiP (Non ZIP + 4) Functions

pipObjectFileGoto

Loads a specific object based upon an object handle.

pipObjectFileGoto64

Loads a specific object associated with the handle passed in for large files.

pipObjectFindFirstContaining

Finds first object containing the input point.

pipObjectFindFirstContainingEx

Finds objects based on radius and returns in sorted order.

pipObjectFindFirstNearest

Finds the closest point to a target point.

pipObjectFindFirstNearestEx

Finds the closest point to a target point using a filter to reject unwanted objects.

pipObjectFindNext

Finds next object for any pipObjectFindFirst function.

pipObjectGetAttributeCount

Returns the number of attributes present in the associated GSA file.

pipObjectGetAttributeInfoByName

Retrieves the data in the GSA attribute file based on the name of the attribute.

pipObjectGetAttributeInfoByNumber

Retrieves the data in the GSA attribute file based on the column number.

pipObjectGetAttributeNameByNumber

Retrieves the field name information in the GSA attribute file by column number.

pipObjectGetCoords

Retrieves the coordinate pairs of the current object in the object file.

pipObjectGetInfo

Retrieves the header information for the current object.

pipObjectGetHandle

Retrieves the handle for an object—used with pipObjectFileGoTo .

pipObjectGetHandle64

Retrieves the individual object handle for the current object for large files.

pipObjectGetSearchDistance

Returns the current search distance for the pipObjectFile object.

pipObjectSetSearchDistance

Sets the current search distance for the pipObjectFile object.

ZIP + 4 PiP Functions

pipZip4FileOpen

Opens ZIP + 4 Z9 file for processing.

pipZip4FindFirst

Finds first ZIP + 4 in any object in the object file.

pipZip4FindNext

Finds next ZIP + 4 in any object in the object file.

pipZip4FileClose

Closes ZIP + 4 Z9 file after processing.

Radial Functions

pipRadInit

Initializes the radial subsystem.

pipRadLoadPoints

Loads all point objects from a Spatial+ object file into the radial search tree.

pipRadInsertPoint

Adds a point to the search tree being constructed.

pipRadFindFirstInRect

Finds the first point in a rectangle.

pipRadFindFirstInRadius

Finds the first point within a given radius.

pipRadFindFirstNearest

Finds the closest point to a given point.

pipRadFindNext

Finds the next point to a given point.

pipRadTerm

Terminates the radial subsystem and frees resources.

Comparison Functions

pipInitializeOverlapCheck

Initializes a new polygon overlap check operation.

pipAddRegionAPolygon

Defines "Region A" polygons for use in determining whether two regions overlap.

pipAddRegionBPolygon

Defines "Region B" polygon for use in determining whether two regions overlap.

pipCheckForRegionOverlap

Checks if Region A and Region B polygons overlap.

pipCheckForRegionOverlapEx

Checks if Region A and Region B polygon overlap and calculates the percentage of Region A overlapped by Region B.

pipClearRegionAPolygon

Clears "Region A" polygon that was set with pipAddRegionAPolygon .

pipClearRegionBPolygon

Clears "Region B" polygon that was set with pipAddRegionBPolygon .

pipClearRegionAllPolygon

Clears Region A and B polygons that were set with pipAddRegionAPolygon or pipAddRegionBPolygon.

pipObjectFindFirstPolygon

Finds first polygon in the object file overlapping the input polygon.

pipObjectFindFirstPolygonEx

Finds first polygon overlapping the input polygon and calculates the percentage of the input polygon overlapped by the polygon in the object file.

pipObjectFindFirstRect

Finds first object's mbr overlapping the search rectangle.

pipObjectFindNextEx

Finds next object for any pipObjectFindFirstPolygonEx function and calculates the percentage of the input region overlapped by the returned region in the object file.

pipTerminateOverlapCheck

Terminates a polygon overlap check operation.

pipObjectDistanceToBorder

Computes the distance from a point to the border of the current object.

Other Functions

pipDistance

Returns the distance and bearing between two points.

pipGetVersion

Returns the version number of the Spatial+ library.

pipObjectFileOpen

Opens a Spatial+ object file.

pipObjectFileClose

Closes a Spatial+ object file.

pipObjectFileQuery

Gets header information from a Spatial+ object file.

pipObjectFileValidate

Validates the Spatial+ object file.

pipObjectFindFirstContainingEx

Finds first object matching a name pattern.

pipObjectHandleFileQuery

Gets header information from a Spatial+ object file.

pipObjectHandleFileQueryEx

Retrieves additional meta data in the GSB file.

pipObjectValidateFilterCriteria

Validates the filter criteria used in ObjectFindFirstNearestEx.