bioprocessing  5.0.5
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Friends | List of all members
bio::BaseVertexRef Class Reference

Reference counting pointer to a BaseVertex. More...

#include <bioprocessing/graph/basevertex.h>

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

Public Types

typedef Pointed::Vertex Vertex
 Useable type. More...
 

Public Member Functions

 BaseVertexRef ()
 Default constructor. More...
 
 BaseVertexRef (Pointed *v)
 Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr. More...
 
 BaseVertexRef (const Base &other)
 Copy constructor (copies the reference, it does not duplicate the pointed object) More...
 
virtual ~BaseVertexRef ()
 
virtual bool operator== (const This &other) const
 There is equality if both pointers are none, or if both pointed objects are equal. More...
 
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
 

Static Public Member Functions

static Vertex none ()
 Empty pointer factory. More...
 

Protected Types

typedef BaseVertexRef This
 Type of *this. More...
 
typedef carto::rc_ptr< BaseVertex > Base
 Base class type. More...
 
typedef BaseVertex Pointed
 Pointed object type. More...
 

Friends

class BaseVertex
 

Detailed Description

Reference counting pointer to a BaseVertex.

These objects also have full access to BaseVertex methods (without having to dereference the pointer)

Definition at line 104 of file basevertex.h.

Member Typedef Documentation

◆ Base

typedef carto::rc_ptr<BaseVertex> bio::BaseVertexRef::Base
protected

Base class type.

Definition at line 109 of file basevertex.h.

◆ Pointed

typedef BaseVertex bio::BaseVertexRef::Pointed
protected

Pointed object type.

Definition at line 110 of file basevertex.h.

◆ This

typedef BaseVertexRef bio::BaseVertexRef::This
protected

Type of *this.

Definition at line 108 of file basevertex.h.

◆ Vertex

typedef Pointed::Vertex bio::BaseVertexRef::Vertex

Useable type.

Definition at line 112 of file basevertex.h.

Constructor & Destructor Documentation

◆ BaseVertexRef() [1/3]

bio::BaseVertexRef::BaseVertexRef ( )
inline

Default constructor.

This creates an actual Vertex instance. "Empty" verteices should be created using the none() static method.

Definition at line 119 of file basevertex.h.

◆ BaseVertexRef() [2/3]

bio::BaseVertexRef::BaseVertexRef ( Pointed *  v)
inline

Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr.

See rc_ptr for more details on reference counting pointers)

Definition at line 123 of file basevertex.h.

◆ BaseVertexRef() [3/3]

bio::BaseVertexRef::BaseVertexRef ( const Base &  other)
inline

Copy constructor (copies the reference, it does not duplicate the pointed object)

Definition at line 126 of file basevertex.h.

◆ ~BaseVertexRef()

virtual bio::BaseVertexRef::~BaseVertexRef ( )
inlinevirtual

Definition at line 127 of file basevertex.h.

Member Function Documentation

◆ none()

static Vertex bio::BaseVertexRef::none ( )
inlinestatic

Empty pointer factory.

The reference is set to 0

Definition at line 133 of file basevertex.h.

◆ operator!=()

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

Reimplemented in bio::PointVertexRef< P >.

Definition at line 148 of file basevertex.h.

◆ operator<()

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

Reimplemented in bio::PointVertexRef< P >.

Definition at line 159 of file basevertex.h.

◆ operator<=()

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

Reimplemented in bio::PointVertexRef< P >.

Definition at line 170 of file basevertex.h.

◆ operator==()

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

There is equality if both pointers are none, or if both pointed objects are equal.

Reimplemented in bio::PointVertexRef< P >.

Definition at line 139 of file basevertex.h.

◆ operator>()

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

Reimplemented in bio::PointVertexRef< P >.

Definition at line 152 of file basevertex.h.

◆ operator>=()

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

Reimplemented in bio::PointVertexRef< P >.

Definition at line 166 of file basevertex.h.

Friends And Related Function Documentation

◆ BaseVertex

friend class BaseVertex
friend

Definition at line 176 of file basevertex.h.

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