The mgrs Reference Manual
This is the mgrs Reference Manual, version 1.0,
generated automatically by Declt version 4.0 beta 2 "William Riker"
on Mon Feb 26 17:20:12 2024 GMT+0.
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 mgrs
Convert coordinates between Latitude/Longitude and MGRS.
- Author
Guillaume Le Vaillant
- License
GPL-3
- Version
1.0
- Dependency
utm-ups (system).
- Source
mgrs.asd.
- Child Component
mgrs.lisp (file).
3 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
3.1 Lisp
3.1.1 mgrs/mgrs.asd
- Source
mgrs.asd.
- Parent Component
mgrs (system).
- ASDF Systems
mgrs.
3.1.2 mgrs/mgrs.lisp
- Source
mgrs.asd.
- Parent Component
mgrs (system).
- Packages
mgrs.
- Public Interface
-
- Internals
-
4 Packages
Packages are listed by definition order.
4.1 mgrs
- Source
mgrs.lisp.
- Use List
common-lisp.
- 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 Ordinary functions
- Function: lat/lon->mgrs (latitude longitude &optional precision) ¶
-
Return the MGRS locator for the given LATITUDE and LONGITUDE. The PRECISION
(in meters) of the locator can be 1, 10, 100, 1000, 10000.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: mgrs->lat/lon (locator &optional center-p) ¶
-
Return the latitude and longitude for the southwest corner of the given
MGRS LOCATOR square, or the center of the square if CENTER-P is not NIL.
- Package
mgrs.
- Source
mgrs.lisp.
5.2 Internals
5.2.1 Ordinary functions
- Function: false-easting (band) ¶
-
Return the false easting for a UPS BAND.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: false-northing (band) ¶
-
Return the false northing for a UPS BAND.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: letter (n) ¶
-
Return the letter associated to number N.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: letter-position (c) ¶
-
Return the number associated to letter C.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: mgrs/ups->lat/lon (northp band square-x square-y easting northing) ¶
-
Return tle latitude and longitude for the given MGRS coordinates.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: mgrs/utm->lat/lon (zone band square-x square-y easting northing) ¶
-
Return tle latitude and longitude for the given MGRS coordinates.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: minimum-northing (band) ¶
-
Return the minimum northing of a UTM BAND.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: ups->mgrs (northp band easting northing precision) ¶
-
Return the MGRS locator for the given UPS coordinates.
- Package
mgrs.
- Source
mgrs.lisp.
- Function: utm->mgrs (zone band easting northing precision) ¶
-
Return the MGRS locator for the given UTM coordinates.
- Package
mgrs.
- Source
mgrs.lisp.
Appendix A Indexes
A.2 Functions
| |
|
| F | | |
|---|
| false-easting: | | Private ordinary functions |
| false-northing: | | Private ordinary functions |
| Function, false-easting: | | Private ordinary functions |
| Function, false-northing: | | Private ordinary functions |
| Function, lat/lon->mgrs: | | Public ordinary functions |
| Function, letter: | | Private ordinary functions |
| Function, letter-position: | | Private ordinary functions |
| Function, mgrs->lat/lon: | | Public ordinary functions |
| Function, mgrs/ups->lat/lon: | | Private ordinary functions |
| Function, mgrs/utm->lat/lon: | | Private ordinary functions |
| Function, minimum-northing: | | Private ordinary functions |
| Function, ups->mgrs: | | Private ordinary functions |
| Function, utm->mgrs: | | Private ordinary functions |
|
| L | | |
|---|
| lat/lon->mgrs: | | Public ordinary functions |
| letter: | | Private ordinary functions |
| letter-position: | | Private ordinary functions |
|
| M | | |
|---|
| mgrs->lat/lon: | | Public ordinary functions |
| mgrs/ups->lat/lon: | | Private ordinary functions |
| mgrs/utm->lat/lon: | | Private ordinary functions |
| minimum-northing: | | Private ordinary functions |
|
| U | | |
|---|
| ups->mgrs: | | Private ordinary functions |
| utm->mgrs: | | Private ordinary functions |
|