The maidenhead Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The maidenhead Reference Manual

This is the maidenhead Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:34:25 2022 GMT+0.

Table of Contents


1 Introduction

#+TITLE: maidenhead

This is a Common Lisp library to convert coordinates between Latitude/Longitude
and Maidenhead locator system.

* API

In the library, latitude and longitude are represented by real numbers
(degrees), positive for northern latitude and eastern longitudes, and negative
for southern latitude and western longitudes.


#+BEGIN_SRC lisp
(lat/lon->maidenhead latitude longitude) -> string
#+END_SRC

Return the Maidenhead locator for the given /latitude/ and /longitude/.


#+BEGIN_SRC lisp
(maidenhead->lat/lon locator &optional center-p) -> list
#+END_SRC

Return the latitude and longitude for the southwest corner of the given
Maidenhead /locator/ square, or the center of the square if /center-p/ is
not ~nil~.

* Examples

Load the library:

#+BEGIN_SRC lisp
> (asdf:load-system "maidenhead")
...
#+END_SRC


Get the Maidenhead locator of Munich:

#+BEGIN_SRC lisp
> (maidenhead:lat/lon->maidenhead 48.14666 11.60833)
"JN58td25"
#+END_SRC


Get back the latitude and longitude of Munich:

#+BEGIN_SRC lisp
> (maidenhead:maidenhead->lat/lon "JN58td25" t)
(48.147916666666674d0 11.60416666666666d0)
#+END_SRC

* Tests

The tests require the /fiveam/ library.

#+BEGIN_SRC lisp
(asdf:test-system "maidenhead")
#+END_SRC


2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 maidenhead

Convert coordinates between Latitude/Longitude and Maidenhead.

Author

Guillaume Le Vaillant

License

GPL-3

Version

1.0

Source

maidenhead.asd.

Child Component

maidenhead.lisp (file).


3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 maidenhead/maidenhead.asd

Source

maidenhead.asd.

Parent Component

maidenhead (system).

ASDF Systems

maidenhead.


3.1.2 maidenhead/maidenhead.lisp

Source

maidenhead.asd.

Parent Component

maidenhead (system).

Packages

maidenhead.

Public Interface

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 maidenhead

Source

maidenhead.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: lat/lon->maidenhead (latitude longitude)

Return the Maidenhead locator for the given LATITUDE and LONGITUDE.

Package

maidenhead.

Source

maidenhead.lisp.

Function: maidenhead->lat/lon (locator &optional center-p)

Return the latitude and longitude for the southwest corner of the given Maidenhead LOCATOR square, or the center of the square if CENTER-P is not NIL.

Package

maidenhead.

Source

maidenhead.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables