IMP::core::TableRefiner Class Reference

---

Detailed Description

A lookup based particle refiner.

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

Examples: analyze convergence, nup84 cg

Inheritance diagram for IMP::core::TableRefiner:

List of all members.

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 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 Particle *	get_refined (Particle *, unsigned int) const
	Get the ith refined particle.
virtual const ParticlesTemp	get_refined (Particle *) const
	Refine the passed particle into a set of particles.
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::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 TableRefiner *	get_from (IMP::base::Object *o)

Additional Inherited Members
typedef internal::IndexingIterator < Accessor >	RefinedIterator

---

Constructor & Destructor Documentation

IMP::core::TableRefiner::TableRefiner

(

)

Initialize it with an empty table.

---

Member Function Documentation

void IMP::core::TableRefiner::add_particle	(	Particle *	p,
		const ParticlesTemp &	ps
	)

Add a mapping to the table.

virtual bool IMP::core::TableRefiner::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::TableRefiner::get_input_containers ( Particle *  ) const

virtual

Return the set of containers used when refining.

Implements IMP::Refiner.

virtual ParticlesTemp IMP::core::TableRefiner::get_input_particles ( Particle *  ) const

virtual

Return the set of particles used when refining particle p.

Implements IMP::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::Refiner.

virtual const ParticlesTemp IMP::core::TableRefiner::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.

virtual Particle* IMP::core::TableRefiner::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.

void IMP::core::TableRefiner::remove_particle

(

Particle *

p

)

Remove a mapping from the table.

void IMP::core::TableRefiner::set_particle	(	Particle *	p,
		const ParticlesTemp &	ps
	)

Set the mapping for a particular particle.

---

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

• TableRefiner.h