The cl-geocode Reference Manual

This is the cl-geocode Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:10:02 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-geocode

Maintainer

<>

Dependencies
  • aserve (system).
  • acl-compat (system).
  • cl-ppcre (system).
Source

cl-geocode.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-geocode/cl-geocode.asd

Source

cl-geocode.asd.

Parent Component

cl-geocode (system).

ASDF Systems

cl-geocode.


3.1.2 cl-geocode/package.lisp

Source

cl-geocode.asd.

Parent Component

cl-geocode (system).

Packages

cl-geocode.

Public Interface
Internals

3.1.3 cl-geocode/zip-util.lisp

Source

cl-geocode.asd.

Parent Component

cl-geocode (system).

Internals

3.1.4 cl-geocode/geocode.lisp

Dependencies
Source

cl-geocode.asd.

Parent Component

cl-geocode (system).

Public Interface
Internals

*place-to-location-re* (special variable).


4 Packages

Packages are listed by definition order.


4.1 cl-geocode

Source

package.lisp.

Use List
  • acl-compat.excl.
  • common-lisp.
  • net.aserve.
  • net.aserve.client.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *default-key*

A default Google Maps API key for calls to geocode. You can obtain a key by visiting http://www.google.com/apis/maps/signup.html.

Package

cl-geocode.

Source

geocode.lisp.

Special Variable: *zipcodes*
Package

cl-geocode.

Source

geocode.lisp.


5.1.2 Ordinary functions

Function: distance-between (location1 location2 &key unit)

Calculate the straight line distance on the surface of the earth between LOCATION1 and LOCATION2 using the "Great Circle Distance Formula". The values of the keyword UNIT can be :miles (the default), :nautical-miles or :kilometers.

Package

cl-geocode.

Source

geocode.lisp.

Function: geocode (&key q key output)

Geocoding is the process of converting addresses (like "1600 Amphitheatre Parkway, Mountain View, CA") into geographic coodinates (like latitude 37.423021 and longitude -122.083739), which you can use to place markers or position the map based on street addresses in your database or addresses supplied by users. The Google Maps API includes a geocoder that can be accessed via HTTP request.

Package

cl-geocode.

Source

geocode.lisp.

Reader: location-latitude (instance)
Writer: (setf location-latitude) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

latitude.

Reader: location-longitude (instance)
Writer: (setf location-longitude) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

longitude.

Function: location-near-p (location reference within)

Is LOCATION near REFERENCE location to WITHIN decimal degrees in both latitude and longitude?

Package

cl-geocode.

Source

geocode.lisp.

Function: location-to-place (location)
Package

cl-geocode.

Source

geocode.lisp.

Function: location-to-zipcode (location)
Package

cl-geocode.

Source

geocode.lisp.

Function: make-location (&key latitude longitude)
Package

cl-geocode.

Source

package.lisp.

Function: place-to-location (place &key key)
Package

cl-geocode.

Source

geocode.lisp.

Reader: zipcode-city (instance)
Writer: (setf zipcode-city) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

city.

Reader: zipcode-code (instance)
Writer: (setf zipcode-code) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

code.

Function: zipcode-p (object)
Package

cl-geocode.

Source

package.lisp.

Reader: zipcode-state (instance)
Writer: (setf zipcode-state) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

state.

Reader: zipcode-state-abbrev (instance)
Writer: (setf zipcode-state-abbrev) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

state-abbrev.


5.1.3 Standalone methods

Method: make-load-form ((self location) &optional environment)
Source

package.lisp.

Method: print-object ((location location) stream)
Source

package.lisp.

Method: print-object ((zipcode zipcode) stream)
Source

package.lisp.


5.1.4 Structures

Structure: location
Package

cl-geocode.

Source

package.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: latitude
Readers

location-latitude.

Writers

(setf location-latitude).

Slot: longitude
Readers

location-longitude.

Writers

(setf location-longitude).


5.2 Internals


5.2.1 Special variables

Special Variable: *place-to-location-re*
Package

cl-geocode.

Source

geocode.lisp.


