SESVertex Class Reference
[Molecular Surface Computation]

Generic SESVertex Class. More...

#include <SESVertex.h>

Inheritance diagram for SESVertex:

List of all members.

Public Member Functions
Constructors and Destructors
	SESVertex () throw ()
	Default constructor.
	SESVertex (const SESVertex &sesvertex, bool deep=false) throw ()
	Copy constructor.
	SESVertex (const TVector3< double > &point, const TVector3< double > &normal, Index atom, Index index) throw ()
	Detailled constructor.
virtual	~SESVertex () throw ()
	Destructor.
Assignment
void	set (const SESVertex &sesvertex, bool deep=false) throw ()
	Assign from another SESVertex.
SESVertex &	operator= (const SESVertex &sesvertex) throw ()
	Assign from another SESVertex.
void	set (const TVector3< double > point, const TVector3< double > &normal, Index atom, Index index) throw ()
	Assign to two TVector3<double>'s and two indices.
void	setPoint (const TVector3< double > &point) throw ()
	Set the point represented by the SESVertex.
TVector3< double >	getPoint () const throw ()
	Return the point represented by the SESVertex.
void	setNormal (const TVector3< double > &normal) throw (Exception::DivisionByZero)
	Set the normal vector of the SESVertex.
TVector3< double >	getNormal () const throw ()
	Return the normal vector of the SESVertex.
void	setAtom (Index atom) throw ()
	Set the index of the closest atom of the SESVertex.
Index	getAtom () const throw ()
	Return the index of the closest atom.
Predicates
virtual bool	operator== (const SESVertex &) const throw ()
	Equality operator.
virtual bool	operator!= (const SESVertex &) const throw ()
	Inequality operator.
virtual bool	operator *= (const SESVertex &) const throw ()
	Similarity operator.
Protected Attributes
Attributes
TVector3< double >	point_
TVector3< double >	normal_
Index	atom_
Friends
Class friends
class SESEdge - class SESFace - class SolventExcludedSurface - class SESComputer - class TSESSingulatityCleaner<double> - class TriangulatedSES - class SESTriangulator
class	SESEdge
class	SESFace
class	SolventExcludedSurface
class	SESComputer
class	SESSingularityCleaner
class	TriangulatedSES
class	SESTriangulator

---

Detailed Description

Generic SESVertex Class.

---

Constructor & Destructor Documentation

SESVertex::SESVertex (   )  throw ()

Default constructor. This method creates a new SESVertex object.

SESVertex::SESVertex (  const SESVertex &  sesvertex, bool  deep = false )  throw ()

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

SESVertex::SESVertex (  const TVector3< double > &  point, const TVector3< double > &  normal, Index  atom, Index  index )  throw ()

Detailled constructor. Create a new SESVertex object from some nice objects. Parameters: point  assigned to the point representet by the vertex normal  assigned to the normal vector of the vertex atom  assigned to the index of the closest atom index  assigned to the index of the vertex

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

Destructor. Destructs the RSVertex object.

---

Member Function Documentation

Index SESVertex::getAtom (   )  const throw ()

Return the index of the closest atom. Returns: Index the index of the closest atom

TVector3<double> SESVertex::getNormal (   )  const throw ()

Return the normal vector of the SESVertex. Returns: TVector3<double> the normal vector of the vertex

TVector3<double> SESVertex::getPoint (   )  const throw ()

Return the point represented by the SESVertex. Returns: TVector3<double> the point represented by the vertex

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

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

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

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

SESVertex& SESVertex::operator= (  const SESVertex &  sesvertex  )  throw ()

Assign from another SESVertex. The new SESVertex object is linked to the neighbours of the SESVertex object to assign from. Parameters: sesvertex  the SESVertex object to assign from

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

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

void SESVertex::set (  const TVector3< double >  point, const TVector3< double > &  normal, Index  atom, Index  index )  throw ()

Assign to two TVector3<double>'s and two indices. Parameters: point  assigned to the point represented by the vertex normal  assigned to the normal vector of th vertex atom  assigned to the index of the closest atom index  assigned to the index of the vertex

void SESVertex::set (  const SESVertex &  sesvertex, bool  deep = false )  throw ()

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

void SESVertex::setAtom (  Index  atom  )  throw ()

Set the index of the closest atom of the SESVertex. Parameters: atom  the index of the closest atom

void SESVertex::setNormal (  const TVector3< double > &  normal  )  throw (Exception::DivisionByZero)

Set the normal vector of the SESVertex. Parameters: normal  the new normal vector

void SESVertex::setPoint (  const TVector3< double > &  point  )  throw ()

Set the point represented by the SESVertex. Parameters: point  the new point