IMP  2.3.1
The Integrative Modeling Platform
IMP::core::FixedRefiner Class Reference

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

#include <IMP/core/FixedRefiner.h>

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

Detailed Description

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

Definition at line 22 of file FixedRefiner.h.

Public Member Functions

 FixedRefiner (const kernel::ParticlesTemp &ps)
 Store the set of particles. More...
 
 FixedRefiner (Model *m, const kernel::ParticleIndexes &pis)
 Store the set of particle indexes from passed model. More...
 
virtual kernel::ModelObjectsTemp do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pis) const
 
virtual bool get_can_refine (kernel::Particle *) const
 Return true if this refiner can refine that particle. More...
 
virtual const kernel::ParticlesTemp get_refined (kernel::Particle *p) const
 Returns the fixed set of particles. More...
 
virtual kernel::ParticleIndexes get_refined_indexes (Model *m, ParticleIndex) const
 Return the indexes of the particles returned by get_refined() More...
 
virtual ParticleIndexes const & get_refined_indexes_by_ref (Model *m, ParticleIndex pi) const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::kernel::Refiner
 Refiner (std::string name="Refiner %1%", bool is_by_ref=false)
 
bool get_is_by_ref_supported ()
 
virtual unsigned int get_number_of_refined (Particle *a) const
 
virtual Particleget_refined (Particle *a, unsigned int i) const
 Get the ith refined particle. More...
 
virtual ParticleIndexes get_refined_indexes (Model *m, ParticleIndex pi) const
 Return the indexes of the particles returned by get_refined() More...
 
virtual ParticleIndexes const & get_refined_indexes_by_ref (Model *m, ParticleIndex pi) const
 Return the indexes of the particles returned by get_refined() More...
 
RefinedIterator refined_begin (Particle *a) const
 
RefinedIterator refined_end (Particle *a) const
 
- Public Member Functions inherited from IMP::kernel::ParticleInputs
virtual ContainersTemp get_input_containers (Particle *p) const
 
virtual ParticlesTemp get_input_particles (Particle *p) const
 
ModelObjectsTemp get_inputs (kernel::Model *m, const ParticleIndexes &pis) const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
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::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

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

Store the set of particles.

IMP::core::FixedRefiner::FixedRefiner ( Model m,
const kernel::ParticleIndexes pis 
)

Store the set of particle indexes from passed model.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::core::FixedRefiner::do_get_inputs ( kernel::Model m,
const kernel::ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Reimplemented from IMP::kernel::ParticleInputs.

virtual bool IMP::core::FixedRefiner::get_can_refine ( kernel::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::kernel::Refiner.

Definition at line 33 of file FixedRefiner.h.

virtual const kernel::ParticlesTemp IMP::core::FixedRefiner::get_refined ( kernel::Particle p) const
virtual

Returns the fixed set of particles.

Returns the fixed set of particles, regardless of passed particle

Parameters
pcoarse particle to be refined (ignored for FixedRefiner)

Implements IMP::kernel::Refiner.

virtual kernel::ParticleIndexes IMP::core::FixedRefiner::get_refined_indexes ( Model m,
ParticleIndex   
) const
virtual

Return the indexes of the particles returned by get_refined()

Return the indexes of the particles returned by get_refined() for particle pi in model m.

Parameters
picoarse particle to be refined
Note
For FixedRefiner, this is a faster operation than get_refined()
It is assumed that the refined particles are also in model m.

Definition at line 57 of file FixedRefiner.h.

virtual ::IMP::base::VersionInfo IMP::core::FixedRefiner::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 81 of file FixedRefiner.h.


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