Bridges-Python-3.0.0  3.0.0b
Bridges(PythonAPI)
Public Member Functions | List of all members
bridges.edge.Edge Class Reference

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

Public Member Functions

def __init__ (self, v1, v2, data=None)
 Constructor for a edge. More...
 
def tov (self)
 Getter for the to vertex. More...
 
def fromv (self)
 Getter for the from vertex. More...
 
def thickness (self)
 Getter for the link thickness. More...
 
def thickness
 Setter for the thickness of edge. More...
 
def edge_data (self)
 Getter for edge data. More...
 
def edge_data (self, data)
 Setter for edge data. More...
 
def color (self)
 Getter for edge color. More...
 
def color (self, color)
 Setter for edge color. More...
 
def get_edge (self)
 

Constructor & Destructor Documentation

◆ __init__()

def bridges.edge.Edge.__init__ (   self,
  v1,
  v2,
  data = None,
  None 
)

Constructor for a edge.

Parameters
v1first vertex of the edge
v2second vertex of the edge
datathe data the edge will hold
Returns
None

Member Function Documentation

◆ color() [1/2]

def bridges.edge.Edge.color (   self)

Getter for edge color.

Returns
color of edge (see link visualizer class for setting options

◆ color() [2/2]

def bridges.edge.Edge.color (   self,
  color 
)

Setter for edge color.

Parameters
colorcolor to be set (see link visualizer class for setting options)
Returns
None

◆ edge_data() [1/2]

def bridges.edge.Edge.edge_data (   self)

Getter for edge data.

Returns
str data associated with this edge (generic object)

◆ edge_data() [2/2]

def bridges.edge.Edge.edge_data (   self,
  data,
  None 
)

Setter for edge data.

Parameters
datadata for the edge to hold (generic object)
Returns
None

◆ fromv()

def bridges.edge.Edge.fromv (   self)

Getter for the from vertex.

Returns
vertex source vertex of edge

◆ get_edge()

def bridges.edge.Edge.get_edge (   self)

◆ thickness() [1/2]

def bridges.edge.Edge.thickness (   self,
  float 
)

Getter for the link thickness.

Returns
float link thickness (1.0-10.0 range)

◆ thickness() [2/2]

def bridges.edge.Edge.thickness (   self,
  th 
)

Setter for the thickness of edge.

Parameters
ththickness to be applied (1.0-10.0 range)
Returns
None

◆ tov()

def bridges.edge.Edge.tov (   self)

Getter for the to vertex.

Returns
vertex terminating vertex of edge

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