The maidenhead Reference Manual

Table of Contents

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

The maidenhead Reference Manual

This is the maidenhead Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:31:05 2022 GMT+0.


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

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


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

2 Systems

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


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

2.1 maidenhead

Author

Guillaume Le Vaillant

License

GPL-3

Description

Convert coordinates between Latitude/Longitude and Maidenhead.

Version

1.0

Source

maidenhead.asd (file)

Component

maidenhead.lisp (file)


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

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 files   [Contents][Index]

3.1.1 maidenhead.asd

Location

maidenhead.asd

Systems

maidenhead (system)


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

3.1.2 maidenhead/maidenhead.lisp

Parent

maidenhead (system)

Location

maidenhead.lisp

Packages

maidenhead

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 maidenhead

Source

maidenhead.lisp (file)

Use List

common-lisp

Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: lat/lon->maidenhead LATITUDE LONGITUDE

Return the Maidenhead locator for the given LATITUDE and LONGITUDE.

Package

maidenhead

Source

maidenhead.lisp (file)

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 (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, maidenhead.asd: The maidenhead․asd file
File, Lisp, maidenhead/maidenhead.lisp: The maidenhead/maidenhead․lisp file

L
Lisp File, maidenhead.asd: The maidenhead․asd file
Lisp File, maidenhead/maidenhead.lisp: The maidenhead/maidenhead․lisp file

M
maidenhead.asd: The maidenhead․asd file
maidenhead/maidenhead.lisp: The maidenhead/maidenhead․lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   F   L   M  
Index Entry  Section

F
Function, lat/lon->maidenhead: Exported functions
Function, maidenhead->lat/lon: Exported functions

L
lat/lon->maidenhead: Exported functions

M
maidenhead->lat/lon: Exported functions

Jump to:   F   L   M  

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

A.3 Variables


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

A.4 Data types

Jump to:   M   P   S  
Index Entry  Section

M
maidenhead: The maidenhead system
maidenhead: The maidenhead package

P
Package, maidenhead: The maidenhead package

S
System, maidenhead: The maidenhead system

Jump to:   M   P   S