BALL::SESVertex Class Reference

#include <BALL/STRUCTURE/SESVertex.h>

Inheritance diagram for BALL::SESVertex:

Public Member Functions
Constructors and Destructors
	SESVertex ()
	SESVertex (const SESVertex &sesvertex, bool deep=false)
	SESVertex (const TVector3< double > &point, const TVector3< double > &normal, Index atom, Index index)
virtual	~SESVertex ()
Assignment
void	set (const SESVertex &sesvertex, bool deep=false)
SESVertex &	operator= (const SESVertex &sesvertex)
void	set (const TVector3< double > point, const TVector3< double > &normal, Index atom, Index index)
void	setPoint (const TVector3< double > &point)
TVector3< double >	getPoint () const
void	setNormal (const TVector3< double > &normal) throw (Exception::DivisionByZero)
TVector3< double >	getNormal () const
void	setAtom (Index atom)
Index	getAtom () const
Predicates
virtual bool	operator== (const SESVertex &) const
virtual bool	operator!= (const SESVertex &) const
virtual bool	operator*= (const SESVertex &) const
Public Member Functions inherited from BALL::GraphVertex< SESVertex, SESEdge, SESFace >
	GraphVertex ()
	GraphVertex (const GraphVertex< SESVertex, SESEdge, SESFace > &vertex, bool deep=false)
virtual	~GraphVertex ()
void	set (const GraphVertex< SESVertex, SESEdge, SESFace > &vertex, bool deep=false)
GraphVertex< SESVertex, SESEdge, SESFace > &	operator= (const GraphVertex< SESVertex, SESEdge, SESFace > &vertex)
void	insert (SESEdge *edge)
void	insert (SESFace *face)
void	remove (SESEdge *edge)
void	remove (SESFace *face)
Position	numberOfEdges () const
Position	numberOfFaces () const
void	setIndex (Index index)
Index	getIndex () const
bool	join (const SESVertex &vertex)
bool	substitute (SESVertex *vertex)
SESFace *	has (SESFace *face) const
SESEdge *	has (SESEdge *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
Attributes
TVector3< double >	point_
TVector3< double >	normal_
Index	atom_
Protected Attributes inherited from BALL::GraphVertex< SESVertex, SESEdge, SESFace >
HashSet< SESEdge * >	edges_
HashSet< SESFace * >	faces_
Index	index_

Friends
Class friends
class SESEdge class SESFace class SolventExcludedSurface class SESComputer class TSESSingulatityCleaner<double> class TriangulatedSES class SESTriangulator
class	SESEdge
class	SESFace
class	SolventExcludedSurface
class	SESComputer
class	SESSingularityCleaner
class	TriangulatedSES
class	SESTriangulator
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< SESVertex, SESEdge, SESFace >
typedef HashSet< SESEdge * > ::Iterator	EdgeIterator
typedef HashSet< SESEdge * > ::ConstIterator	ConstEdgeIterator
typedef HashSet< SESFace * > ::Iterator	FaceIterator
typedef HashSet< SESFace * > ::ConstIterator	ConstFaceIterator

Detailed Description

Generic SESVertex Class.

Definition at line 29 of file SESVertex.h.

Constructor & Destructor Documentation

BALL::SESVertex::SESVertex

(

)

Default constructor. This method creates a new SESVertex object.

BALL::SESVertex::SESVertex	(	const SESVertex &	sesvertex,
		bool	deep = false
	)

Copy constructor. Create a new SESVertex object from another.

Parameters

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

BALL::SESVertex::SESVertex	(	const TVector3< double > &	point,
		const TVector3< double > &	normal,
		Index	atom,
		Index	index
	)

Detailled constructor. Create a new SESVertex object from some nice objects.

Parameters

point	assigned to the point representet by the vertex
normal	assigned to the normal vector of the vertex
atom	assigned to the index of the closest atom
index	assigned to the index of the vertex

virtual BALL::SESVertex::~SESVertex ( )

virtual

Destructor. Destructs the RSVertex object.

Member Function Documentation

Index BALL::SESVertex::getAtom

(

)

const

Return the index of the closest atom.

Returns

Index the index of the closest atom

TVector3<double> BALL::SESVertex::getNormal

(

)

const

Return the normal vector of the SESVertex.

Returns

TVector3<double> the normal vector of the vertex

TVector3<double> BALL::SESVertex::getPoint

(

)

const

Return the point represented by the SESVertex.

Returns

TVector3<double> the point represented by the vertex

virtual bool BALL::SESVertex::operator!= ( const SESVertex &  ) const

virtual

Inequality operator.

Returns

bool false

Reimplemented from BALL::GraphVertex< SESVertex, SESEdge, SESFace >.

virtual bool BALL::SESVertex::operator*= ( const SESVertex &  ) const

virtual

Similarity operator.

Returns

bool true

Reimplemented from BALL::GraphVertex< SESVertex, SESEdge, SESFace >.

SESVertex& BALL::SESVertex::operator=

(

const SESVertex &

sesvertex

)

Assign from another SESVertex. The new SESVertex object is linked to the neighbours of the SESVertex object to assign from.

Parameters

sesvertex

the SESVertex object to assign from

virtual bool BALL::SESVertex::operator== ( const SESVertex &  ) const

virtual

Equality operator.

Returns

bool true

Reimplemented from BALL::GraphVertex< SESVertex, SESEdge, SESFace >.

void BALL::SESVertex::set	(	const SESVertex &	sesvertex,
		bool	deep = false
	)

Assign from another SESVertex.

Parameters

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

void BALL::SESVertex::set	(	const TVector3< double >	point,
		const TVector3< double > &	normal,
		Index	atom,
		Index	index
	)

Assign to two TVector3<double>'s and two indices.

Parameters

point	assigned to the point represented by the vertex
normal	assigned to the normal vector of th vertex
atom	assigned to the index of the closest atom
index	assigned to the index of the vertex

void BALL::SESVertex::setAtom

(

Index

atom

)

Set the index of the closest atom of the SESVertex.

Parameters

atom	the index of the closest atom

void BALL::SESVertex::setNormal	(	const TVector3< double > &	normal	)
throw	(	Exception::DivisionByZero
	)

Set the normal vector of the SESVertex.

Parameters

normal

the new normal vector

void BALL::SESVertex::setPoint

(

const TVector3< double > &

point

)

Set the point represented by the SESVertex.

Parameters

point

the new point

Friends And Related Function Documentation

friend class SESComputer

friend

Definition at line 47 of file SESVertex.h.

friend class SESEdge

friend

Definition at line 44 of file SESVertex.h.

friend class SESFace

friend

Definition at line 45 of file SESVertex.h.

friend class SESSingularityCleaner

friend

Definition at line 48 of file SESVertex.h.

friend class SESTriangulator

friend

Definition at line 50 of file SESVertex.h.

friend class SolventExcludedSurface

friend

Definition at line 46 of file SESVertex.h.

friend class TriangulatedSES

friend

Definition at line 49 of file SESVertex.h.

Member Data Documentation

Index BALL::SESVertex::atom_

protected

Definition at line 205 of file SESVertex.h.

TVector3<double> BALL::SESVertex::normal_

protected

Definition at line 202 of file SESVertex.h.

TVector3<double> BALL::SESVertex::point_

protected

Definition at line 199 of file SESVertex.h.