Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
List of all members | Classes
T_Particle_vertex_base< ParticleTraits, GT, Vb > Class Template Reference
Reference Manuals » Alpha_complex_of_molecular_model

Specialized vertex of a 3D triangulation with an attached particle. More...

#include <Alpha_complex_of_molecular_model.hpp>

Classes

class  Rebind_TDS
 Rebind data structure for inheriting from a vertex data structure as specified in the CGAL library. More...
 

Serialization

template<class Archive >
void serialize (Archive &archive, const unsigned BOOST_PFTO int version)
 Serializes this vertex by serializing only its particle, if any. More...
 

Constructors

 T_Particle_vertex_base (void)
 Default constructor: the pointer to the particle is set to NULL. More...
 

Particle Managment

void set_particle (typename ParticleTraits::Particle_type &p)
 Sets the pointer to the particle (no copy of particle) More...
 
bool has_particle (void) const
 Checks that this vertex has a particle. Note that if the associated particle does not exist anymore, the pointer is invalidated, but this method will return true anyway. More...
 
ParticleTraits::Particle_type & get_particle (void)
 Accesses to a reference of the particle (it has to exist). More...
 
const ParticleTraits::Particle_type & get_particle (void) const
 Accesses to a const reference of the particle (it has to exist). More...
 

Ordering

bool operator< (const Self &other) const
 Orders the vertices from natural ordering of the particles. More...
 
bool operator> (const Self &other) const
 
bool operator<= (const Self &other) const
 
bool operator>= (const Self &other) const
 
bool operator== (const Self &other) const
 
bool operator!= (const Self &other) const
 

Detailed Description

template<class ParticleTraits, class GT, class Vb = CGAL::Triangulation_vertex_base_3<GT>>
class SBL::CSB::T_Particle_vertex_base< ParticleTraits, GT, Vb >

Specialized vertex of a 3D triangulation with an attached particle.

It uses the rebind method as described in the CGAL library for inheriting from a vertex data structure with attached info (CGAL::Triangulation_vertex_base_with_info_3), the info being a pointer over the particle type for avoiding copy of particles. The access to the particle is done through its reference. To check if a vertex has an attributed particle, the method has_particle can be used.

Class Documentation

◆ SBL::CSB::T_Particle_vertex_base::Rebind_TDS

class SBL::CSB::T_Particle_vertex_base::Rebind_TDS

template<class ParticleTraits, class GT, class Vb = CGAL::Triangulation_vertex_base_3<GT>>
template<class TDS2>
class SBL::CSB::T_Particle_vertex_base< ParticleTraits, GT, Vb >::Rebind_TDS< TDS2 >

Rebind data structure for inheriting from a vertex data structure as specified in the CGAL library.

Constructor & Destructor Documentation

◆ T_Particle_vertex_base()

T_Particle_vertex_base ( void  )
inline

Default constructor: the pointer to the particle is set to NULL.

Member Function Documentation

◆ get_particle() [1/2]

ParticleTraits::Particle_type& get_particle ( void  )
inline

Accesses to a reference of the particle (it has to exist).

◆ get_particle() [2/2]

const ParticleTraits::Particle_type& get_particle ( void  ) const
inline

Accesses to a const reference of the particle (it has to exist).

◆ has_particle()

bool has_particle ( void  ) const
inline

Checks that this vertex has a particle. Note that if the associated particle does not exist anymore, the pointer is invalidated, but this method will return true anyway.

◆ operator<()

bool operator< ( const Self &  other) const
inline

Orders the vertices from natural ordering of the particles.

◆ serialize()

void serialize ( Archive &  archive,
const unsigned BOOST_PFTO int  version 
)
inline

Serializes this vertex by serializing only its particle, if any.

◆ set_particle()

void set_particle ( typename ParticleTraits::Particle_type &  p)
inline

Sets the pointer to the particle (no copy of particle)