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 provides a brief description of the Spatial+ COBOL procedures, grouped by purpose.

Initialization and Error Procedures

SPERRGET

Returns details about the last error encountered in the library.

SPERRSHW

Enables/Disables immediate display of error message to the screen.

SPINIT

Initializes the Spatial+ library. Must be called before any other library procedure.

SPTERM

Terminates the Spatial+ library. Must be the last procedure called in the library.

Basic PiP (non ZIP + 4) Procedures

SPATIBNM

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

SPATIBNU

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

SPATIBNU

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

SPATTCNT

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

SPOFFCT

Finds first object containing the input point.

SPOFFCTX

Finds objects based on radius and returns in sorted order.

SPOFFNM

Finds the closest point to a target point.

SPOFGT

Loads a specific object based upon an object handle.

SPOFN

Finds the next object for any SPOFF* procedure.

SPOFFNX

Finds next object for any SPOFFPX procedure and calculates the percentage of the input region overlapped by the returned region in the object file if SPOFFPG was used.

SPOFVDT

Validates the Spatial+ object file.

SPOGTCRD

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

SPOGTINF

Retrieves the header information for the current object.

SPOGTHDL

Retrieves the handle for an object, used with SPOFGT .

SPOGSD

Returns the current search distance for the FILEHANDLE object.

SPOSSD

Sets the current search distance for the FILEHANDLE object.

SPVFLTCR

Validates the filter criteria used in SPOFFNX.

ZIP + 4 PiP Procedures

SPZ4CLS

Closes ZIP + 4 Z9 file after processing.

SPZ4FF

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

SPZ4FN

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

SPZ4OPN

Opens ZIP + 4 Z9 file for processing.

Comparison Procedures

SPARAP

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

SPARBP

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

SPCALLP

Clears Region A and B polygons that were set with SPARAP or SPARBP .

SPCKRO

Checks if Region A and Region B polygons overlap.

SPCKROX

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

SPCLRAP

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

SPCLLAP

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

SPINOCK

Initializes a new polygon overlap check operation.

SPODTB

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

SPOFFNX

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

SPOFFPG

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

SPOFFPX

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

SPOFFREC

Finds first object's MBR overlapping the search rectangle.

SPOFFNX

Finds next object for any SPOFFPX procedure and calculates the percentage of the input region overlapped by the returned region in the object file if SPOFFPG was used.

SPTOCK

Terminates a polygon overlap check operation.

Other Procedures

SPDIST

Returns the distance and bearing between two points.

SPGETV

Returns the version number of the Spatial+ library.

SPOFOP

Opens a Spatial+ object file.

SPOFCL

Closes a Spatial+ object file.

SPOFQRY

Gets header information from a Spatial+ object file.

SPOFFNM

Finds first object matching a name pattern.

SPOHFQRY

Gets header information from a Spatial+ object file.

SPOHFQX

Retrieves additional metadata in the GSB file.