LOOS 4.1.0
The Lightweight Object Oriented Structural analysis library/toolkit
Loading...
Searching...
No Matches
Public Member Functions | List of all members
loos::DensityTools::WaterFilterDecorator Class Reference

Decorator base class for "decorating" the core water filters... More...

#include <internal-water-filter.hpp>

Inheritance diagram for loos::DensityTools::WaterFilterDecorator:
Inheritance graph
[legend]
Collaboration diagram for loos::DensityTools::WaterFilterDecorator:
Collaboration graph
[legend]

Public Member Functions

 WaterFilterDecorator (WaterFilterBase *p)
 
virtual std::string name (void) const
 Just states the name of the filter/picker.
 
virtual double volume (void)
 Calculate the volume of the region we can pick waters from...
 
virtual std::vector< int > filter (const loos::AtomicGroup &solv, const loos::AtomicGroup &prot)
 Given a molecule and a set of waters, pick which waters are inside.
 
virtual std::vector< loos::GCoordboundingBox (const loos::AtomicGroup &prot)
 Calculate the appropriate bounding box (given the molecule)
 

Additional Inherited Members

- Protected Attributes inherited from loos::DensityTools::WaterFilterBase
std::vector< loos::GCoordbdd_
 

Detailed Description

Decorator base class for "decorating" the core water filters...

Member Function Documentation

◆ boundingBox()

virtual std::vector< loos::GCoord > loos::DensityTools::WaterFilterDecorator::boundingBox ( const loos::AtomicGroup & )
inlinevirtual

Calculate the appropriate bounding box (given the molecule)

Implements loos::DensityTools::WaterFilterBase.

Reimplemented in loos::DensityTools::ZClippedWaterFilter, and loos::DensityTools::BulkedWaterFilter.

◆ filter()

virtual std::vector< int > loos::DensityTools::WaterFilterDecorator::filter ( const loos::AtomicGroup & ,
const loos::AtomicGroup &  )
inlinevirtual

Given a molecule and a set of waters, pick which waters are inside.

The result is a map of which waters are inside (1 = inside, 0 = not)

Implements loos::DensityTools::WaterFilterBase.

Reimplemented in loos::DensityTools::ZClippedWaterFilter, and loos::DensityTools::BulkedWaterFilter.

◆ name()

virtual std::string loos::DensityTools::WaterFilterDecorator::name ( void ) const
inlinevirtual

Just states the name of the filter/picker.

Implements loos::DensityTools::WaterFilterBase.

Reimplemented in loos::DensityTools::ZClippedWaterFilter, and loos::DensityTools::BulkedWaterFilter.

◆ volume()

virtual double loos::DensityTools::WaterFilterDecorator::volume ( void )
inlinevirtual

Calculate the volume of the region we can pick waters from...

Implements loos::DensityTools::WaterFilterBase.

Reimplemented in loos::DensityTools::ZClippedWaterFilter, and loos::DensityTools::BulkedWaterFilter.


The documentation for this class was generated from the following file: