Struct Station

pub struct Station {
    pub label: String,
    pub coords: Point,
    pub index: NodeIndex,
    pub lrud: LRUD,
    pub surface: bool,
    pub underground: bool,
    pub entrance: bool,
    pub exported: bool,
    pub fixed: bool,
    pub anonymous: bool,
    pub wall: bool,
}

Struct representation of a survey station

To retrieve a station, use the helper methods provided by SurveyData. To retrieve a station’s connections to other stations, use the graph provided by the SurveyData instance.

Fields

label: String

The name of the survey station. Anonymous stations will be allocated a randomly generated name (UUID v4).

coords: Point

The coordinates of the survey station.

index: NodeIndex

The index of the survey station in the graph.

lrud: LRUD

The LRUD measurements of the survey station.

surface: bool

Whether the survey station is on the surface.

underground: bool

Whether the survey station is underground.

entrance: bool

Whether the survey station is an entrance.

exported: bool

Whether the survey station is exported.

fixed: bool

Whether the survey station is fixed.

anonymous: bool

Whether the survey station is anonymous.

wall: bool

Whether the survey station is a wall.

Implementations

impl Station

pub fn new(label: String, coords: Point, index: NodeIndex) -> Self

Create a new Station with the given label, coordinates and index. All flags will default to false and the LRUD measurements will default to None.

You may wish to use a helper function, such as read_from_path to import stations from a Survex file instead of calling this function directly

Trait Implementations

impl Clone for Station

fn clone(&self) -> Station

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Station

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

Formats the value using the given formatter.

impl Display for Station

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

Formats the value using the given formatter.

impl PartialEq for Station

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Station