bridges.sl_element.SLelement Class Reference

Inheritance diagram for bridges.sl_element.SLelement:

Detailed Description

This class can be used to instantiate Singly Linked Elements.

This class extends Element and takes a generic parameter <E> representing application specific data. This element forms the basic building block for singly linked lists. Singly linked elements have a field pointing to the next element along the list.

Elements contain 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, for instance, between the current element and its next element.

Author

Matthew Mcquaigue

Date

2018, 6/24/19

See also

Singly Linked List tutorial : http://bridgesuncc.github.io/tutorials/SinglyLinkedList.html

Public Member Functions
def	__init__ (self, kwargs)
	Conctructor for SLelement object. More...
def	get_data_structure_type (self)
	Getter for the data structure type. More...
def	next (self)
	Getter for element following this element. More...
def	next (self, n)
	Setter for the element following this element. More...
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)
def	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
def	get_data_structure_type (self)
	Get the data structure representation. More...
def	__init__ (self, kwargs)
def	value (self)
	Getter for the value this element is holding. More...
def	value (self, val)
	Setter for the value of an element. More...
def	identifier (self)
	Getter for the element identifier. More...
def	identifier
	Setter for the element identifier. More...
def	visualizer (self)
	Getter for the element visualizer. More...
def	visualizer
	Setter function for this element visualizer. More...
def	get_link_visualizer (self, el)
def	set_link_visualizer (self, el)
	Setter for the link visualizer of this element. More...
def	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...
def	id (self)
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...

Additional Inherited Members
Public Attributes inherited from bridges.element.Element
	color
	opacity
Static Public Attributes inherited from bridges.element.Element
int	ids = 0

Constructor & Destructor Documentation

__init__()

def bridges.sl_element.SLelement.__init__	(		self,
			kwargs,
			None
	)

Conctructor for SLelement object.

(Generic) e: the generic object that this SLelement will hold (str) label: the label of the SLelement that shows up on the bridges visualization (Element) next: the element that should be assigned to the next pointer

Returns

None

Member Function Documentation

get_data_structure_representation()

def bridges.sl_element.SLelement.get_data_structure_representation	(		self,
			dict
	)

Getter for this data structure representation.

Returns

dict representing the JSON before dumping

get_data_structure_type()

def bridges.sl_element.SLelement.get_data_structure_type	(		self,
			str
	)

Getter for the data structure type.

Returns

str representing the data structure type

get_list_elements()

def bridges.sl_element.SLelement.get_list_elements	(		self,
			nodes
	)

Get the elements of the list (for internal use only)

Parameters

nodes

a vector of the nodes in the list

Returns

elements of list

list_helper()

def bridges.sl_element.SLelement.list_helper

(

start

)

next() [1/2]

def bridges.sl_element.SLelement.next

(

self

)

Getter for element following this element.

Returns

SLelement

next() [2/2]

def bridges.sl_element.SLelement.next	(		self,
			n,
			None
	)

Setter for the element following this element.

Parameters

n	the element to be assigned to next

Returns

None

value() [1/2]

def bridges.sl_element.SLelement.value

(

self

)

Getter for the SLelement value to hold.

Returns

Element

value() [2/2]

def bridges.sl_element.SLelement.value	(		self,
			val
	)

Setter for the value that this SLelement will hold.

Parameters

val	the value that this SLelment will hold

Returns

None

---

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

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