SESFace Class Reference
[Molecular Surface Computation]

Generic SESFace Class. More...

#include <SESFace.h>

Inheritance diagram for SESFace:

List of all members.

Public Types
Enums
enum	Type { TYPE_SPHERIC = 0, TYPE_TORIC = 1, TYPE_CONTACT = 2, TYPE_TORIC_SINGULAR = 3 }
	type of SESFace: 0 spheric reentrant face 1 toric reentrant face 2 contact face 3 singular toric reentrant face
Public Member Functions
Constructors and Destructors
	SESFace () throw ()
	Default constructor.
	SESFace (const SESFace &sesface, bool deep=false) throw ()
	Copy constructor.
	SESFace (Type type, RSVertex *rsvertex, RSEdge *rsedge, RSFace *rsface) throw ()
	Detailled constructor.
virtual	~SESFace () throw ()
	Destructor.
Assignments
void	set (const SESFace &sesface, bool deep=false) throw ()
	Assign from another SESFace.
SESFace &	operator= (const SESFace &sesface) throw ()
	Assign from another SESFace.
void	setType (Type type) throw ()
	Set the type of the SESFace.
Type	getType () const throw ()
	Get the type of the SESFace.
void	setRSVertex (RSVertex *rsvertex) throw ()
	Set the corresponding RSVertex of the SESFace.
RSVertex *	getRSVertex () const throw ()
	Get the corresponding RSVertex of the SESFace.
void	setRSEdge (RSEdge *rsedge) throw ()
	Set the corresponding RSEdge of the SESFace.
RSEdge *	getRSEdge () const throw ()
	Get the corresponding RSEdge of the SESFace.
void	setRSFace (RSFace *rsface) throw ()
	Set the corresponding RSFace of the SESFace.
RSFace *	getRSFace () const throw ()
	Get the corresponding RSFace of the SESFace.
Accessors
void	normalize (bool singular) throw ()
	Normalize the SESFace.
Predicates
virtual bool	operator== (const SESFace &) const throw ()
	Equality operator.
virtual bool	operator!= (const SESFace &) const throw ()
	Inequality operator.
virtual bool	operator *= (const SESFace &) const throw ()
	Similarity operator.
bool	isNeighbouredTo (SESFace *face) const throw ()
	Test whether two faces are neighboured.
bool	isFree () const throw ()
	Test whether a toric face is free ore not.
bool	hasSingularEdges () const throw ()
	Test whether a face has singular edges.
Protected Attributes
Attributes
Type	type_
RSVertex *	rsvertex_
RSEdge *	rsedge_
RSFace *	rsface_
Friends
Class friends
class SESEdge - class SESVertex - class SolventExcludedSurface - class SESComputer - class TSESSingularityCleaner - class TriangulatedSES - class SESTriangulator
class	SESEdge
class	SESVertex
class	SolventExcludedSurface
class	SESComputer
class	SESSingularityCleaner
class	TriangulatedSES
class	SESTriangulator

---

Detailed Description

Generic SESFace Class.

---

Constructor & Destructor Documentation

SESFace::SESFace (   )  throw ()

Default constructor. This method creates a new SESFace object.

SESFace::SESFace (  const SESFace &  sesface, bool  deep = false )  throw ()

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

SESFace::SESFace (  Type  type, RSVertex *  rsvertex, RSEdge *  rsedge, RSFace *  rsface )  throw ()

Detailled constructor. Create a new SESFace object Parameters: type  assigned the type rsvertex  assigned to the rsvertex rsedge  assigned to the rsedge rsface  assigned to the rsface

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

Destructor. Destructs the SESFace object.

---

Member Function Documentation

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

Get the corresponding RSEdge of the SESFace. Returns: RSEdge* a pointer to the corresponding RSEdge

RSFace* SESFace::getRSFace (   )  const throw ()

Get the corresponding RSFace of the SESFace. Returns: RSFace* a pointer to the corresponding RSFace

RSVertex* SESFace::getRSVertex (   )  const throw ()

Get the corresponding RSVertex of the SESFace. Returns: RSVertex* a pointer to the corresponding RSVertex

Type SESFace::getType (   )  const throw ()

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

bool SESFace::hasSingularEdges (   )  const throw ()

Test whether a face has singular edges. Returns: bool true if the face has singular edges, false otherwise

bool SESFace::isFree (   )  const throw ()

Test whether a toric face is free ore not. Returns: bool true if the face is toric and free, false otherwise

bool SESFace::isNeighbouredTo (  SESFace *  face  )  const throw ()

Test whether two faces are neighboured. Two faces are neighboured if they have a common edge. Parameters: face  the face to be tested Returns: bool true if the faces are neighboured, false otherwise

void SESFace::normalize (  bool  singular  )  throw ()

Normalize the SESFace.

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

Similarity operator. Returns: bool true Reimplemented from GraphFace< SESVertex, SESEdge, SESFace >.

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

Inequality operator. Returns: bool false Reimplemented from GraphFace< SESVertex, SESEdge, SESFace >.

SESFace& SESFace::operator= (  const SESFace &  sesface  )  throw ()

Assign from another SESFace. The SESFace object is linked to the neighbours of the SESFace object to assign from. Parameters: sesface  the SESFace object to assign from

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

Equality operator. Returns: bool true Reimplemented from GraphFace< SESVertex, SESEdge, SESFace >.

void SESFace::set (  const SESFace &  sesface, bool  deep = false )  throw ()

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

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

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

void SESFace::setRSFace (  RSFace *  rsface  )  throw ()

Set the corresponding RSFace of the SESFace. Parameters: rsface  a pointer to the new RSFace

void SESFace::setRSVertex (  RSVertex *  rsvertex  )  throw ()

Set the corresponding RSVertex of the SESFace. Parameters: rsvertex  a pointer to the new RSVertex

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

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