Struct gpx::Waypoint

pub struct Waypoint {
    pub elevation: Option<f64>,
    pub speed: Option<f64>,
    pub time: Option<DateTime<Utc>>,
    pub name: Option<String>,
    pub comment: Option<String>,
    pub description: Option<String>,
    pub source: Option<String>,
    pub links: Vec<Link>,
    pub symbol: Option<String>,
    pub _type: Option<String>,
    pub geoidheight: Option<f64>,
    pub fix: Option<Fix>,
    pub sat: Option<u64>,
    pub hdop: Option<f64>,
    pub vdop: Option<f64>,
    pub pdop: Option<f64>,
    pub age: Option<f64>,
    pub dgpsid: Option<u16>,
    // some fields omitted
}

Waypoint represents a waypoint, point of interest, or named feature on a map.

Fields

elevation: Option<f64>

Elevation (in meters) of the point.

speed: Option<f64>

Speed (in meters per second) (only in GPX 1.0)

time: Option<DateTime<Utc>>

Creation/modification timestamp for element. Date and time in are in Univeral Coordinated Time (UTC), not local time! Conforms to ISO 8601 specification for date/time representation. Fractional seconds are allowed for millisecond timing in tracklogs.

name: Option<String>

The GPS name of the waypoint. This field will be transferred to and from the GPS. GPX does not place restrictions on the length of this field or the characters contained in it. It is up to the receiving application to validate the field before sending it to the GPS.

comment: Option<String>

GPS waypoint comment. Sent to GPS as comment.

description: Option<String>

A text description of the element. Holds additional information about the element intended for the user, not the GPS.

source: Option<String>

Source of data. Included to give user some idea of reliability and accuracy of data. "Garmin eTrex", "USGS quad Boston North", e.g.

links: Vec<Link>

Links to additional information about the waypoint.

symbol: Option<String>

Text of GPS symbol name. For interchange with other programs, use the exact spelling of the symbol as displayed on the GPS. If the GPS abbreviates words, spell them out.

_type: Option<String>

Type (classification) of the waypoint.

geoidheight: Option<f64>

Height of geoid in meters above WGS 84. This correspond to the sea level.

fix: Option<Fix>

Type of GPS fix. none means GPS had no fix. To signify "the fix info is unknown", leave out fix entirely. Value comes from the list {'none'|'2d'|'3d'|'dgps'|'pps'}, where pps means that the military signal was used.

sat: Option<u64>

Number of satellites used to calculate the GPX fix.

hdop: Option<f64>

Horizontal dilution of precision.

vdop: Option<f64>

Vertical dilution of precision.

pdop: Option<f64>

Positional dilution of precision.

age: Option<f64>

Number of seconds since last DGPS update, from the element.

dgpsid: Option<u16>

ID of DGPS station used in differential correction, in the range [0, 1023].

Methods

impl Waypoint

pub fn point(&self) -> Point<f64>

Gives the geographical point of the waypoint.

extern crate geo_types;
extern crate gpx;

use gpx::Waypoint;
use geo_types::Point;

fn main() {
    // Kind of useless, but it shows the point.
    let wpt = Waypoint::new(Point::new(-121.97, 37.24));
    let point = wpt.point();

    println!("waypoint latitude: {}, longitude: {}", point.lat(), point.lng());
}

pub fn new(point: Point<f64>) -> Waypoint

Creates a new Waypoint from a given geographical point.

extern crate geo_types;
extern crate gpx;

use gpx::Waypoint;
use geo_types::Point;

fn main() {
    let point = Point::new(-121.97, 37.24);

    let mut wpt = Waypoint::new(point);
    wpt.elevation = Some(553.21);
}

Trait Implementations

impl Clone for Waypoint

fn clone(&self) -> Waypoint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Waypoint

fn default() -> Waypoint

Returns the "default value" for a type.

impl From<Waypoint> for Geometry<f64>

fn from(waypoint: Waypoint) -> Geometry<f64>

Performs the conversion.

impl Debug for Waypoint

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.