Struct survex_rs::data::SurveyData

pub struct SurveyData {
    pub stations: Stations,
    pub graph: StationGraph,
}

Handles the creation and management of stations, as well as holding the graph of stations.

Fields

stations: Stations

graph: StationGraph

Implementations

impl SurveyData

pub fn new() -> Self

Create an empty SurveyData instance with no stations or connections. This method should not be used directly. Instead, create a SurveyData instance from a Survex file using the load_from_path helper function.

pub fn get_by_label(&self, label: &str) -> Option<RefStation>

Retrieve a reference to a Station by its label. Only exact matches are returned. To retrieve a station by partial label use get_by_label_part.

pub fn get_by_label_part(&self, label: &str) -> Option<RefStation>

Retrieve a reference to a Station by its label, allowing for partial matches. If multiple stations match the given label, None is returned, unless one of the matches is an exact match, in which case that station is returned.

pub fn get_by_coords(&self, coords: &Point) -> Option<RefStation>

Retrieve a reference to a Station by its coordinates. If multiple stations exist at the given coordinates, the first station found is returned.

pub fn get_by_index(&self, index: NodeIndex) -> Option<RefStation>

Retrieve a reference to a Station by its index in the graph.

pub fn add_or_update( &mut self, coords: Point, label: &str ) -> (RefStation, NodeIndex)

This helper method is used to add or update a Station to both the stations vector and the graph.

If a Station with the given label already exists, the existing station is updated with the new coordinates. Otherwise, a new Station is created and added to the stations vector and the graph. In either case, a reference to the station is returned in a tuple along with the index of the station in the graph.

Trait Implementations

impl Default for SurveyData

fn default() -> Self

Returns an empty SurveyData instance with no stations.