bioprocessing  5.1.2
Public Types | Public Member Functions | Protected Types | Friends | List of all members
bio::BaseVertex Class Reference

Base class for vertices. More...

#include <bioprocessing/graph/basevertex.h>

Inheritance diagram for bio::BaseVertex:
Inheritance graph
[legend]
Collaboration diagram for bio::BaseVertex:
Collaboration graph
[legend]

Public Types

typedef BaseVertexRef Vertex
 Useable type (its RC pointer) More...
 
typedef BaseVertexRef Ref
 RC pointer to the type. More...
 

Public Member Functions

 BaseVertex ()
 Default constructor. More...
 
virtual ~BaseVertex ()
 
virtual bool operator> (const This &other) const
 
virtual bool operator< (const This &other) const
 
virtual bool operator== (const This &other) const
 
virtual bool operator!= (const This &other) const
 
virtual bool operator<= (const This &other) const
 
virtual bool operator>= (const This &other) const
 

Protected Types

typedef BaseVertex This
 Type of *this. More...
 

Friends

class BaseVertexRef
 

Detailed Description

Base class for vertices.

In this basic construction, a vertex is an object. Consequentely, each instance of a BaseVertex is a different vertex.
You shouldn't directly manipulate a BaseVertex object, and instead use BaseVertexRef which is its entry point (A reference counting pointer that dereference its methods)

Definition at line 33 of file basevertex.h.

Member Typedef Documentation

◆ Ref

typedef BaseVertexRef bio::BaseVertex::Ref

RC pointer to the type.

Definition at line 40 of file basevertex.h.

◆ This

typedef BaseVertex bio::BaseVertex::This
protected

Type of *this.

Definition at line 37 of file basevertex.h.

◆ Vertex

typedef BaseVertexRef bio::BaseVertex::Vertex

Useable type (its RC pointer)

Definition at line 39 of file basevertex.h.

Constructor & Destructor Documentation

◆ BaseVertex()

bio::BaseVertex::BaseVertex ( )
inline

Default constructor.

Definition at line 45 of file basevertex.h.

◆ ~BaseVertex()

virtual bio::BaseVertex::~BaseVertex ( )
inlinevirtual

Definition at line 46 of file basevertex.h.

Member Function Documentation

◆ operator!=()

virtual bool bio::BaseVertex::operator!= ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 62 of file basevertex.h.

◆ operator<()

virtual bool bio::BaseVertex::operator< ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 54 of file basevertex.h.

◆ operator<=()

virtual bool bio::BaseVertex::operator<= ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 66 of file basevertex.h.

◆ operator==()

virtual bool bio::BaseVertex::operator== ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 58 of file basevertex.h.

◆ operator>()

virtual bool bio::BaseVertex::operator> ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 50 of file basevertex.h.

◆ operator>=()

virtual bool bio::BaseVertex::operator>= ( const This &  other) const
inlinevirtual

Reimplemented in bio::PointVertex< P >.

Definition at line 70 of file basevertex.h.

Friends And Related Function Documentation

◆ BaseVertexRef

friend class BaseVertexRef
friend

Definition at line 75 of file basevertex.h.

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