SASEdge Class Reference
[Molecular Surface Computation]

Generic SASEdge Class. More...

#include <SASEdge.h>

Inheritance diagram for SASEdge:

List of all members.

Public Member Functions
Constructors and Destructors
	SASEdge () throw ()
	Default constructor.
	SASEdge (const SASEdge &sasedge, bool deep=false) throw ()
	Copy constructor.
	SASEdge (SASVertex *vertex0, SASVertex *vertex1, SASFace *face0, SASFace *face1, const TCircle3< double > &circle, const TAngle< double > &angle, Index index) throw ()
	Detailled constructor.
virtual	~SASEdge () throw ()
	Destructor.
Assignment
void	set (const SASEdge &sasedge, bool deep=false) throw ()
	Assign from another SASEdge object.
SASEdge &	operator= (const SASEdge &sasedge) throw ()
	Assign from another SASEdge object.
void	set (SASVertex *vertex0, SASVertex *vertex1, SASFace *face0, SASFace *face1, const TCircle3< double > &circle, const TAngle< double > &angle, Index index) throw ()
	Assign from some nice objects.
Accessors
void	setCircle (const TCircle3< double > &center) throw ()
	Set the circle on which the SASEdge lies.
TCircle3< double >	getCircle () const throw ()
	Return the circle on which the SASEdge lies.
void	setAngle (const TAngle< double > &angle) throw ()
	Set the angle of the SASEdge.
TAngle< double >	getAngle () const throw ()
	Return the angle of the SASEdge.
Predicates
virtual bool	operator== (const SASEdge &) const throw ()
	Equality operator.
virtual bool	operator!= (const SASEdge &) const throw ()
	Inequality operator.
virtual bool	operator *= (const SASEdge &) const throw ()
	Similarity operator.
bool	isFree () const throw ()
	isFree.
Protected Attributes
TCircle3< double >	circle_
TAngle< double >	angle_
Friends
Class friends
class SASFace - class SASVertex - class SolventAccessibleSurface - class TriangulatedSAS - class SASTriangulator
class	SASVertex
class	SASFace
class	SolventAccessibleSurface
class	TriangulatedSAS
class	SASTriangulator

---

Detailed Description

Generic SASEdge Class.

---

Constructor & Destructor Documentation

SASEdge::SASEdge (   )  throw ()

Default constructor. This method creates a new SASEdge object.

SASEdge::SASEdge (  const SASEdge &  sasedge, bool  deep = false )  throw ()

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

SASEdge::SASEdge (  SASVertex *  vertex0, SASVertex *  vertex1, SASFace *  face0, SASFace *  face1, const TCircle3< double > &  circle, const TAngle< double > &  angle, Index  index )  throw ()

Detailled constructor. Create a new SASEdge 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 angle  assigned to the angle index  assigned to the index

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

Destructor. Destructs the SASEdge object.

---

Member Function Documentation

TAngle<double> SASEdge::getAngle (   )  const throw ()

Return the angle of the SASEdge. Returns: TAngle<double> the angle of the SASEdge

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

Return the circle on which the SASEdge lies. Returns: TCircle3<double> the circle of the SASEdge

bool SASEdge::isFree (   )  const throw ()

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

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

Similarity operator. Returns: bool true Reimplemented from GraphEdge< SASVertex, SASEdge, SASFace >.

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

Inequality operator. Returns: bool false Reimplemented from GraphEdge< SASVertex, SASEdge, SASFace >.

SASEdge& SASEdge::operator= (  const SASEdge &  sasedge  )  throw ()

Assign from another SASEdge object. The SASEdge object is linked to the neighbours of the SASEdge object to assign from. Parameters: sasedge  the SASEdge object to assign from

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

Equality operator. Returns: bool true Reimplemented from GraphEdge< SASVertex, SASEdge, SASFace >.

void SASEdge::set (  SASVertex *  vertex0, SASVertex *  vertex1, SASFace *  face0, SASFace *  face1, const TCircle3< double > &  circle, const TAngle< double > &  angle, 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 angle  assigned to the angle index  assigned to the index

void SASEdge::set (  const SASEdge &  sasedge, bool  deep = false )  throw ()

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

void SASEdge::setAngle (  const TAngle< double > &  angle  )  throw ()

Set the angle of the SASEdge. Parameters: angle  the new angle

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

Set the circle on which the SASEdge lies. Parameters: center  the new circle