SASFace Class Reference
[Molecular Surface Computation]

Generic SASFace Class. More...

#include <SASFace.h>

Inheritance diagram for SASFace:

List of all members.

Public Types
Type definitions
typedef std::list< bool >::iterator	OrientationIterator
typedef std::list< bool >::const_iterator	ConstOrientationIterator
Public Member Functions
Constructors and Destructors
	SASFace () throw ()
	Default constructor.
	SASFace (const SASFace &sasface, bool deep=false) throw ()
	Copy constructor.
virtual	~SASFace () throw ()
	Destructor.
Assignments
void	set (const SASFace &sasface, bool deep=false) throw ()
	Assign from another SASFace.
SASFace &	operator= (const SASFace &sasface) throw ()
	Assign from another SASFace.
Accessors
void	setSphere (const TSphere3< double > &sphere) throw ()
	Set the sphere the GraphFace lies on.
TSphere3< double >	getSphere () const throw ()
	Return the sphere the GraphFace lies on.
Predicates
virtual bool	operator== (const SASFace &) const throw ()
	Equality operator.
virtual bool	operator!= (const SASFace &) const throw ()
	Inequality operator.
virtual bool	operator *= (const SASFace &) const throw ()
	Similarity operator.
External Iterators
OrientationIterator	beginOrientation () throw ()
ConstOrientationIterator	beginOrientation () const throw ()
OrientationIterator	endOrientation () throw ()
ConstOrientationIterator	endOrientation () const throw ()
Protected Attributes
Attributes
std::list< bool >	orientation_
TSphere3< double >	sphere_
Friends
Class friends
class SASEdge - class SASVertex - class SolventAccessibleSurface - class TriangulatedSAS - class SASTriangulator
class	SASEdge
class	SASVertex
class	SolventAccessibleSurface
class	TriangulatedSAS
class	SASTriangulator

---

Detailed Description

Generic SASFace Class.

---

Constructor & Destructor Documentation

SASFace::SASFace (   )  throw ()

Default constructor. This method creates a new SASFace object.

SASFace::SASFace (  const SASFace &  sasface, bool  deep = false )  throw ()

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

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

Destructor. Destructs the SASFace object.

---

Member Function Documentation

TSphere3<double> SASFace::getSphere (   )  const throw ()

Return the sphere the GraphFace lies on. Returns: TSphere<double> the sphere the GraphFace lies on

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

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

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

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

SASFace& SASFace::operator= (  const SASFace &  sasface  )  throw ()

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

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

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

void SASFace::set (  const SASFace &  sasface, bool  deep = false )  throw ()

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

void SASFace::setSphere (  const TSphere3< double > &  sphere  )  throw ()

Set the sphere the GraphFace lies on. Parameters: sphere  the new sphere