bioprocessing  5.1.2
bio::PointVertexRef< P > Class Template Reference

Reference counting pointer to a PointVertex. More...

#include <bioprocessing/graph/pointvertex.h>

Inheritance diagram for bio::PointVertexRef< P >:
Collaboration diagram for bio::PointVertexRef< P >:

Public Types

typedef Pointed::Vertex Vertex
 Useable type (RC) More...
 
typedef Pointed::Point Point
 Point. More...
 
- Public Types inherited from bio::BaseVertexRef
typedef Pointed::Vertex Vertex
 Useable type. More...
 

Public Member Functions

 PointVertexRef ()
 Default constructor (creates an empty pointer) More...
 
 PointVertexRef (const Point &p)
 Constructor from coordinates. More...
 
 PointVertexRef (Pointed *v)
 Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr. More...
 
 PointVertexRef (const Base &other)
 Copy constructor (it copies the reference, it does not duplicate the pointed object) More...
 
virtual ~PointVertexRef ()
 
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
 
const Pointpoint () const
 constant accessor to the coordinates More...
 
Pointpoint ()
 non constant accessor to the coordinates More...
 
- Public Member Functions inherited from bio::BaseVertexRef
 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 ()
 

Static Public Member Functions

static Vertex none ()
 Empty pointer factory. More...
 
- Static Public Member Functions inherited from bio::BaseVertexRef
static Vertex none ()
 Empty pointer factory. More...
 

Protected Types

typedef PointVertexRef< P > This
 Type of *this. More...
 
typedef BaseVertexRef Base
 Base class (rc_ptr) More...
 
typedef PointVertex< P > Pointed
 Pointed object type. More...
 
- Protected Types inherited from bio::BaseVertexRef
typedef BaseVertexRef This
 Type of *this. More...
 
typedef carto::rc_ptr< BaseVertexBase
 Base class type. More...
 
typedef BaseVertex Pointed
 Pointed object type. More...
 

Detailed Description

template<typename P>
class bio::PointVertexRef< P >

Reference counting pointer to a PointVertex.

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

Definition at line 138 of file pointvertex.h.

Member Typedef Documentation

◆ Base

template<typename P >
typedef BaseVertexRef bio::PointVertexRef< P >::Base
protected

Base class (rc_ptr)

Definition at line 143 of file pointvertex.h.

◆ Point

template<typename P >
typedef Pointed::Point bio::PointVertexRef< P >::Point

Point.

Definition at line 147 of file pointvertex.h.

◆ Pointed

template<typename P >
typedef PointVertex<P> bio::PointVertexRef< P >::Pointed
protected

Pointed object type.

Definition at line 144 of file pointvertex.h.

◆ This

template<typename P >
typedef PointVertexRef<P> bio::PointVertexRef< P >::This
protected

Type of *this.

Definition at line 142 of file pointvertex.h.

◆ Vertex

template<typename P >
typedef Pointed::Vertex bio::PointVertexRef< P >::Vertex

Useable type (RC)

Definition at line 146 of file pointvertex.h.

Constructor & Destructor Documentation

◆ PointVertexRef() [1/4]

template<typename P >
bio::PointVertexRef< P >::PointVertexRef ( )
inline

Default constructor (creates an empty pointer)

Definition at line 152 of file pointvertex.h.

◆ PointVertexRef() [2/4]

template<typename P >
bio::PointVertexRef< P >::PointVertexRef ( const Point p)
inline

Constructor from coordinates.

Definition at line 154 of file pointvertex.h.

◆ PointVertexRef() [3/4]

template<typename P >
bio::PointVertexRef< P >::PointVertexRef ( 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 158 of file pointvertex.h.

◆ PointVertexRef() [4/4]

template<typename P >
bio::PointVertexRef< P >::PointVertexRef ( const Base other)
inline

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

Definition at line 161 of file pointvertex.h.

◆ ~PointVertexRef()

template<typename P >
virtual bio::PointVertexRef< P >::~PointVertexRef ( )
inlinevirtual

Definition at line 162 of file pointvertex.h.

Member Function Documentation

◆ none()

template<typename P >
static Vertex bio::PointVertexRef< P >::none ( )
inlinestatic

Empty pointer factory.

The reference is set to 0

Definition at line 168 of file pointvertex.h.

◆ operator!=()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator!= ( const This other) const
inlinevirtual

Reimplemented from bio::BaseVertexRef.

Definition at line 183 of file pointvertex.h.

◆ operator<()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator< ( const This other) const
inlinevirtual

Reimplemented from bio::BaseVertexRef.

Definition at line 196 of file pointvertex.h.

◆ operator<=()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator<= ( const This other) const
inlinevirtual

Reimplemented from bio::BaseVertexRef.

Definition at line 209 of file pointvertex.h.

◆ operator==()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator== ( const This other) const
inlinevirtual

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

Reimplemented from bio::BaseVertexRef.

Definition at line 174 of file pointvertex.h.

◆ operator>()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator> ( const This other) const
inlinevirtual

Reimplemented from bio::BaseVertexRef.

Definition at line 187 of file pointvertex.h.

◆ operator>=()

template<typename P >
virtual bool bio::PointVertexRef< P >::operator>= ( const This other) const
inlinevirtual

Reimplemented from bio::BaseVertexRef.

Definition at line 205 of file pointvertex.h.

◆ point() [1/2]

template<typename P >
Point& bio::PointVertexRef< P >::point ( )
inline

non constant accessor to the coordinates

Definition at line 219 of file pointvertex.h.

◆ point() [2/2]

template<typename P >
const Point& bio::PointVertexRef< P >::point ( ) const
inline

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