A base class for modifiers of ParticlePairsTemp. More...

#include <IMP/kernel/PairModifier.h>

Inheritance diagram for IMP::kernel::PairModifier:

Public Types
typedef ParticlePair	Argument

typedef ParticleIndexPair	IndexArgument

Public Member Functions
	PairModifier (std::string name="PairModifier %1%")

virtual void	apply (const ParticlePair &) const =0

virtual void	apply_index (Model *m, const ParticleIndexPair &v) const

virtual void	apply_indexes (Model *m, const ParticleIndexPairs &o, unsigned int lower_bound, unsigned int upper_bound) const

ContainersTemp	get_input_containers (Particle *p) const

ParticlesTemp	get_input_particles (Particle *p) const

ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const

ContainersTemp	get_output_containers (Particle *p) const

ParticlesTemp	get_output_particles (Particle *p) const

ModelObjectsTemp	get_outputs (Model *m, const ParticleIndexes &pis) const

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

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. 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)

Protected Member Functions
virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const =0

virtual ModelObjectsTemp	do_get_outputs (Model *m, const ParticleIndexes &pis) const =0

Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Related Functions
(Note that these are not member functions.)
typedef IMP::base::Vector < IMP::base::WeakPointer < PairModifier > >	PairModifiersTemp

Related Functions inherited from IMP::base::Object
typedef IMP::base::Vector < IMP::base::WeakPointer < Object > >	ObjectsTemp

Detailed Description

The primary function of such a class is to change the passed particles.

See Also: IMP::PairFunctor

Implementors should see IMP_PAIR_MODIFIER(). Also see PairDerivativeModifier.

Definition at line 33 of file kernel/PairModifier.h.

Member Function Documentation

virtual void IMP::kernel::PairModifier::apply ( const ParticlePair & ) const

pure virtual

Apply the function to a single value

virtual void IMP::kernel::PairModifier::apply_index	(	Model *	m,
		const ParticleIndexPair &	v
	)		const

virtual

Apply the function to a single value

Definition at line 44 of file kernel/PairModifier.h.

virtual void IMP::kernel::PairModifier::apply_indexes	(	Model *	m,
		const ParticleIndexPairs &	o,
		unsigned int	lower_bound,
		unsigned int	upper_bound
	)		const

virtual

Apply the function to a collection of ParticlePairsTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Definition at line 51 of file kernel/PairModifier.h.

virtual ModelObjectsTemp IMP::kernel::PairModifier::do_get_inputs	(	Model *	m,
		const ParticleIndexes &	pis
	)		const

protectedpure virtual

Override if this reads other objects during evaluate.

virtual ModelObjectsTemp IMP::kernel::PairModifier::do_get_outputs	(	Model *	m,
		const ParticleIndexes &	pis
	)		const

protectedpure virtual

Override if this reads other objects during evaluate.

ContainersTemp IMP::kernel::PairModifier::get_input_containers ( Particle * p ) const

Get the set of input containers when this modifier is applied to the arguments.

Deprecated:: use get_outputs() instead.

ParticlesTemp IMP::kernel::PairModifier::get_input_particles ( Particle * p ) const

Get the set of particles read when applied to the arguments.

Deprecated:: use get_inputs() instead.

ModelObjectsTemp IMP::kernel::PairModifier::get_inputs	(	Model *	m,
		const ParticleIndexes &	pis
	)		const

Get all the ModelObject objects that are read when the referenced particles are passed in.

ContainersTemp IMP::kernel::PairModifier::get_output_containers ( Particle * p ) const

Get the set of output containers when this modifier is applied to the arguments.

Deprecated:: use get_outputs() instead.

ParticlesTemp IMP::kernel::PairModifier::get_output_particles ( Particle * p ) const

Get the set of particles read when applied to the arguments.

Deprecated:: use get_outputs() instead.

ModelObjectsTemp IMP::kernel::PairModifier::get_outputs	(	Model *	m,
		const ParticleIndexes &	pis
	)		const

Get all the ModelObject objects that are read when the referenced particles are passed in.

Friends And Related Function Documentation

typedef IMP::base::Vector<IMP::base::WeakPointer< PairModifier > > PairModifiersTemp

Definition at line 115 of file kernel/base_types.h.

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

Public Types

Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Member Function Documentation

Friends And Related Function Documentation