BALL::SASVertex Class Reference
[Molecular Surface Computation]

Generic SASVertex Class. More...

#include <SASVertex.h>

Inheritance diagram for BALL::SASVertex:

[legend]

List of all members.

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

BALL::SASVertex::SASVertex

(

)

Default constructor.

This method creates a new SASVertex object.

BALL::SASVertex::SASVertex	(	const SASVertex &	sasvertex,
		bool	deep = false
	)

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.

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

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 BALL::SASVertex::~SASVertex

(

)

[virtual]

Destructor.

Destructs the RSVertex object.

---

Member Function Documentation

TVector3<double> BALL::SASVertex::getPoint

(

)

const

Return the point represented by the SASVertex.

Returns:

TVector3<double> the point represented by the vertex

virtual bool BALL::SASVertex::operator!=

(

const SASVertex &

)

const [virtual]

Inequality operator.

Returns:

bool false

Reimplemented from BALL::GraphVertex< SASVertex, SASEdge, SASFace >.

virtual bool BALL::SASVertex::operator*=

(

const SASVertex &

)

const [virtual]

Similarity operator.

Returns:

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

Reimplemented from BALL::GraphVertex< SASVertex, SASEdge, SASFace >.

SASVertex& BALL::SASVertex::operator=

(

const SASVertex &

sasvertex

)

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 BALL::SASVertex::operator==

(

const SASVertex &

)

const [virtual]

Equality operator.

Returns:

bool true

Reimplemented from BALL::GraphVertex< SASVertex, SASEdge, SASFace >.

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

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 BALL::SASVertex::set	(	const SASVertex &	sasvertex,
		bool	deep = false
	)

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 BALL::SASVertex::setPoint

(

const TVector3< double > &

point

)

Set the point represented by the SASVertex.

Parameters:

point

the new point