Reference counting pointer to a SetEdge. More...

#include <bioprocessing/graph/setedge.h>

Inheritance diagram for bio::SetEdgeRef< V >:

Collaboration diagram for bio::SetEdgeRef< V >:

Public Types
typedef Pointed::Vertex	Vertex
	Usable Vertex type. More...

typedef Pointed::Edge	Edge
	USable Edge type. More...

typedef Pointed::iterator	iterator

typedef Pointed::const_iterator	const_iterator

Public Types inherited from bio::BaseEdgeRef< V >
typedef Pointed::Vertex	Vertex
	Usable vertex type. More...

typedef Pointed::Edge	Edge
	Usable edge type. More...

typedef Pointed::Edge	Ref
	Reference type. More...

Public Member Functions
	SetEdgeRef (const Vertex &x, const Vertex &y)
	Constructor from a pair of vertices. More...

	SetEdgeRef (Pointed *e)
	Constructor from a pointer (the pointer should either be created by `new`, or be already referenced by a rc_ptr. More...

	SetEdgeRef (const Base &other)
	Copy constructor (it copies the reference, it does not duplicate the pointed object) More...

virtual	~SetEdgeRef ()

virtual const_iterator	begin () const

virtual const_iterator	end () const

virtual iterator	begin ()

virtual iterator	end ()

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

Public Member Functions inherited from bio::BaseEdgeRef< V >
	BaseEdgeRef (Pointed *e)
	Constructor from a pointer (the pointer should either be created by `new`, or be already referenced by a rc_ptr. More...

	BaseEdgeRef (const Base &other)
	Copy constructor (it copies the reference, it does not duplicate the pointed object) More...

virtual	~BaseEdgeRef ()

virtual Vertex	x ()
	access the first vertex (arbitrary choice for non oriented edges) More...

virtual const Vertex	x () const
	access the first vertex (arbitrary choice for non oriented edges) More...

virtual Vertex	y ()
	access the second vertex (arbitrary choice for non oriented edges) More...

virtual const Vertex	y () const
	access the second vertex (arbitrary choice for non oriented edges) More...

virtual Vertex	other (const Vertex &v)
	access the vertex that is not v More...

virtual const Vertex	other (const Vertex &v) const
	access the vertex that is not v More...

Static Public Member Functions
static Edge	none ()
	Empty pointer factory. More...

Static Public Member Functions inherited from bio::BaseEdgeRef< V >
static Edge	none ()
	Empty pointer factory. More...

Protected Types
typedef SetEdgeRef< V >	This
	Type of *this. More...

typedef BaseEdgeRef< V >	Base
	Base class type. More...

typedef SetEdge< V >	Pointed
	Pointed object type. More...

Protected Types inherited from bio::BaseEdgeRef< V >
typedef BaseEdgeRef< V >	This
	Type of *this. More...

typedef carto::rc_ptr< BaseEdge< V > >	Base
	Base class. More...

typedef BaseEdge< V >	Pointed
	Pointed object type. More...

Protected Member Functions
	SetEdgeRef ()
	Default constructor (builds a none pointer) More...

Protected Member Functions inherited from bio::BaseEdgeRef< V >
	BaseEdgeRef ()
	Default constructor (creates an empty pointer) More...

Friends
class	SetEdge< V >

Detailed Description

template<typename V>
class bio::SetEdgeRef< V >

Reference counting pointer to a SetEdge.

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

Definition at line 167 of file setedge.h.

Member Typedef Documentation

◆ Base

template<typename V >

typedef BaseEdgeRef<V> bio::SetEdgeRef< V >::Base

protected

Base class type.

Definition at line 172 of file setedge.h.

◆ const_iterator

template<typename V >

typedef Pointed::const_iterator bio::SetEdgeRef< V >::const_iterator

Definition at line 203 of file setedge.h.

◆ Edge

template<typename V >

typedef Pointed::Edge bio::SetEdgeRef< V >::Edge

USable Edge type.

Definition at line 176 of file setedge.h.

◆ iterator

template<typename V >

typedef Pointed::iterator bio::SetEdgeRef< V >::iterator

Definition at line 202 of file setedge.h.

◆ Pointed

template<typename V >

typedef SetEdge<V> bio::SetEdgeRef< V >::Pointed

protected

Pointed object type.

Definition at line 173 of file setedge.h.

◆ This

template<typename V >

typedef SetEdgeRef<V> bio::SetEdgeRef< V >::This

protected

Type of *this.

Definition at line 171 of file setedge.h.

◆ Vertex

template<typename V >

typedef Pointed::Vertex bio::SetEdgeRef< V >::Vertex

Usable Vertex type.

Definition at line 175 of file setedge.h.

Constructor & Destructor Documentation

◆ SetEdgeRef() [1/4]

template<typename V >

bio::SetEdgeRef< V >::SetEdgeRef ( )

inlineprotected

Default constructor (builds a none pointer)

Definition at line 181 of file setedge.h.

◆ SetEdgeRef() [2/4]

template<typename V >

bio::SetEdgeRef< V >::SetEdgeRef	(	const Vertex &	x,
		const Vertex &	y
	)

inline

Constructor from a pair of vertices.

Definition at line 184 of file setedge.h.

◆ SetEdgeRef() [3/4]

template<typename V >

bio::SetEdgeRef< V >::SetEdgeRef ( Pointed * e )

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 188 of file setedge.h.

◆ SetEdgeRef() [4/4]

template<typename V >

bio::SetEdgeRef< V >::SetEdgeRef ( const Base & other )

inline

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

Definition at line 191 of file setedge.h.

◆ ~SetEdgeRef()

template<typename V >

virtual bio::SetEdgeRef< V >::~SetEdgeRef ( )

inlinevirtual

Definition at line 192 of file setedge.h.

Member Function Documentation

◆ begin() [1/2]

template<typename V >

virtual iterator bio::SetEdgeRef< V >::begin ( )

inlinevirtual

Definition at line 206 of file setedge.h.

◆ begin() [2/2]

template<typename V >

virtual const_iterator bio::SetEdgeRef< V >::begin ( ) const

inlinevirtual

Definition at line 204 of file setedge.h.

◆ end() [1/2]

template<typename V >

virtual iterator bio::SetEdgeRef< V >::end ( )

inlinevirtual

Definition at line 207 of file setedge.h.

◆ end() [2/2]

template<typename V >

virtual const_iterator bio::SetEdgeRef< V >::end ( ) const

inlinevirtual

Definition at line 205 of file setedge.h.

◆ none()

template<typename V >

static Edge bio::SetEdgeRef< V >::none ( )

inlinestatic

Empty pointer factory.

The reference is set to 0

Definition at line 198 of file setedge.h.

◆ operator!=()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator!= ( const This & other ) const

inlinevirtual

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 222 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

◆ operator<()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator< ( const This & other ) const

inlinevirtual

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 235 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

◆ operator<=()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator<= ( const This & other ) const

inlinevirtual

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 248 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

◆ operator==()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator== ( const This & other ) const

inlinevirtual

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

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 213 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

◆ operator>()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator> ( const This & other ) const

inlinevirtual

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 226 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

◆ operator>=()

template<typename V >

virtual bool bio::SetEdgeRef< V >::operator>= ( const This & other ) const

inlinevirtual

Reimplemented from bio::BaseEdgeRef< V >.

Definition at line 244 of file setedge.h.

References bio::BaseEdgeRef< V >::other().

Friends And Related Function Documentation

◆ SetEdge< V >

template<typename V >

friend class SetEdge< V >

friend

Definition at line 248 of file setedge.h.

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

bioprocessing/graph/setedge.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

template<typename V> class bio::SetEdgeRef< V >

Member Typedef Documentation

◆ Base

◆ const_iterator

◆ Edge

◆ iterator

◆ Pointed

◆ This

◆ Vertex

Constructor & Destructor Documentation

◆ SetEdgeRef() [1/4]

◆ SetEdgeRef() [2/4]

◆ SetEdgeRef() [3/4]

◆ SetEdgeRef() [4/4]

◆ ~SetEdgeRef()

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ none()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

Friends And Related Function Documentation

◆ SetEdge< V >

template<typename V>
class bio::SetEdgeRef< V >