Bridges-C++  3.2.0
Bridges(C++API)
Public Member Functions | List of all members
bridges::datastructure::BTElement< E > Class Template Reference

#include <BTElement.h>

Inheritance diagram for bridges::datastructure::BTElement< E >:
bridges::datastructure::TreeElement< E > bridges::datastructure::Element< E > bridges::datastructure::DataStructure

Detailed Description

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

This class can be used to create binary tree elements, derived from TreeElement.

This class can be used to create binary tree elements, with left and right subtrees

Parameters
Ethe application data type
Author
Kalpathi Subramanian
Date
6/12/15

Public Member Functions

 BTElement (BTElement *l, BTElement *r, const E &e=E(), const string &lab=string())
 Constructs a BTElement with the provided value, label, left and right BTElements. More...
 
 BTElement (const E &e=E(), const string &lab=string())
 Constructs a BTElement with the provided value and label, setting the left and right BTElement to nullptr. More...
 
virtual const string getDStype () const override
 
virtual BTElementgetLeft ()
 
virtual const BTElementgetLeft () const
 
void setLeft (BTElement *l)
 
virtual BTElementgetRight ()
 
virtual const BTElementgetRight () const
 
void setRight (BTElement *r)
 
- Public Member Functions inherited from bridges::datastructure::TreeElement< E >
 TreeElement (const E &e=E(), const string &lab=string())
 Construct a TreeElement from given values. More...
 
vector< TreeElement * > & getChildren ()
 Get the children of this node. More...
 
const vector< TreeElement * > & getChildren () const
 Get the children of this node. More...
 
TreeElementgetChild (const int &n)
 Gets the nth child of this node. More...
 
const TreeElementgetChild (const int &n) const
 Gets the nth child of this node - constant version. More...
 
void addChild (TreeElement *child)
 Adds a child to children. More...
 
void setChild (const size_t &index, TreeElement *kid)
 Sets child at index to "kid". More...
 
- Public Member Functions inherited from bridges::datastructure::Element< E >
 Element (const E &val=E(), const string &lab=string())
 
 Element (const Element &e)
 
Elementoperator= (const Element &e)
 
E & operator= (E const &e)
 
virtual ~Element ()
 
ElementVisualizergetVisualizer ()
 Get the element visualizer object. More...
 
const ElementVisualizergetVisualizer () const
 Get the element visualizer object - constant version. More...
 
LinkVisualizergetLinkVisualizer (const Element *el)
 Returns the LinkVisualizer of element. More...
 
LinkVisualizergetLinkVisualizer (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
 

Additional Inherited Members

- Protected Member Functions inherited from bridges::datastructure::Element< E >
virtual const string getElementRepresentation () const
 Gets the JSON string of the element representation. More...
 
- Static Protected Member Functions inherited from bridges::datastructure::Element< E >
static const string getLinkRepresentation (const LinkVisualizer &lv, const string &src, const string &dest)
 
- Protected Attributes inherited from bridges::datastructure::Element< E >
unordered_map< Element *, LinkVisualizerlinks
 

Constructor & Destructor Documentation

◆ BTElement() [1/2]

template<typename E >
bridges::datastructure::BTElement< E >::BTElement ( BTElement< E > *  l,
BTElement< E > *  r,
const E &  e = E(),
const string &  lab = string() 
)
inline

Constructs a BTElement with the provided value, label, left and right BTElements.

The defaults will be used if not provided.

Parameters
lThe left TreeElement
rThe right TreeElement
eThe data to hold
labThe label to show

◆ BTElement() [2/2]

template<typename E >
bridges::datastructure::BTElement< E >::BTElement ( const E &  e = E(),
const string &  lab = string() 
)
inline

Constructs a BTElement with the provided value and label, setting the left and right BTElement to nullptr.

The defaults will be used if not provided.

Parameters
eThe data to hold
labThe label to show

Member Function Documentation

◆ getDStype()

template<typename E >
virtual const string bridges::datastructure::BTElement< E >::getDStype ( ) const
inlineoverridevirtual
Returns
the data structure type

Reimplemented from bridges::datastructure::TreeElement< E >.

◆ getLeft() [1/2]

template<typename E >
virtual BTElement* bridges::datastructure::BTElement< E >::getLeft ( )
inlinevirtual
Returns
The left BTElement

◆ getLeft() [2/2]

template<typename E >
virtual const BTElement* bridges::datastructure::BTElement< E >::getLeft ( ) const
inlinevirtual

Constant version

◆ getRight() [1/2]

template<typename E >
virtual BTElement* bridges::datastructure::BTElement< E >::getRight ( )
inlinevirtual
Returns
The right BTElement

◆ getRight() [2/2]

template<typename E >
virtual const BTElement* bridges::datastructure::BTElement< E >::getRight ( ) const
inlinevirtual

Constant version

◆ setLeft()

template<typename E >
void bridges::datastructure::BTElement< E >::setLeft ( BTElement< E > *  l)
inline

Sets left to "l"

Parameters
lThe left BTElement

◆ setRight()

template<typename E >
void bridges::datastructure::BTElement< E >::setRight ( BTElement< E > *  r)
inline

Sets right to "r"

Parameters
rThe right BTElement

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