5.2.2 Ordinary functions

Function: copy-location (instance)
Package

cl-geocode.

Source

package.lisp.

Function: copy-zipcode (instance)
Package

cl-geocode.

Source

package.lisp.

Function: location-p (object)
Package

cl-geocode.

Source

package.lisp.

Function: make-zipcode (&key code state-abbrev location city state)
Package

cl-geocode.

Source

package.lisp.

Function: read-zipcodes-csv (csv-file)
Package

cl-geocode.

Source

zip-util.lisp.

Function: vector-of (vector function)
Package

cl-geocode.

Source

zip-util.lisp.

Reader: zipcode-location (instance)
Writer: (setf zipcode-location) (instance)
Package

cl-geocode.

Source

package.lisp.

Target Slot

location.


5.2.3 Structures

Structure: zipcode
Package

cl-geocode.

Source

package.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: code
Readers

zipcode-code.

Writers

(setf zipcode-code).

Slot: state-abbrev
Readers

zipcode-state-abbrev.

Writers

(setf zipcode-state-abbrev).

Slot: location
Readers

zipcode-location.

Writers

(setf zipcode-location).

Slot: city
Readers

zipcode-city.

Writers

(setf zipcode-city).

Slot: state
Readers

zipcode-state.

Writers

(setf zipcode-state).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   F   G   L   M   P   R   V   Z  
Index Entry  Section

(
(setf location-latitude): Public ordinary functions
(setf location-longitude): Public ordinary functions
(setf zipcode-city): Public ordinary functions
(setf zipcode-code): Public ordinary functions
(setf zipcode-location): Private ordinary functions
(setf zipcode-state): Public ordinary functions
(setf zipcode-state-abbrev): Public ordinary functions

C
copy-location: Private ordinary functions
copy-zipcode: Private ordinary functions

D
distance-between: Public ordinary functions

F
Function, (setf location-latitude): Public ordinary functions
Function, (setf location-longitude): Public ordinary functions
Function, (setf zipcode-city): Public ordinary functions
Function, (setf zipcode-code): Public ordinary functions
Function, (setf zipcode-location): Private ordinary functions
Function, (setf zipcode-state): Public ordinary functions
Function, (setf zipcode-state-abbrev): Public ordinary functions
Function, copy-location: Private ordinary functions
Function, copy-zipcode: Private ordinary functions
Function, distance-between: Public ordinary functions
Function, geocode: Public ordinary functions
Function, location-latitude: Public ordinary functions
Function, location-longitude: Public ordinary functions
Function, location-near-p: Public ordinary functions
Function, location-p: Private ordinary functions
Function, location-to-place: Public ordinary functions
Function, location-to-zipcode: Public ordinary functions
Function, make-location: Public ordinary functions
Function, make-zipcode: Private ordinary functions
Function, place-to-location: Public ordinary functions
Function, read-zipcodes-csv: Private ordinary functions
Function, vector-of: Private ordinary functions
Function, zipcode-city: Public ordinary functions
Function, zipcode-code: Public ordinary functions
Function, zipcode-location: Private ordinary functions
Function, zipcode-p: Public ordinary functions
Function, zipcode-state: Public ordinary functions
Function, zipcode-state-abbrev: Public ordinary functions

G
geocode: Public ordinary functions

L
location-latitude: Public ordinary functions
location-longitude: Public ordinary functions
location-near-p: Public ordinary functions
location-p: Private ordinary functions
location-to-place: Public ordinary functions
location-to-zipcode: Public ordinary functions

M
make-load-form: Public standalone methods
make-location: Public ordinary functions
make-zipcode: Private ordinary functions
Method, make-load-form: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
place-to-location: Public ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

R
read-zipcodes-csv: Private ordinary functions

V
vector-of: Private ordinary functions

Z
zipcode-city: Public ordinary functions
zipcode-code: Public ordinary functions
zipcode-location: Private ordinary functions
zipcode-p: Public ordinary functions
zipcode-state: Public ordinary functions
zipcode-state-abbrev: Public ordinary functions