Bridges-Python  3.4.3
Bridges(Python API)
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bridges.data_src_dependent.osm.OsmData Class Reference

Detailed Description

Class that hold Open Street Map Data.

Class that holds Open Street Map data, from https://openstreetmap.org

This object is generally not created by the user, to see how its created check out bridges::data_src_dependent::data_source::get_osm_data()

See also
For an example, check out https://bridgesuncc.github.io/tutorials/Data_OSM.html
Author
Jay Strahler, Matthew Mcquaigue, Erik Saule, Kalpathi Subramanian
Date
2/16/19, 12/28/20, 1/6/21

Public Member Functions

List[OsmVertexvertices (self)
 get vertices of the dataset (list) More...
 
def vertices (self, List[OsmVertex] vertices)
 Set vertices of the dataset (VertexList) More...
 
def vertices (self)
 Delete vertices of the dataset. More...
 
List[OsmEdgeedges (self)
 Get edges of the dataset (EdgeList) More...
 
def edges (self, EdgeList edges)
 Set edges of the dataset. More...
 
def edges (self)
 delete the edges in the dataset More...
 
GraphAdjList get_graph (self)
 Construct a graph out of the vertex and edge data of the OSM object. More...
 
def __init__ (self)
 constructor More...
 

Public Attributes

 latitude_range
 
 longitude_range
 
 cartesian_range_x
 
 cartesian_range_y
 
 name
 

Static Public Attributes

 VertexList = List[OsmVertex]
 
 EdgeList = List[OsmEdge]
 

Constructor & Destructor Documentation

◆ __init__()

def bridges.data_src_dependent.osm.OsmData.__init__ (   self)

constructor

Member Function Documentation

◆ edges() [1/3]

List[OsmEdge] bridges.data_src_dependent.osm.OsmData.edges (   self)

Get edges of the dataset (EdgeList)

Returns
edges of the OSM data

◆ edges() [2/3]

def bridges.data_src_dependent.osm.OsmData.edges (   self)

delete the edges in the dataset

◆ edges() [3/3]

def bridges.data_src_dependent.osm.OsmData.edges (   self,
EdgeList  edges 
)

Set edges of the dataset.

Returns
edges (EdgeList)

Set edges of the dataset

Parameters
edgesedges to set

◆ get_graph()

GraphAdjList bridges.data_src_dependent.osm.OsmData.get_graph (   self)

Construct a graph out of the vertex and edge data of the OSM object.

   The graph will associate the length
   of the edge to the graph edge. No data is bound to the vertices

   The vertices of the graph will be located at
   the location where given in the data set
   converted to cartesian coordinates
Returns
adjacency list based graph

◆ vertices() [1/3]

List[OsmVertex] bridges.data_src_dependent.osm.OsmData.vertices (   self)

get vertices of the dataset (list)

Returns
list of vertices

◆ vertices() [2/3]

def bridges.data_src_dependent.osm.OsmData.vertices (   self)

Delete vertices of the dataset.

◆ vertices() [3/3]

def bridges.data_src_dependent.osm.OsmData.vertices (   self,
List[OsmVertex vertices 
)

Set vertices of the dataset (VertexList)

Parameters
verticesVertexList to set

Member Data Documentation

◆ cartesian_range_x

bridges.data_src_dependent.osm.OsmData.cartesian_range_x

◆ cartesian_range_y

bridges.data_src_dependent.osm.OsmData.cartesian_range_y

◆ EdgeList

bridges.data_src_dependent.osm.OsmData.EdgeList = List[OsmEdge]
static

◆ latitude_range

bridges.data_src_dependent.osm.OsmData.latitude_range

◆ longitude_range

bridges.data_src_dependent.osm.OsmData.longitude_range

◆ name

bridges.data_src_dependent.osm.OsmData.name

◆ VertexList

bridges.data_src_dependent.osm.OsmData.VertexList = List[OsmVertex]
static

The documentation for this class was generated from the following file: