Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

SASVertex Class Reference
[Molecular Surface Computation]

Generic SASVertex Class. More...

#include <SASVertex.h>

Inheritance diagram for SASVertex:

GraphVertex< SASVertex, SASEdge, SASFace > List of all members.

Public Member Functions

Constructors and Destructors
 SASVertex () throw ()
 Default constructor.
 SASVertex (const SASVertex &sasvertex, bool deep=false) throw ()
 Copy constructor.
 SASVertex (const TVector3< double > &point, Index index) throw ()
 Detailled constructor.
virtual ~SASVertex () throw ()
 Destructor.
Assignment
void set (const SASVertex &sasvertex, bool deep=false) throw ()
 Assign from another SASVertex.
SASVertexoperator= (const SASVertex &sasvertex) throw ()
 Assign from another SASVertex.
void set (const TVector3< double > point, Index index) throw ()
 Assign to a TVector3<double> and an Index.
void setPoint (const TVector3< double > &point) throw ()
 Set the point represented by the SASVertex.
TVector3< double > getPoint () const throw ()
 Return the point represented by the SASVertex.
Predicates
virtual bool operator== (const SASVertex &) const throw ()
 Equality operator.
virtual bool operator!= (const SASVertex &) const throw ()
 Inequality operator.
virtual bool operator *= (const SASVertex &) const throw ()
 Similarity operator.

Protected Attributes

TVector3< double > point_

Friends

Class friends
  • class SASEdge - class SASFace - class SolventAccessibleSurface - class TriangulatedSAS - class SASTriangulator


class SASEdge
class SASFace
class SolventAccessibleSurface
class TriangulatedSAS
class SASTriangulator

Detailed Description

Generic SASVertex Class.


Constructor & Destructor Documentation

SASVertex::SASVertex  )  throw ()
 

Default constructor.

This method creates a new SASVertex object.

SASVertex::SASVertex const SASVertex sasvertex,
bool  deep = false
throw ()
 

Copy constructor.

Create a new SASVertex object from another.

Parameters:
sasvertex the SASVertex object to be copied
deep if deep = false, all pointers are set to NULL (default). Otherwise the new SASVertex object is linked to the neighbours of the old SASVertex object.

SASVertex::SASVertex const TVector3< double > &  point,
Index  index
throw ()
 

Detailled constructor.

Create a new SASVertex object from some nice objects.

Parameters:
point assigned to the point representet by the vertex
index assigned to the index of the vertex

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

Destructor.

Destructs the RSVertex object.


Member Function Documentation

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

Return the point represented by the SASVertex.

Returns:
TVector3<double> the point represented by the vertex

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

Similarity operator.

Returns:
bool true if the points the SASVertices lie on are equal, false otherwise

Reimplemented from GraphVertex< SASVertex, SASEdge, SASFace >.

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

Inequality operator.

Returns:
bool false

Reimplemented from GraphVertex< SASVertex, SASEdge, SASFace >.

SASVertex& SASVertex::operator= const SASVertex sasvertex  )  throw ()
 

Assign from another SASVertex.

The new SASVertex object is linked to the neighbours of the SASVertex object to assign from.

Parameters:
sasvertex the SASVertex object to assign from

virtual bool SASVertex::operator== const SASVertex  )  const throw () [virtual]
 

Equality operator.

Returns:
bool true

Reimplemented from GraphVertex< SASVertex, SASEdge, SASFace >.

void SASVertex::set const TVector3< double >  point,
Index  index
throw ()
 

Assign to a TVector3<double> and an Index.

Parameters:
point assigned to the point represented by the vertex
index assigned to the index of the vertex

void SASVertex::set const SASVertex sasvertex,
bool  deep = false
throw ()
 

Assign from another SASVertex.

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

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

Set the point represented by the SASVertex.

Parameters:
point the new point