SESEdge Class Reference
[Molecular Surface Computation]

Generic SESEdge Class. More...

#include <SESEdge.h>

Inheritance diagram for SESEdge:

List of all members.

Public Types
Enums
enum	Type { TYPE_CONCAVE = 0, TYPE_CONVEX = 1, TYPE_SINGULAR = 2 }
	type of SESEdge: 0 concave 1 convex 2 singular
Public Member Functions
Constructors and Destructors
	SESEdge () throw ()
	Default constructor.
	SESEdge (const SESEdge &sesedge, bool deep=false) throw ()
	Copy constructor.
	SESEdge (SESVertex *vertex0, SESVertex *vertex1, SESFace *face0, SESFace *face1, const TCircle3< double > &circle, RSEdge *rsedge, Type type, Index index) throw ()
	Detailled constructor.
virtual	~SESEdge () throw ()
	Destructor.
Assignment
void	set (const SESEdge &sesedge, bool deep=false) throw ()
	Assign from another SESEdge.
SESEdge &	operator= (const SESEdge &sesedge) throw ()
	Assign from another SESEdge.
void	set (SESVertex *vertex0, SESVertex *vertex1, SESFace *face0, SESFace *face1, const TCircle3< double > &circle, RSEdge *rsedge, Type type, Index index) throw ()
	Assign from some nice objects.
Accessors
void	setCircle (const TCircle3< double > &center) throw ()
	Set the circle on wich the SESEdge lies.
TCircle3< double >	getCircle () const throw ()
	Return the circle on wich the SESEdge lies.
void	setRSEdge (RSEdge *rsedge) throw ()
	Set the corresponding RSEdge.
RSEdge *	getRSEdge () const throw ()
	Return the corresponding RSEdge.
void	setType (Type type) throw ()
	Set the type of the SESEdge.
Type	getType () const throw ()
	Get the type of the SESEdge.
Predicates
virtual bool	operator== (const SESEdge &sesedge) const throw ()
	Equality operator.
virtual bool	operator!= (const SESEdge &sesedge) const throw ()
	Inequality operator.
virtual bool	operator *= (const SESEdge &) const throw ()
	similarity operator.
bool	isFree () const throw ()
	isFree.
Protected Attributes
TCircle3< double >	circle_
RSEdge *	rsedge_
Type	type_
Friends
Class friends
class SESFace - class SESVertex - class SolventExcludedSurface - class SESComputer - class TSESSingularityCleaner - class TriangulatedSES - class SESTriangulator
class	SESFace
class	SESVertex
class	SolventExcludedSurface
class	SESComputer
class	SESSingularityCleaner
class	TriangulatedSES
class	SESTriangulator

---

Detailed Description

Generic SESEdge Class.

---

Constructor & Destructor Documentation

SESEdge::SESEdge (   )  throw ()

Default constructor. This method creates a new SESEdge object.

SESEdge::SESEdge (  const SESEdge &  sesedge, bool  deep = false )  throw ()

Copy constructor. Create a new SESEdge object from another. Parameters: sesedge  the SESEdge object to be copied deep  if deep = false, all pointers are set to NULL (default). Otherwise the new SESEdge object is linked to the neighbours of the old SESEdge object.

SESEdge::SESEdge (  SESVertex *  vertex0, SESVertex *  vertex1, SESFace *  face0, SESFace *  face1, const TCircle3< double > &  circle, RSEdge *  rsedge, Type  type, Index  index )  throw ()

Detailled constructor. Create a new SESEdge object from some nice objects. Parameters: vertex0  assigned to the first vertex vertex1  assigned to the second vertex face0  assigned to the first face face1  assigned to the second face circle  assigned to the circle rsedge  assigned to the RSEdge type  assigned to the type of the SESEdge index  assigned to the index

virtual SESEdge::~SESEdge (   )  throw () [virtual]

Destructor. Destructs the SESEdge object.

---

Member Function Documentation

TCircle3<double> SESEdge::getCircle (   )  const throw ()

Return the circle on wich the SESEdge lies. Returns: TCircle3<double> the circle of The SESEdge

RSEdge* SESEdge::getRSEdge (   )  const throw ()

Return the corresponding RSEdge. Returns: RSEdge* a pointer to th correwsponding RSEdge

Type SESEdge::getType (   )  const throw ()

Get the type of the SESEdge. Returns: Type the type of the SESEdge

bool SESEdge::isFree (   )  const throw ()

isFree. Returns: bool true if the RSEdge of the SESEdge is free, false otherwise

virtual bool SESEdge::operator *= (  const SESEdge &   )  const throw () [virtual]

similarity operator. Returns: bool true Reimplemented from GraphEdge< SESVertex, SESEdge, SESFace >.

virtual bool SESEdge::operator!= (  const SESEdge &  sesedge  )  const throw () [virtual]

Inequality operator. Returns: bool false if all vertices are equal modulo order, true otherwise Reimplemented from GraphEdge< SESVertex, SESEdge, SESFace >.

SESEdge& SESEdge::operator= (  const SESEdge &  sesedge  )  throw ()

Assign from another SESEdge. The SESEdge object is linked to the neighbours of the SESEdge object to assign from. Parameters: sesedge  the SESEdge object to assign from

virtual bool SESEdge::operator== (  const SESEdge &  sesedge  )  const throw () [virtual]

Equality operator. Returns: bool true if all vertices are equal modulo order, false otherwise Reimplemented from GraphEdge< SESVertex, SESEdge, SESFace >.

void SESEdge::set (  SESVertex *  vertex0, SESVertex *  vertex1, SESFace *  face0, SESFace *  face1, const TCircle3< double > &  circle, RSEdge *  rsedge, Type  type, Index  index )  throw ()

Assign from some nice objects. Parameters: vertex0  assigned to the first vertex vertex1  assigned to the second vertex face0  assigned to the first face face1  assigned to the second face circle  assigned to the circle rsedge  assigned to the RSEdge type  assigned to the type of the SESEdge index  assigned to the index

void SESEdge::set (  const SESEdge &  sesedge, bool  deep = false )  throw ()

Assign from another SESEdge. Parameters: sesedge  the SESEdge object to assign from deep  if deep = false, all pointers are set to NULL (default). Otherwise the SESEdge object is linked to the neighbours of the SESEdge object to assign from.

void SESEdge::setCircle (  const TCircle3< double > &  center  )  throw ()

Set the circle on wich the SESEdge lies. Parameters: center  the new circle

void SESEdge::setRSEdge (  RSEdge *  rsedge  )  throw ()

Set the corresponding RSEdge. Parameters: rsedge  a pointer to the new RSEdge

void SESEdge::setType (  Type  type  )  throw ()

Set the type of the SESEdge. Parameters: type  the new type of the SESEdge