#include <SLelement.h>

Inheritance diagram for bridges::datastructure::SLelement< E >:

Detailed Description

template<typename E>
class bridges::datastructure::SLelement< E >

The singly linked list element, derived from Element.

This class can be used to create singly linked elements, with a next SLelement pointer

See also: There is a tutorial about Singly Linked Lists : http://bridgesuncc.github.io/tutorials/SinglyLinkedList.html

Parameters

E	the application data type

Author: Kalpathi Subramanian

Date: 6/11/15, 7/12/19

Classes
class	SLelement_constlisthelper
	These are helper classes for SLelement for easy iteration. More...

class	SLelement_listhelper
	These are helper classes for SLelement for easy iteration. More...

Public Member Functions
	SLelement (SLelement *next, const E &val=E(), const string &lab=string())
	Constructs an slelement with the provided value. More...

	SLelement (const E &val=E(), const string &lab=string())
	Constructs an slelement with the provided value. More...

virtual const string	getDStype () const override
	Returns the data structure name. More...

virtual SLelement *	getNext ()
	Returns the next element in the list. More...

virtual const SLelement *	getNext () const
	Returns the next element in the list - Constant version. More...

void	setNext (SLelement *n)

Public Member Functions inherited from bridges::datastructure::Element< E >
	Element (const E &val=E(), const string &lab=string())

	Element (const Element &e)

Element &	operator= (const Element &e)

E &	operator= (E const &e)

virtual	~Element ()

ElementVisualizer *	getVisualizer ()
	Get the element visualizer object. More...

const ElementVisualizer *	getVisualizer () const
	Get the element visualizer object - constant version. More...

LinkVisualizer *	getLinkVisualizer (const Element *el)
	Returns the LinkVisualizer of element. More...

LinkVisualizer *	getLinkVisualizer (const Element *el) const
	Returns the LinkVisualizer of element. More...

string const &	getLabel () const
	Gets the label of this element. More...

void	setLabel (const string &lab)
	Sets label of this element. More...

E const &	getValue () const
	Gets the object held in the generic object E. More...

E &	getValue ()
	Gets the object held in the generic object E. More...

void	setValue (const E &val)
	Sets generic object to "val". More...

void	setSize (const double &sz)
	Sets size of the element. More...

double	getSize () const
	Get element size. More...

void	setColor (const Color &col)
	Set the color of the Element. More...

void	setColor (const string col)
	Set the color by name. More...

Color	getColor () const
	Get the current color of the element. More...

void	setOpacity (double opacity)
	Set opacity of element - use the 4th color component. More...

double	getOpacity ()

void	setShape (const Shape &shp)
	Set the shape of the element. More...

Shape	getShape () const
	Returns the shape of the element. More...

void	setLocation (const double &locX, const double &locY)
	Sets the location attributes of an element. More...

double	getLocationX () const
	Gets the X coordinate of the location. More...

double	getLocationY () const
	Gets the Y coordinate of the location. More...

Public Member Functions inherited from bridges::datastructure::DataStructure
virtual	~DataStructure ()=default

Protected Member Functions
virtual const pair< string, string >	generateJSON (vector< const SLelement< E > *> nodes) const
	Generates the JSON representation of the element. More...

virtual void	getListElements (vector< const SLelement< E > *> &nodes) const
	Get the list of nodes. More...

Protected Member Functions inherited from bridges::datastructure::Element< E >
virtual const string	getElementRepresentation () const
	Gets the JSON string of the element representation. More...

Protected Attributes
SLelement *	next = nullptr

Protected Attributes inherited from bridges::datastructure::Element< E >
unordered_map< Element *, LinkVisualizer >	links

Additional Inherited Members
Static Protected Member Functions inherited from bridges::datastructure::Element< E >
static const string	getLinkRepresentation (const LinkVisualizer &lv, const string &src, const string &dest)

Constructor & Destructor Documentation

◆ SLelement() [1/2]

template<typename E>

bridges::datastructure::SLelement< E >::SLelement	(	SLelement< E > *	next,
		const E &	val = `E()`,
		const string &	lab = `string()`
	)

inline

Constructs an slelement with the provided value.

Constructs an SLelement with the provided value, label, and next SLelement. The defaults will be used if not provided.

Parameters

val	The data to hold
lab	The label to show
next	The next SLelement

◆ SLelement() [2/2]

template<typename E>

bridges::datastructure::SLelement< E >::SLelement	(	const E &	val = `E()`,
		const string &	lab = `string()`
	)

inline

Constructs an slelement with the provided value.

Constructs an slelement with the provided value and label, setting the next slelement to NULL. The defaults will be used if not provided.

Parameters

val	The data to hold
lab	The label to show

Member Function Documentation

◆ generateJSON()

template<typename E>

virtual const pair<string, string> bridges::datastructure::SLelement< E >::generateJSON ( vector< const SLelement< E > *> nodes ) const

inlineprotectedvirtual

Generates the JSON representation of the element.

Generates the JSON representation of the nodes and links

Returns: JSON string pair containing the nodes and links

◆ getDStype()

template<typename E>

virtual const string bridges::datastructure::SLelement< E >::getDStype ( ) const

inlineoverridevirtual

Returns the data structure name.

Returns: The string representation of this data structure type

Implements bridges::datastructure::DataStructure.

Reimplemented in bridges::datastructure::MLelement< E >, bridges::datastructure::CircDLelement< E >, bridges::datastructure::CircSLelement< E >, and bridges::datastructure::DLelement< E >.

◆ getListElements()

template<typename E>

virtual void bridges::datastructure::SLelement< E >::getListElements ( vector< const SLelement< E > *> & nodes ) const

inlineprotectedvirtual

Get the list of nodes.

Parameters

nodes The list of nodes

◆ getNext() [1/2]

template<typename E>

virtual SLelement* bridges::datastructure::SLelement< E >::getNext ( )

inlinevirtual

Returns the next element in the list.

Returns: The next SLelement

Reimplemented in bridges::datastructure::MLelement< E >, bridges::datastructure::CircDLelement< E >, bridges::datastructure::CircSLelement< E >, and bridges::datastructure::DLelement< E >.

◆ getNext() [2/2]

template<typename E>

virtual const SLelement* bridges::datastructure::SLelement< E >::getNext ( ) const

inlinevirtual

Returns the next element in the list - Constant version.

Returns: The next SLelement

Reimplemented in bridges::datastructure::MLelement< E >, bridges::datastructure::CircDLelement< E >, and bridges::datastructure::DLelement< E >.

◆ setNext()

template<typename E>

void bridges::datastructure::SLelement< E >::setNext ( SLelement< E > * n )

inline

Sets next link to "n"

Parameters

n	The next SLelement

Member Data Documentation

◆ next

template<typename E>

SLelement* bridges::datastructure::SLelement< E >::next = nullptr

protected

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

/home/erik/work/bridges/bridges-cxx/src/SLelement.h

Detailed Description

template<typename E> class bridges::datastructure::SLelement< E >

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SLelement() [1/2]

◆ SLelement() [2/2]

Member Function Documentation

◆ generateJSON()

◆ getDStype()

◆ getListElements()

◆ getNext() [1/2]

◆ getNext() [2/2]

◆ setNext()

Member Data Documentation

◆ next

template<typename E>
class bridges::datastructure::SLelement< E >