#include <BALL/STRUCTURE/RSVertex.h>

Inheritance diagram for BALL::RSVertex:

Public Member Functions
Constructors and Destructors
	RSVertex ()

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

	RSVertex (Index atom)

virtual	~RSVertex ()

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

RSVertex &	operator= (const RSVertex &rsvertex)

Accessors
void	setAtom (Index atom)

Index	getAtom () const

Predicates
virtual bool	operator== (const RSVertex &rsvertex) const

virtual bool	operator!= (const RSVertex &rsvertex) const

virtual bool	operator*= (const RSVertex &rsvertex) const

Public Member Functions inherited from BALL::GraphVertex< RSVertex, RSEdge, RSFace >
	GraphVertex ()

	GraphVertex (const GraphVertex< RSVertex, RSEdge, RSFace > &vertex, bool deep=false)

virtual	~GraphVertex ()

void	set (const GraphVertex< RSVertex, RSEdge, RSFace > &vertex, bool deep=false)

GraphVertex< RSVertex, RSEdge, RSFace > &	operator= (const GraphVertex< RSVertex, RSEdge, RSFace > &vertex)

void	insert (RSEdge *edge)

void	insert (RSFace *face)

void	remove (RSEdge *edge)

void	remove (RSFace *face)

Position	numberOfEdges () const

Position	numberOfFaces () const

void	setIndex (Index index)

Index	getIndex () const

bool	join (const RSVertex &vertex)

bool	substitute (RSVertex *vertex)

RSFace *	has (RSFace *face) const

RSEdge *	has (RSEdge *edge) const

bool	hasEdges () const

bool	hasFaces () const

EdgeIterator	beginEdge ()

ConstEdgeIterator	beginEdge () const

EdgeIterator	endEdge ()

ConstEdgeIterator	endEdge () const

FaceIterator	beginFace ()

ConstFaceIterator	beginFace () const

FaceIterator	endFace ()

ConstFaceIterator	endFace () const

Protected Attributes

Index	atom_

Protected Attributes inherited from BALL::GraphVertex< RSVertex, RSEdge, RSFace >
HashSet< RSEdge * >	edges_

HashSet< RSFace * >	faces_

Index	index_

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

Class friends
class GraphEdge<Vertex,Edge,Face>; class GraphFace<Vertex,Edge,Face>; class GraphTriangle<Vertex,Edge,Face>;

Additional Inherited Members
Public Types inherited from BALL::GraphVertex< RSVertex, RSEdge, RSFace >
typedef HashSet< RSEdge * > ::Iterator	EdgeIterator

typedef HashSet< RSEdge * > ::ConstIterator	ConstEdgeIterator

typedef HashSet< RSFace * > ::Iterator	FaceIterator

typedef HashSet< RSFace * > ::ConstIterator	ConstFaceIterator

Detailed Description

Generic RSVertex Class.

Definition at line 37 of file RSVertex.h.

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

Friends And Related Function Documentation

friend class ReducedSurface

friend

Definition at line 65 of file RSVertex.h.

friend class RSComputer

friend

Definition at line 66 of file RSVertex.h.

friend class RSEdge

friend

Definition at line 63 of file RSVertex.h.

friend class RSFace

friend

Definition at line 64 of file RSVertex.h.

friend class SASEdge

friend

Definition at line 75 of file RSVertex.h.

friend class SASFace

friend

Definition at line 76 of file RSVertex.h.

friend class SASTriangulator

friend

Definition at line 80 of file RSVertex.h.

friend class SASVertex

friend

Definition at line 77 of file RSVertex.h.

friend class SESComputer

friend

Definition at line 71 of file RSVertex.h.

friend class SESEdge

friend

Definition at line 67 of file RSVertex.h.

friend class SESFace

friend

Definition at line 68 of file RSVertex.h.

friend class SESSingularityCleaner

friend

Definition at line 72 of file RSVertex.h.

friend class SESTriangulator

friend

Definition at line 74 of file RSVertex.h.

friend class SESVertex

friend

Definition at line 69 of file RSVertex.h.

friend class SolventAccessibleSurface

friend

Definition at line 78 of file RSVertex.h.

friend class SolventExcludedSurface

friend

Definition at line 70 of file RSVertex.h.

friend class TriangulatedSAS

friend

Definition at line 79 of file RSVertex.h.

friend class TriangulatedSES

friend

Definition at line 73 of file RSVertex.h.

Member Data Documentation

Index BALL::RSVertex::atom_

protected

Definition at line 181 of file RSVertex.h.

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation