bioprocessing  5.1.2
bio::ValueVertexRef< T > Class Template Reference

Reference counting pointer to a ValueVertex. More...

#include <bioprocessing/graph/valuevertex.h>

Inheritance diagram for bio::ValueVertexRef< T >:
Collaboration diagram for bio::ValueVertexRef< T >:

Public Types

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

Public Member Functions

 ValueVertexRef (const Type &val)
 Constructor from a value (creates a new instance) More...
 
 ValueVertexRef (Pointed *v)
 Constructor from a pointer (the pointer should either be created by new, or be already referenced by a rc_ptr. More...
 
 ValueVertexRef (const Base &other)
 Copy constructor (it copies the reference, it does not duplicate the pointed object) More...
 
virtual ~ValueVertexRef ()
 
const Typevalue () const
 Const accessor to th value. More...
 
Type value ()
 Non const accessor to th value. 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 ()
 
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...
 
- Static Public Member Functions inherited from bio::BaseVertexRef
static Vertex none ()
 Empty pointer factory. More...
 

Protected Types

typedef ValueVertexRef< T > This
 Type of *this. More...
 
typedef BaseVertexRef Base
 Base class (rc_ptr) More...
 
typedef ValueVertex< T > 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...
 

Protected Member Functions

 ValueVertexRef ()
 Default constructor (builds a non pointer) More...
 

Detailed Description

template<typename T>
class bio::ValueVertexRef< T >

Reference counting pointer to a ValueVertex.

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

Definition at line 75 of file valuevertex.h.

Member Typedef Documentation

◆ Base

template<typename T >
typedef BaseVertexRef bio::ValueVertexRef< T >::Base
protected

Base class (rc_ptr)

Definition at line 80 of file valuevertex.h.

◆ Pointed

template<typename T >
typedef ValueVertex<T> bio::ValueVertexRef< T >::Pointed
protected

Pointed object type.

Definition at line 81 of file valuevertex.h.

◆ This

template<typename T >
typedef ValueVertexRef<T> bio::ValueVertexRef< T >::This
protected

Type of *this.

Definition at line 79 of file valuevertex.h.

◆ Type

template<typename T >
typedef Pointed::Type bio::ValueVertexRef< T >::Type

Value type.

Definition at line 84 of file valuevertex.h.

◆ Vertex

template<typename T >
typedef Pointed::Vertex bio::ValueVertexRef< T >::Vertex

Useable type (RC)

Definition at line 83 of file valuevertex.h.

Constructor & Destructor Documentation

◆ ValueVertexRef() [1/4]

template<typename T >
bio::ValueVertexRef< T >::ValueVertexRef ( )
inlineprotected

Default constructor (builds a non pointer)

Definition at line 89 of file valuevertex.h.

◆ ValueVertexRef() [2/4]

template<typename T >
bio::ValueVertexRef< T >::ValueVertexRef ( const Type val)
inline

Constructor from a value (creates a new instance)

Definition at line 92 of file valuevertex.h.

◆ ValueVertexRef() [3/4]

template<typename T >
bio::ValueVertexRef< T >::ValueVertexRef ( 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 96 of file valuevertex.h.

◆ ValueVertexRef() [4/4]

template<typename T >
bio::ValueVertexRef< T >::ValueVertexRef ( const Base other)
inline

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

Definition at line 99 of file valuevertex.h.

◆ ~ValueVertexRef()

template<typename T >
virtual bio::ValueVertexRef< T >::~ValueVertexRef ( )
inlinevirtual

Definition at line 100 of file valuevertex.h.

Member Function Documentation

◆ none()

template<typename T >
static Vertex bio::ValueVertexRef< T >::none ( )
inlinestatic

Empty pointer factory.

The reference is set to 0

Definition at line 106 of file valuevertex.h.

◆ value() [1/2]

template<typename T >
Type bio::ValueVertexRef< T >::value ( )
inline

Non const accessor to th value.

Definition at line 113 of file valuevertex.h.

◆ value() [2/2]

template<typename T >
const Type& bio::ValueVertexRef< T >::value ( ) const
inline

Const accessor to th value.

Definition at line 111 of file valuevertex.h.


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