bioprocessing 6.0.4
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | List of all members
bio::PointVertexRef< P > Class Template Reference

Reference counting pointer to a PointVertex. More...

#include <bioprocessing/graph/pointvertex.h>

Inheritance diagram for bio::PointVertexRef< P >:
Inheritance graph
[legend]
Collaboration diagram for bio::PointVertexRef< P >:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 PointVertexRef ()
 Default constructor (creates an empty pointer)
 
 PointVertexRef (const Point &p)
 Constructor from coordinates.
 
 PointVertexRef (Pointed *v)
 Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr.
 
 PointVertexRef (const Base &other)
 Copy constructor (it copies the reference, it does not duplicate the pointed object)
 
virtual ~PointVertexRef ()
 
virtual bool operator== (const This &other) const
 There is equality if both pointers are none, or if both pointed objects are equal.
 
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 Point & point () const
 constant accessor to the coordinates
 
Point & point ()
 non constant accessor to the coordinates
 
- Public Member Functions inherited from bio::BaseVertexRef
 BaseVertexRef ()
 Default constructor.
 
 BaseVertexRef (Pointed *v)
 Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr.
 
 BaseVertexRef (const Base &other)
 Copy constructor (copies the reference, it does not duplicate the pointed object)
 
virtual ~BaseVertexRef ()
 
virtual bool operator== (const This &other) const
 There is equality if both pointers are none, or if both pointed objects are equal.
 
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.
 
- Static Public Member Functions inherited from bio::BaseVertexRef
static Vertex none ()
 Empty pointer factory.
 

Protected Types

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

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

Definition at line 183 of file pointvertex.h.

◆ operator<()

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

Definition at line 196 of file pointvertex.h.

◆ operator<=()

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

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.

Definition at line 174 of file pointvertex.h.

◆ operator>()

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

Definition at line 187 of file pointvertex.h.

◆ operator>=()

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

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

constant accessor to the coordinates

Definition at line 217 of file pointvertex.h.

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