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 ParticlesTemp &ps)
	Store the set of particles. More...
	FixedRefiner (Model *m, const ParticleIndexes &pis)
	Store the set of particle indexes from passed model. More...
virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const
	Overload this method to specify the inputs. More...
virtual bool	get_can_refine (Particle *) const
	Return true if this refiner can refine that particle. More...
virtual const ParticlesTemp	get_refined (Particle *p) const
	Returns the fixed set of particles. More...
virtual ParticleIndexes	get_refined_indexes (Model *m, ParticleIndex) const
	Returns the fixed set of particles, as indexes. 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...
virtual std::string	get_type_name () const
virtual ::IMP::VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...
Public Member Functions inherited from IMP::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 Particle *	get_refined (Particle *a, unsigned int i) const
	Get the ith refined particle. More...
RefinedIterator	refined_begin (Particle *a) const
RefinedIterator	refined_end (Particle *a) const
Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const
	Get the ModelObjects read when the given list of particles is used. More...
Public Member Functions inherited from IMP::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::Refiner
typedef internal::IndexingIterator < Accessor >	RefinedIterator
Protected Member Functions inherited from IMP::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 ParticlesTemp &

ps

)

Store the set of particles.

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

Store the set of particle indexes from passed model.

Member Function Documentation

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

virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

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.

Definition at line 33 of file FixedRefiner.h.

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

virtual

Returns the fixed set of particles.

Note

the passed Particle is ignored.

Implements IMP::Refiner.

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

virtual

Returns the fixed set of particles, as indexes.

Note

the passed ParticleIndex is ignored.

For FixedRefiner, this is a faster operation than get_refined()

It is assumed that the refined particles are also in model m.

Reimplemented from IMP::Refiner.

Definition at line 52 of file FixedRefiner.h.

virtual ParticleIndexes const& IMP::core::FixedRefiner::get_refined_indexes_by_ref ( Model *  m, ParticleIndex  pi  ) 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 by reference (possibly faster).

Parameters

m,pi	model and particle index of coarse particle to be refined

Note

assumes that get_is_by_ref() is true.

assumes that the refined particles are also in model m

Reimplemented from IMP::Refiner.

Definition at line 61 of file FixedRefiner.h.

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

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 76 of file FixedRefiner.h.

---

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

• FixedRefiner.h