IMP logo
Public Member Functions | Static Public Member Functions
IMP::core::FixedRefiner Class Reference

Detailed Description

The refiner can refine any particle by returning a fixed set.

+ Inheritance diagram for IMP::core::FixedRefiner:

List of all members.

Public Member Functions

 FixedRefiner (const ParticlesTemp &ps)
 Store the set of particles.
virtual bool get_can_refine (Particle *) const
 Return true if this refiner can refine that particle.
virtual ContainersTemp get_input_containers (Particle *p) const
 Return the set of containers used when refining.
virtual ParticlesTemp get_input_particles (Particle *p) const
 Return the set of particles used when refining particle p.
virtual unsigned int get_number_of_refined (Particle *) const
virtual const ParticlesTemp get_refined (Particle *) const
 Refine the passed particle into a set of particles.
virtual Particleget_refined (Particle *, unsigned int) const
 Get the ith refined particle.
- Public Member Functions inherited from IMP::Refiner
 Refiner (std::string name="Refiner %1%")
RefinedIterator refined_begin (Particle *a) const
RefinedIterator refined_end (Particle *a) const
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
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.
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)

Static Public Member Functions

static FixedRefinerget_from (IMP::base::Object *o)

Additional Inherited Members

typedef
internal::IndexingIterator
< Accessor
RefinedIterator

Constructor & Destructor Documentation

IMP::core::FixedRefiner::FixedRefiner ( const ParticlesTemp ps)

Store the set of particles.


Member Function Documentation

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

Return true if this refiner can refine that particle.

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

Reimplemented from IMP::Refiner.

virtual ContainersTemp IMP::core::FixedRefiner::get_input_containers ( Particle ) const
virtual

Return the set of containers used when refining.

Implements IMP::Refiner.

virtual ParticlesTemp IMP::core::FixedRefiner::get_input_particles ( Particle ) const
virtual

Return the set of particles used when refining particle p.

Implements IMP::Refiner.

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

As a precondition can_refine_particle(a) should be true.

Implements IMP::Refiner.

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

Get the ith refined particle.

As a precondition can_refine_particle(a) should be true.

Implements IMP::Refiner.

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

Refine the passed particle into a set of particles.

As a precondition can_refine_particle(a) should be true.

Implements IMP::Refiner.


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

Generated on Tue May 22 2012 23:33:30 for IMP by doxygen 1.8.1