Detailed Description

A base class for modifiers of kernel::ParticlePairsTemp.

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

Implementors should see IMP_PAIR_MODIFIER(). Also see PairDerivativeModifier.

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

Public Types
typedef kernel::ParticlePair	Argument

typedef kernel::ParticleIndexPair	IndexArgument

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

virtual void	apply (const kernel::ParticlePair &vt) const

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

virtual void	apply_indexes (kernel::Model *m, const kernel::ParticleIndexPairs &o, unsigned int lower_bound, unsigned int upper_bound) 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::kernel::ParticleOutputs
virtual ContainersTemp	get_output_containers (Particle *p) const

virtual ParticlesTemp	get_output_particles (Particle *p) const

ModelObjectsTemp	get_outputs (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

virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...

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)

virtual std::string	get_type_name () const

Additional Inherited Members
Protected Member Functions inherited from IMP::kernel::ParticleInputs
virtual ModelObjectsTemp	do_get_inputs (kernel::Model *m, const ParticleIndexes &pis) const

Protected Member Functions inherited from IMP::kernel::ParticleOutputs
virtual ModelObjectsTemp	do_get_outputs (kernel::Model *m, const ParticleIndexes &pis) const

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

virtual void	do_destroy ()

Member Function Documentation

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

virtual

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. use the index version instead

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

virtual

Apply the function to a single value

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

virtual

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

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

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