BALL::SurfaceProcessor Class Reference
[Molecular Surface Computation]
#include <BALL/STRUCTURE/surfaceProcessor.h>
Inheritance diagram for BALL::SurfaceProcessor:
Public Types | |
Enums | |
| enum | SurfaceType { SOLVENT_EXCLUDED_SURFACE, SOLVENT_ACCESSIBLE_SURFACE } |
Public Member Functions | |
Constructors and destructor. | |
| SurfaceProcessor () | |
Default constructor. | |
Processor-related methods. | |
| virtual bool | start () |
| virtual bool | finish () |
| virtual Processor::Result | operator() (Atom &atom) |
Accessors. | |
| const Surface & | getSurface () const |
| Surface & | getSurface () |
| void | setProbeRadius (double radius) throw (Exception::OutOfRange) |
| double | getProbeRadius () const |
| void | setDensity (double density) |
| double | getDensity () const |
| std::vector< TSphere3< double > > & | getSpheres () |
| void | setType (SurfaceType type) |
| SurfaceType | getType () const |
Get the surface type to be computed. | |
Protected Attributes | |
| double | radius_offset_ |
| double | vdw_factor_ |
| SurfaceType | surface_type_ |
| Surface | surface_ |
| std::vector< TSphere3< double > > | spheres_ |
| double | density_ |
| double | probe_radius_ |
Detailed Description
Member Enumeration Documentation
Constructor & Destructor Documentation
| BALL::SurfaceProcessor::SurfaceProcessor | ( | ) |
Default constructor.
Member Function Documentation
| virtual bool BALL::SurfaceProcessor::finish | ( | ) | [virtual] |
finish method
Reimplemented from BALL::UnaryProcessor< Atom >.
| double BALL::SurfaceProcessor::getDensity | ( | ) | const [inline] |
| double BALL::SurfaceProcessor::getProbeRadius | ( | ) | const [inline] |
| Surface& BALL::SurfaceProcessor::getSurface | ( | ) | [inline] |
| const Surface& BALL::SurfaceProcessor::getSurface | ( | ) | const [inline] |
| SurfaceType BALL::SurfaceProcessor::getType | ( | ) | const [inline] |
Get the surface type to be computed.
| virtual Processor::Result BALL::SurfaceProcessor::operator() | ( | Atom & | ) | [virtual] |
operator ()
Reimplemented from BALL::UnaryProcessor< Atom >.
| void BALL::SurfaceProcessor::setDensity | ( | double | density | ) | [inline] |
| void BALL::SurfaceProcessor::setProbeRadius | ( | double | radius | ) | throw (Exception::OutOfRange) [inline] |
Sets the radius of the used probe sphere
- Exceptions:
-
Exception::OutOfRange Specifying a radius <= 0 is illegal
| void BALL::SurfaceProcessor::setType | ( | SurfaceType | type | ) | [inline] |
Set the surface type to be computed. Default is SOLVENT_EXCLUDED_SURFACE.
| virtual bool BALL::SurfaceProcessor::start | ( | ) | [virtual] |
start method
Reimplemented from BALL::UnaryProcessor< Atom >.
Member Data Documentation
double BALL::SurfaceProcessor::density_ [protected] |
double BALL::SurfaceProcessor::probe_radius_ [protected] |
double BALL::SurfaceProcessor::radius_offset_ [protected] |
std::vector<TSphere3<double> > BALL::SurfaceProcessor::spheres_ [protected] |
Surface BALL::SurfaceProcessor::surface_ [protected] |
SurfaceType BALL::SurfaceProcessor::surface_type_ [protected] |
double BALL::SurfaceProcessor::vdw_factor_ [protected] |