Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

VIEW::AddSurfaceModel Class Reference
[Model Processors]

AddSurfaceModel class. More...

#include <surfaceModel.h>

Inheritance diagram for VIEW::AddSurfaceModel:

VIEW::ModelProcessor UnaryProcessor< Composite > PropertyManager UnaryFunctor< Composite, Processor::Result > List of all members.

debuggers and diagnostics

virtual void dump (std::ostream &s=std::cout, Size depth=0) const throw ()
 Internal value dump.
void setProbeRadius (float radius) throw ()
float getProbeRadius () const throw ()
virtual bool createGeometricObjects () throw ()
 Method to create geometric objects.

Public Member Functions

Constructors and Destructor
 AddSurfaceModel () throw ()
 Default Constructor.
 AddSurfaceModel (const AddSurfaceModel &add_surface_model) throw ()
 Copy constructor.
virtual ~AddSurfaceModel () throw ()
 Destructor.
virtual void clear () throw ()
 Explicit default initialization.
virtual void clearComposites () throw ()
 Needed in derived classes, which store references to the Composite instances they worked on.
Accessors
SurfaceProcessor::SurfaceType getType () const
 Return the surface type (SES/SAS).
void setType (SurfaceProcessor::SurfaceType type)
 Set the surface type (SES/SAS).
Processor specific methods
virtual Processor::Result operator() (Composite &composite)
 Operator method.

Detailed Description

AddSurfaceModel class.

The class AddSurfaceModel is a model processor that creates a surface model of the given Composite object. A Mesh object is created and filled with the method SurfaceProcessor::getSurface. The surface can be either a solvent excluded surface (SES, default) or the solvent accesible surface (SAS). See SurfaceProcessor for details.

See also:
Mesh

SurfaceProcessor


Member Function Documentation

virtual void VIEW::AddSurfaceModel::clear  )  throw () [virtual]
 

Explicit default initialization.

Calls ModelProcessor::clear.

Reimplemented from VIEW::ModelProcessor.

virtual void VIEW::AddSurfaceModel::clearComposites  )  throw () [virtual]
 

Needed in derived classes, which store references to the Composite instances they worked on.

Here only needed for a common interface and therefore empty.

Reimplemented from VIEW::ModelProcessor.

virtual bool VIEW::AddSurfaceModel::createGeometricObjects  )  throw () [virtual]
 

Method to create geometric objects.

This method is called in Representation::update() after all operator() was called for all Composites. To be overloaded in derived classes

Reimplemented from VIEW::ModelProcessor.

virtual void VIEW::AddSurfaceModel::dump std::ostream &  s = std::cout,
Size  depth = 0
const throw () [virtual]
 

Internal value dump.

Dump the current state to the output ostream with a given dumping depth. Calls ModelProcessor::dump.

Parameters:
s output stream where to output the state
depth the dumping depth

Reimplemented from VIEW::ModelProcessor.

virtual Processor::Result VIEW::AddSurfaceModel::operator() Composite composite  )  [virtual]
 

Operator method.

This method stores all Composite objects. In the finish() method for all stored start composite a Mesh object will be created. The resulting Representation is named after the first processed Composite.

Parameters:
composite the Composite object that will be processed
Returns:
Processor::Result the result

Reimplemented from UnaryProcessor< Composite >.