bridges.edge.Edge Class Reference

This class is used to represent the edges in a graph and will appear as links in the BRIDGES graph visualization. More...

Public Member Functions
None	__init__ (self, v1, v2, data=None, str label=None, Color color=None, float thickness=None)
	Constructor for a edge.
	get_edge (self)
	Get this edge object.

Protected Attributes
	_from_vertex
	_to_vertex
	_edge_data
	_lvis

Properties
	tov = property
	Getter for the to vertex.
	fromv = property
	Getter for the from vertex.
	destination = property
	Getter for the to vertex.
	source = property
	Getter for the from vertex.
	thickness = property
	Getter for the link thickness.
	edge_data = property
	Getter for edge data.
	color = property
	Getter for edge color.
	opacity = property
	Getter for the edge opacity.
	label = property
	Getter for the edge label.

Detailed Description

This class is used to represent the edges in a graph and will appear as links in the BRIDGES graph visualization.

This object is used in graphs and graph algorithms such as DFS, BFS and shortest path algorithms that need to visit graph edges. The adjacency list representation uses them as the generic paramter, as SLelement<Edge> bridges represents Edges as links between pairs of elements

Author

Matthew McQuaigue, Kalpathi Subramanian

Date

2019, 2020, 2021

Constructor & Destructor Documentation

__init__()

None bridges.edge.Edge.__init__	(		self,
			v1,
			v2,
			data = None,
		str	label = None,
		Color	color = None,
		float	thickness = None
	)

Constructor for a edge.

Parameters

v1	first vertex of the edge
v2	second vertex of the edge
data	the data the edge will hold
label	edge label
color	edge color
thickness	edge thickness

Member Function Documentation

get_edge()

bridges.edge.Edge.get_edge

(

self

)

Get this edge object.

Returns

self this edge object

Member Data Documentation

_edge_data

bridges.edge.Edge._edge_data

protected

_from_vertex

bridges.edge.Edge._from_vertex

protected

_lvis

bridges.edge.Edge._lvis

protected

_to_vertex

bridges.edge.Edge._to_vertex

protected

Property Documentation

color

bridges.edge.Edge.color = property

static

Getter for edge color.

Returns

color of edge (see link visualizer class for setting options

destination

bridges.edge.Edge.destination = property

static

Getter for the to vertex.

Returns

vertex terminating vertex of edge

edge_data

bridges.edge.Edge.edge_data = property

static

Getter for edge data.

Returns

str data associated with this edge (generic object)

fromv

bridges.edge.Edge.fromv = property

static

Getter for the from vertex.

Returns

vertex source vertex of edge

label

bridges.edge.Edge.label = property

static

Getter for the edge label.

Returns

(string) : edge label

opacity

bridges.edge.Edge.opacity = property

static

Getter for the edge opacity.

Returns

opacity edge opacity

source

bridges.edge.Edge.source = property

static

Getter for the from vertex.

Returns

vertex source vertex of edge

thickness

bridges.edge.Edge.thickness = property

static

Getter for the link thickness.

Returns

float link thickness (1.0-10.0 range)

tov

bridges.edge.Edge.tov = property

static

Getter for the to vertex.

Returns

vertex terminating vertex of edge

---

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

• /home/erik/work/bridges/bridges-python/bridges/edge.py