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.


Member Typedef Documentation

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

Constructor & Destructor Documentation

BALL::SASFace::SASFace ( )

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

OrientationIterator BALL::SASFace::beginOrientation ( )
ConstOrientationIterator BALL::SASFace::beginOrientation ( ) const
ConstOrientationIterator BALL::SASFace::endOrientation ( ) const
OrientationIterator BALL::SASFace::endOrientation ( )
TSphere3<double> BALL::SASFace::getSphere ( ) const

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]
friend class SASTriangulator [friend]
friend class SASVertex [friend]
friend class SolventAccessibleSurface [friend]
friend class TriangulatedSAS [friend]

Member Data Documentation

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