bioprocessing  5.1.2
Public Types | Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
bio::PointVertex< P > Class Template Reference

Coordinates-defined vertices. More...

#include <bioprocessing/graph/pointvertex.h>

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

Public Types

typedef PointVertexRef< P > Vertex
 Useable type (RC type) More...
 
typedef PointVertexRef< P > Ref
 Reference type. More...
 
typedef P Point
 Coordiantes type. More...
 
- Public Types inherited from bio::BaseVertex
typedef BaseVertexRef Vertex
 Useable type (its RC pointer) More...
 
typedef BaseVertexRef Ref
 RC pointer to the type. More...
 

Public Member Functions

 PointVertex (const Point &p)
 Constructor from coordiantes. More...
 
 PointVertex (const This &other)
 Copy constructor. More...
 
virtual ~PointVertex ()
 
const Point & point () const
 constant accessor to the coordinates More...
 
Point & point ()
 non constant accessor to the coordinates 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
 
virtual bool operator>= (const This &other) const
 
- Public Member Functions inherited from bio::BaseVertex
 BaseVertex ()
 Default constructor. More...
 
virtual ~BaseVertex ()
 

Protected Types

typedef PointVertex< P > This
 Type of *this. More...
 
typedef BaseVertex Base
 Base class. More...
 
- Protected Types inherited from bio::BaseVertex
typedef BaseVertex This
 Type of *this. More...
 

Protected Attributes

Point _point
 

Friends

class PointVertexRef< P >
 

Detailed Description

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

Coordinates-defined vertices.

This class is templated with a point type (Point3d, Point4dl, Point2df, ...). Such a point represents the coordinates of the vertex. Two vertices are considered equal if their coordinates are.

Definition at line 35 of file pointvertex.h.

Member Typedef Documentation

◆ Base

template<typename P >
typedef BaseVertex bio::PointVertex< P >::Base
protected

Base class.

Definition at line 40 of file pointvertex.h.

◆ Point

template<typename P >
typedef P bio::PointVertex< P >::Point

Coordiantes type.

Definition at line 44 of file pointvertex.h.

◆ Ref

template<typename P >
typedef PointVertexRef<P> bio::PointVertex< P >::Ref

Reference type.

Definition at line 43 of file pointvertex.h.

◆ This

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

Type of *this.

Definition at line 39 of file pointvertex.h.

◆ Vertex

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

Useable type (RC type)

Definition at line 42 of file pointvertex.h.

Constructor & Destructor Documentation

◆ PointVertex() [1/2]

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

Constructor from coordiantes.

Definition at line 49 of file pointvertex.h.

◆ PointVertex() [2/2]

template<typename P >
bio::PointVertex< P >::PointVertex ( const This &  other)
inline

Copy constructor.

Definition at line 51 of file pointvertex.h.

◆ ~PointVertex()

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

Definition at line 52 of file pointvertex.h.

Member Function Documentation

◆ operator!=()

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

Reimplemented from bio::BaseVertex.

Definition at line 69 of file pointvertex.h.

References bio::PointVertex< P >::operator==().

◆ operator<()

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

Reimplemented from bio::BaseVertex.

Definition at line 87 of file pointvertex.h.

◆ operator<=()

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

Reimplemented from bio::BaseVertex.

Definition at line 93 of file pointvertex.h.

◆ operator==()

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

Reimplemented from bio::BaseVertex.

Definition at line 63 of file pointvertex.h.

References bio::PointVertex< P >::_point.

Referenced by bio::PointVertex< P >::operator!=().

◆ operator>()

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

Reimplemented from bio::BaseVertex.

Definition at line 73 of file pointvertex.h.

References bio::PointVertex< P >::_point.

◆ operator>=()

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

Reimplemented from bio::BaseVertex.

Definition at line 99 of file pointvertex.h.

◆ point() [1/2]

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

non constant accessor to the coordinates

Definition at line 59 of file pointvertex.h.

References bio::PointVertex< P >::_point.

◆ point() [2/2]

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

constant accessor to the coordinates

Definition at line 57 of file pointvertex.h.

References bio::PointVertex< P >::_point.

Referenced by operator<<().

Friends And Related Function Documentation

◆ PointVertexRef< P >

template<typename P >
friend class PointVertexRef< P >
friend

Definition at line 108 of file pointvertex.h.

Member Data Documentation

◆ _point

template<typename P >
Point bio::PointVertex< P >::_point
protected

Definition at line 108 of file pointvertex.h.

Referenced by bio::PointVertex< P >::operator==(), bio::PointVertex< P >::operator>(), and bio::PointVertex< P >::point().

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