package mlgpx

  1. Overview
  2. Docs
Library and CLI for parsing and generating GPS Exchange (GPX) formats

Install 

dune-project
 Dependency

tangled.sh Readme Changelog ISC License Edit opam file Versions (1)

Authors

  1. A
    Anil Madhavapeddy

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Sources

mlgpx-1.0.0.tbz
md5=5342bb7e601273245a9fe263e5a08770
sha512=cd73b16e988b3ed3cc427a6c6c6d6c9c745adb1eb7efaae3c34e8d006e9c03d9f9d2616cd4118564bd9873903969d3e4053b585e79dbd3e3e7d0f541e2faac83

doc/mlgpx.core/Gpx/Metadata/index.html

Module Gpx.MetadataSource

GPX metadata including bounds

The Metadata module handles document-level information:

  • File name and description
  • Author and copyright information
  • Creation time and keywords
  • Geographic bounding box of all data
  • Links to related resources

GPX metadata and bounds types

Sourcetype bounds = {
  1. minlat : Coordinate.latitude;
  2. minlon : Coordinate.longitude;
  3. maxlat : Coordinate.latitude;
  4. maxlon : Coordinate.longitude;
}

Bounding box

Sourcetype t = {
  1. name : string option;
  2. desc : string option;
  3. author : Link.person option;
  4. copyright : Link.copyright option;
  5. time : Ptime.t option;
  6. keywords : string option;
  7. bounds : bounds option;
  8. extensions : Extension.t list;
}

Main metadata type

Bounds Operations

Sourcemodule Bounds : sig ... end

Metadata Operations

Sourceval empty : t

Create empty metadata

Sourceval make : name:string -> t

Create metadata with name

Sourceval name : t -> string option

Get name

Sourceval description : t -> string option

Get description

Sourceval author : t -> Link.person option

Get author

Get copyright

Get links

Sourceval time : t -> Ptime.t option

Get time

Sourceval keywords : t -> string option

Get keywords

Sourceval bounds_opt : t -> bounds option

Get bounds

Sourceval extensions : t -> Extension.t list

Get extensions

Functional operations for building metadata

Sourceval with_name : t -> string -> t

Update name

Sourceval with_description : t -> string -> t

Update description

Sourceval with_keywords : t -> string -> t

Update keywords

Sourceval with_time : t -> Ptime.t option -> t

Update time

Sourceval with_bounds : t -> bounds -> t

Update bounds

Sourceval with_author : t -> Link.person -> t

Update author

Update copyright

Add link

Sourceval add_extensions : t -> Extension.t list -> t

Add extensions

Sourceval compare : t -> t -> int

Compare metadata

Sourceval equal : t -> t -> bool

Test metadata equality

Sourceval pp : Format.formatter -> t -> unit

Pretty print metadata