IMP  2.0.1
The Integrative Modeling Platform
IMP::core::TableRefiner Class Reference

A lookup based particle refiner. More...

#include <IMP/core/TableRefiner.h>

+ Inheritance diagram for IMP::core::TableRefiner:

Public Member Functions

 TableRefiner ()
 Initialize it with an empty table.
 
void add_particle (Particle *p, const ParticlesTemp &ps)
 Add a mapping to the table.
 
virtual void do_show (std::ostream &out) const
 
virtual bool get_can_refine (Particle *) const
 Return true if this refiner can refine that particle. More...
 
virtual unsigned int get_number_of_refined (Particle *) const
 
virtual Particleget_refined (Particle *, unsigned int) const
 Get the ith refined particle. More...
 
virtual const ParticlesTemp get_refined (Particle *) const
 Refine the passed particle into a set of particles. More...
 
void remove_particle (Particle *p)
 Remove a mapping from the table.
 
void set_particle (Particle *p, const ParticlesTemp &ps)
 Set the mapping for a particular particle.
 
- Public Member Functions inherited from IMP::kernel::Refiner
 Refiner (std::string name="Refiner %1%")
 
ContainersTemp get_input_containers (Particle *p) const
 
ParticlesTemp get_input_particles (Particle *p) const
 
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 
RefinedIterator refined_begin (Particle *a) const
 
RefinedIterator refined_end (Particle *a) const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Public Types inherited from IMP::kernel::Refiner
typedef
internal::IndexingIterator
< Accessor > 
RefinedIterator
 
- Protected Member Functions inherited from IMP::kernel::Refiner
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
 

Detailed Description

Each particle is refined by returning the list of particles stored for it in a table.

Definition at line 22 of file TableRefiner.h.

Member Function Documentation

virtual bool IMP::core::TableRefiner::get_can_refine ( Particle ) const
virtual

This should not throw, so be careful what fields are touched.

Reimplemented from IMP::kernel::Refiner.

virtual unsigned int IMP::core::TableRefiner::get_number_of_refined ( Particle a) const
virtual

As a precondition can_refine_particle(a) should be true.

Implements IMP::kernel::Refiner.

virtual const ParticlesTemp IMP::core::TableRefiner::get_refined ( Particle a) const
virtual

As a precondition can_refine_particle(a) should be true.

Implements IMP::kernel::Refiner.

virtual Particle* IMP::core::TableRefiner::get_refined ( Particle a,
unsigned  i 
) const
virtual

As a precondition can_refine_particle(a) should be true.

Implements IMP::kernel::Refiner.


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