Bridges-Python  3.4.4
Bridges(Python API)
Public Member Functions | Public Attributes | List of all members
bridges.circ_sl_element.CircSLelement Class Reference
Inheritance diagram for bridges.circ_sl_element.CircSLelement:
bridges.sl_element.SLelement bridges.element.Element

Detailed Description

This class can be used to instantiate Singly Linked Circular List Elements.

Structurally they are the same as singly linked elements except that each node constructed with the next point pointing to itself; User's implementation of the circularly linked list needs to ensure that the last node points to first node of the list, as the visualization generation is dependent on this.

Elements have labels (string) that are displayed on the visualization. Elements take an generic object as a user defined parameter, E, which can be any native type or object.

Elements contains a visualizer (ElementVisualizer) object for setting visual attributes (color, shape, opacity, size), necessary for displaying them in a web browser.

Elements also have a LinkVisualizer object that is used when they are linked to another element, appropriate for setting link attributes, between an element and its next element.

Author
Kalpathi Subramanian, Matthew McQuaigue
Date
6/22/16, 1/7/17, 5/17/17, 7/23/19, 12/29/20

Circular singly linked list tutorial: https://bridgesuncc.github.io/tutorials/CircularSinglyLinkedList.html

Public Member Functions

None __init__ (self, **kwargs)
 The constructor for a Circular Singly Linked Element. More...
 
str get_data_structure_type (self)
 Gets the data structure type. More...
 
def next (self)
 Getter for the next element of this CircSLelement. More...
 
None next (self, n)
 Setter for the next element in Circular list. More...
 
def iterator (self)
 list iterator for use in range loops More...
 
- Public Member Functions inherited from bridges.sl_element.SLelement
def value (self)
 Getter for the SLelement value to hold. More...
 
def value (self, val)
 Setter for the value that this SLelement will hold. More...
 
def list_helper (start)
 helper method for graph adjacency list More...
 
dict get_data_structure_representation (self)
 Getter for this data structure representation. More...
 
def get_list_elements (self, nodes)
 Get the elements of the list (for internal use only) More...
 
- Public Member Functions inherited from bridges.element.Element
str identifier (self)
 Getter for the element identifier. More...
 
None identifier (self, int id)
 Setter for the element identifier. More...
 
ElementVisualizer visualizer (self)
 Getter for the element visualizer. More...
 
None visualizer (self, ElementVisualizer vis)
 Setter function for this element visualizer. More...
 
LinkVisualizer get_link_visualizer (self, el)
 
None set_link_visualizer (self, el)
 Setter for the link visualizer of this element. More...
 
None remove_link_visualizer (self, el)
 Deleter function for the lik visualizer of this element. More...
 
def label (self)
 Getter for the element's label. More...
 
def label (self, label)
 Setter for the element's label. More...
 
def size (self)
 Getter for the element's size. More...
 
def size (self, sz)
 Setter for the element's size. More...
 
def color (self)
 Getter for the element's color. More...
 
def color (self, col)
 Setter for the element's size. More...
 
def opacity (self)
 Getter for the element's opacity. More...
 
def opacity (self, op)
 Setter for the element's opacity. More...
 
def shape (self)
 Getter for the element's shape type. More...
 
def shape (self, shp)
 Setter for the element's shape. More...
 
int id (self)
 Get numer of ids of element object. More...
 
def set_location (self, locX, locY)
 Setter for the element's location. More...
 
def get_locationX (self)
 Getter for the element's location in X. More...
 
def get_locationY (self)
 Getter for the element's location in Y. More...
 
def get_element_representation (self)
 Getter for the element's JSON representation (for internal use) More...
 
def get_link_representation (self, lv, src, dest)
 Getter for the JSON representation of the element's link (for internal use) More...
 

Public Attributes

 next
 
- Public Attributes inherited from bridges.element.Element
 color
 
 opacity
 

Additional Inherited Members

- Static Public Attributes inherited from bridges.element.Element
int ids = 0
 

Constructor & Destructor Documentation

◆ __init__()

None bridges.circ_sl_element.CircSLelement.__init__ (   self,
**  kwargs 
)

The constructor for a Circular Singly Linked Element.

Parameters
ethe generic object that this CircSLelement will hold
labelThe label of this CircSLelement
nextThe CircSLelement that should be assigned to the next pointer
Returns
None

Reimplemented from bridges.sl_element.SLelement.

Member Function Documentation

◆ get_data_structure_type()

str bridges.circ_sl_element.CircSLelement.get_data_structure_type (   self)

Gets the data structure type.

Returns
str representing the data structure type

Reimplemented from bridges.sl_element.SLelement.

◆ iterator()

def bridges.circ_sl_element.CircSLelement.iterator (   self)

list iterator for use in range loops

Reimplemented from bridges.sl_element.SLelement.

◆ next() [1/2]

def bridges.circ_sl_element.CircSLelement.next (   self)

Getter for the next element of this CircSLelement.

Returns
CircSLelement the element that follows this element

Reimplemented from bridges.sl_element.SLelement.

◆ next() [2/2]

None bridges.circ_sl_element.CircSLelement.next (   self,
  n 
)

Setter for the next element in Circular list.

Parameters
nthe next element to be set
Returns
None

Reimplemented from bridges.sl_element.SLelement.

Member Data Documentation

◆ next

bridges.circ_sl_element.CircSLelement.next

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