The job of this class is to take a single particle and, if appropriate, return a list of particles.
Implementors should see IMP_REFINER().
Public Member Functions | |
| def | __disown__ |
| virtual bool | get_can_refine (Particle *a) const |
| Return true if this refiner can refine that particle. | |
| virtual unsigned int | get_number_of_refined (Particle *a) const =0 |
| virtual Particle * | get_refined (Particle *a, unsigned int i) const =0 |
| Get the ith refined particle. | |
| virtual const ParticlesTemp | get_refined (Particle *a) const =0 |
| Refine the passed particle into a set of particles. | |
| Refiner (std::string name="Refiner %1%") | |
Iterating through the set of refined particles | |
| Using iterators can be more efficient than using the bulk get_refined(), however it is not necessarily so. | |
| __pad0__:IndexingIterator<Accessor> RefinedIterator | |
| RefinedIterator | refined_begin (Particle *a) const |
| RefinedIterator | refined_end (Particle *a) const |
Package Functions | |
| virtual ContainersTemp | get_input_containers (Particle *) const =0 |
| Return the set of containers used when refining. | |
| virtual ParticlesTemp | get_input_particles (Particle *) const =0 |
| Return the set of particles used when refining particle p. | |
| virtual IMP::VersionInfo | get_version_info () const =0 |
| Get information about the author and version. | |
| virtual void | show (std::ostream &out=std::cout) const |
| Print information about the refiner. | |
Friends | |
| template<class T > | |
| void | IMP::internal::unref (T *) |
| virtual bool IMP::Refiner::get_can_refine | ( | Particle * | a | ) | const [virtual] |
Return true if this refiner can refine that particle.
This should not throw, so be careful what fields are touched.
| virtual unsigned int IMP::Refiner::get_number_of_refined | ( | Particle * | a | ) | const [pure virtual] |
As a precondition can_refine_particle(a) should be true.
Get the ith refined particle.
As a precondition can_refine_particle(a) should be true.
| virtual const ParticlesTemp IMP::Refiner::get_refined | ( | Particle * | a | ) | const [pure virtual] |
Refine the passed particle into a set of particles.
As a precondition can_refine_particle(a) should be true.
| virtual void IMP::Refiner::show | ( | std::ostream & | out = std::cout |
) | const [package, virtual] |
