Struct sounding_analysis::StationInfo

pub struct StationInfo { /* fields omitted */ }

Station information including location data and identification number.

Implementations

impl StationInfo

pub fn new_with_values<S, T, U, V, W>(
    station_num: T,
    station_id: S,
    location: U,
    elevation: V
) -> Self where
    S: Into<Option<String>>,
    T: Into<Optioned<i32>>,
    U: Into<Option<(f64, f64)>>,
    Optioned<W>: From<V>,
    W: Noned + Length,
    Meters: From<W>, 

Create a new StationInfo object.

Arguments

station_num: The USAF station identifier, or None.

location: The latitude and longitude as a tuple, or None.

elevation: The elevation of the station in meters.

Examples

use metfor::{Meters, Feet};
use sounding_analysis::StationInfo;
use optional::{some, none};

let _stn = StationInfo::new_with_values(12345, None, (45.2,-113.5), Meters(2000.0));
let _stn = StationInfo::new_with_values(12345, None, (45.2,-113.5), Feet(2000.0));
let _stn = StationInfo::new_with_values(12345, None, (45.2,-113.5), some(Meters(2000.0)));
let _stn = StationInfo::new_with_values(12345, None, (45.2,-113.5), some(Feet(2000.0)));
let _stn = StationInfo::new_with_values(12345, None, Some((45.2,-113.5)), Meters(2000.0));
let _stn = StationInfo::new_with_values(12345, None, Some((45.2,-113.5)), Feet(2000.0));
let _stn = StationInfo::new_with_values(12345, None, Some((45.2,-113.5)), some(Meters(2000.0)));
let _stn = StationInfo::new_with_values(12345, None, Some((45.2,-113.5)), some(Feet(2000.0)));
let _stn = StationInfo::new_with_values(Some(12345), None, None, Meters(2000.0));
let _stn = StationInfo::new_with_values(Some(12345), None, None, Feet(2000.0));
let _stn = StationInfo::new_with_values(None, None, (45.2,-113.5), some(Meters(2000.0)));
let _stn = StationInfo::new_with_values(None, None, (45.2,-113.5), some(Feet(2000.0)));

// Note that lat-lon is an `Option` and not an `Optioned`
let _stn = StationInfo::new_with_values(some(12345), None, None, none::<Feet>());
let _stn = StationInfo::new_with_values(some(12345), None, None, none::<Meters>());

pub fn new() -> Self

Create a new object with default values.

Examples

use sounding_analysis::StationInfo;

assert!(StationInfo::new().station_num().is_none());
assert!(StationInfo::new().location().is_none());
assert!(StationInfo::new().elevation().is_none());

pub fn with_station<T>(self, number: T) -> Self where
    Optioned<i32>: From<T>, 

Builder method to add a station number.

Examples

use sounding_analysis::StationInfo;

assert_eq!(StationInfo::new().with_station(12345).station_num().unwrap(), 12345);
assert_eq!(StationInfo::new().with_station(Some(12345)).station_num().unwrap(), 12345);

pub fn with_lat_lon<T>(self, coords: T) -> Self where
    Option<(f64, f64)>: From<T>, 

Builder method to add a location.

Examples

use sounding_analysis::StationInfo;

assert_eq!(
    StationInfo::new().with_lat_lon((45.0, -116.0)).location().unwrap(), (45.0, -116.0));
assert_eq!(
    StationInfo::new().with_lat_lon(Some((45.0, -116.0)))
        .location()
        .unwrap(),
    (45.0, -116.0));

pub fn with_elevation<T, U>(self, elev: T) -> Self where
    Optioned<U>: From<T>,
    U: Noned + Length,
    Meters: From<U>, 

Builder method to add elevation.

Examples

 use metfor::{Meters, Feet, Km};
 use sounding_analysis::StationInfo;
 use optional::{some, none};

 let _info = StationInfo::new().with_elevation(Feet(200.0));
 let _info = StationInfo::new().with_elevation(Meters(200.0));
 let _info = StationInfo::new().with_elevation(Km(2.0));
 let _info = StationInfo::new().with_elevation(some(Feet(200.0)));
 let _info = StationInfo::new().with_elevation(some(Meters(200.0)));
 let _info = StationInfo::new().with_elevation(some(Km(2.0)));
 let _info = StationInfo::new().with_elevation(none::<Feet>());
 let _info = StationInfo::new().with_elevation(none::<Meters>());
 let _info = StationInfo::new().with_elevation(none::<Km>());

pub fn with_station_id<T>(self, station_id: T) -> Self where
    Option<String>: From<T>, 

Builder method to add a station ID. These are usually 3 or 4 alphanumeric codes that may not be unique to the location like the station number is supposed to be.

pub fn station_num(&self) -> Optioned<i32>

station number, USAF number, eg 727730

pub fn location(&self) -> Option<(f64, f64)>

Latitude and longitude.

pub fn elevation(&self) -> Optioned<Meters>

Elevation in meters, this may be in model terrain, not necessarily the same as the real world.

pub fn station_id(&self) -> Option<&str>

Get the station ID that was used with this station. This is normally a series of 3 or 4 letters. It is not unique to the location like the station number is supposed to be.

Examples

use sounding_analysis::StationInfo;

let info = StationInfo::new().with_station_id("KXLY".to_owned());
assert_eq!(Some("KXLY"), info.station_id());

Trait Implementations

impl Clone for StationInfo

fn clone(&self) -> StationInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StationInfo

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

Formats the value using the given formatter.

impl Default for StationInfo

fn default() -> StationInfo

Returns the “default value” for a type.

impl PartialEq<StationInfo> for StationInfo

fn eq(&self, other: &StationInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StationInfo) -> bool

This method tests for !=.

impl StructuralPartialEq for StationInfo