BALL::RSVertex Class Reference
[Molecular Surface Computation]

Generic RSVertex Class. More...

#include <RSVertex.h>

Inheritance diagram for BALL::RSVertex:

[legend]

List of all members.

Public Member Functions
Constructors and Destructors
	RSVertex ()
	Default constructor.
	RSVertex (const RSVertex &rsvertex, bool deep=false)
	Copy constructor.
	RSVertex (Index atom)
	Detailled constructor.
virtual	~RSVertex ()
	Destructor.
Assignment
void	set (const RSVertex &rsvertex, bool deep=false)
	Assign from another RSVertex.
RSVertex &	operator= (const RSVertex &rsvertex)
	Assign from another RSVertex.
Accessors
void	setAtom (Index atom)
	Set the index of the atom represented by the vertex.
Index	getAtom () const
	Return the index of the atom represented by the vertex.
Predicates
virtual bool	operator== (const RSVertex &rsvertex) const
	Equality operator.
virtual bool	operator!= (const RSVertex &rsvertex) const
	Inequality operator.
virtual bool	operator*= (const RSVertex &rsvertex) const
	Similarity operator.
Protected Attributes
Index	atom_
Friends
Class friends
class RSEdge class RSFace class ReducedSurface class RSComputer class SESEdge class SESFace class SESVertex class SolventExcludedSurface class SESComputer class SESSingularityCleaner class TriangulatedSES class SESTriangulator class SASEdge class SASFace class SASVertex class SolventAccessibleSurface class TriangulatedSAS class SASTriangulator
class	RSEdge
class	RSFace
class	ReducedSurface
class	RSComputer
class	SESEdge
class	SESFace
class	SESVertex
class	SolventExcludedSurface
class	SESComputer
class	SESSingularityCleaner
class	TriangulatedSES
class	SESTriangulator
class	SASEdge
class	SASFace
class	SASVertex
class	SolventAccessibleSurface
class	TriangulatedSAS
class	SASTriangulator

---

Detailed Description

Generic RSVertex Class.

---

Constructor & Destructor Documentation

BALL::RSVertex::RSVertex

(

)

Default constructor.

This method creates a new RSVertex object.

BALL::RSVertex::RSVertex	(	const RSVertex &	rsvertex,
		bool	deep = false
	)

Copy constructor.

Create a new RSVertex object from another.

Parameters:

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

BALL::RSVertex::RSVertex

(

Index

atom

)

Detailled constructor.

Create a new RSVertex object from an index.

Parameters:

atom

assigned to the index of the atom

virtual BALL::RSVertex::~RSVertex

(

)

[virtual]

Destructor.

Destructs the RSVertex object.

---

Member Function Documentation

Index BALL::RSVertex::getAtom

(

)

const

Return the index of the atom represented by the vertex.

Returns:

Index the index of the atom represented by the vertex

virtual bool BALL::RSVertex::operator!=

(

const RSVertex &

rsvertex

)

const [virtual]

Inequality operator.

Returns:

bool false if the vertices are equal in all components, true otherwise

Reimplemented from BALL::GraphVertex< RSVertex, RSEdge, RSFace >.

virtual bool BALL::RSVertex::operator*=

(

const RSVertex &

rsvertex

)

const [virtual]

Similarity operator.

Returns:

bool true if the atoms are equal, false otherwise

Reimplemented from BALL::GraphVertex< RSVertex, RSEdge, RSFace >.

RSVertex& BALL::RSVertex::operator=

(

const RSVertex &

rsvertex

)

Assign from another RSVertex.

The RSVertex object is linked to the neighbours of the RSVertex object to assign from.

Parameters:

rsvertex

the RSVertex object to assign from

virtual bool BALL::RSVertex::operator==

(

const RSVertex &

rsvertex

)

const [virtual]

Equality operator.

Returns:

bool true if the vertices are equal in all components, false otherwise

Reimplemented from BALL::GraphVertex< RSVertex, RSEdge, RSFace >.

void BALL::RSVertex::set	(	const RSVertex &	rsvertex,
		bool	deep = false
	)

Assign from another RSVertex.

Parameters:

	rsvertex	the RSVertex object to assign from
	deep	if deep = false, all pointers are set to NULL (default). Otherwise the RSVertex object is linked to the neighbours of the RSVertex object to assign from.

void BALL::RSVertex::setAtom

(

Index

atom

)

Set the index of the atom represented by the vertex.

Parameters:

atom

the new index