BALL  1.4.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
BALL::SASFace Class Reference

#include <BALL/STRUCTURE/SASFace.h>

Inheritance diagram for BALL::SASFace:
BALL::GraphFace< SASVertex, SASEdge, SASFace >

List of all members.

Public Types

Type definitions
typedef std::list< bool >::iterator OrientationIterator
typedef std::list< bool >
::const_iterator 
ConstOrientationIterator

Public Member Functions

Constructors and Destructors
 SASFace ()
 SASFace (const SASFace &sasface, bool deep=false)
virtual ~SASFace ()
Assignments
void set (const SASFace &sasface, bool deep=false)
SASFaceoperator= (const SASFace &sasface)
Accessors
void setSphere (const TSphere3< double > &sphere)
TSphere3< doublegetSphere () const
Predicates
virtual bool operator== (const SASFace &) const
virtual bool operator!= (const SASFace &) const
virtual bool operator*= (const SASFace &) const
External Iterators
OrientationIterator beginOrientation ()
ConstOrientationIterator beginOrientation () const
OrientationIterator endOrientation ()
ConstOrientationIterator endOrientation () const

Protected Attributes

Attributes
std::list< boolorientation_
TSphere3< doublesphere_

Friends

Class friends
class SASEdge
class SASVertex
class SolventAccessibleSurface
class TriangulatedSAS
class SASTriangulator

Detailed Description

Generic SASFace Class.

Definition at line 30 of file SASFace.h.


Member Typedef Documentation

typedef std::list<bool>::const_iterator BALL::SASFace::ConstOrientationIterator

Definition at line 56 of file SASFace.h.

typedef std::list<bool>::iterator BALL::SASFace::OrientationIterator

Definition at line 55 of file SASFace.h.


Constructor & Destructor Documentation

Default constructor. This method creates a new SASFace object.

BALL::SASFace::SASFace ( const SASFace sasface,
bool  deep = false 
)

Copy constructor. Create a new SASFace object from another.

Parameters:
sasfacethe SASFace object to be copied
deepif deep = false, all pointers are set to NULL (default). Otherwise the new SASFace object is linked to the neighbours of the old SASFace object.
virtual BALL::SASFace::~SASFace ( ) [virtual]

Destructor. Destructs the SASFace object.


Member Function Documentation

Return the sphere the GraphFace lies on.

Returns:
TSphere<double> the sphere the GraphFace lies on
virtual bool BALL::SASFace::operator!= ( const SASFace ) const [virtual]

Inequality operator.

Returns:
bool false

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

virtual bool BALL::SASFace::operator*= ( const SASFace ) const [virtual]

Similarity operator.

Returns:
bool true

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

SASFace& BALL::SASFace::operator= ( const SASFace sasface)

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

Parameters:
sasfacethe SASFace object to assign from
virtual bool BALL::SASFace::operator== ( const SASFace ) const [virtual]

Equality operator.

Returns:
bool true

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

void BALL::SASFace::set ( const SASFace sasface,
bool  deep = false 
)

Assign from another SASFace.

Parameters:
sasfacethe SASFace object to assign from
deepif deep = false, all pointers are set to NULL (default). Otherwise the new SASFace object is linked to the neighbours of the SASFace object to assign from.
void BALL::SASFace::setSphere ( const TSphere3< double > &  sphere)

Set the sphere the GraphFace lies on.

Parameters:
spherethe new sphere

Friends And Related Function Documentation

friend class SASEdge [friend]

Definition at line 43 of file SASFace.h.

friend class SASTriangulator [friend]

Definition at line 47 of file SASFace.h.

friend class SASVertex [friend]

Definition at line 44 of file SASFace.h.

friend class SolventAccessibleSurface [friend]

Definition at line 45 of file SASFace.h.

friend class TriangulatedSAS [friend]

Definition at line 46 of file SASFace.h.


Member Data Documentation

std::list<bool> BALL::SASFace::orientation_ [protected]

Definition at line 171 of file SASFace.h.

Definition at line 174 of file SASFace.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines