Detailed Description

A base class for modifiers of ParticlesTemp.

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

See Also: IMP::SingletonPredicate

Implementers should see IMP_SINGLETON_MODIFIER(). Also see SingletonDerivativeModifier.

Definition at line 32 of file SingletonModifier.h.

Public Types
typedef Particle *	Argument

typedef ParticleIndex	IndexArgument

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

virtual void	apply_index (Model *m, ParticleIndex v) const =0

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

virtual void	apply_indexes_moved (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) 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::ParticleOutputs
ModelObjectsTemp	get_outputs (Model *m, const ParticleIndexes &pis) const
	Get the ModelObjects changed 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

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::ParticleInputs
virtual ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
	Overload this method to specify the inputs. More...

Protected Member Functions inherited from IMP::ParticleOutputs
virtual ModelObjectsTemp	do_get_outputs (Model *m, const ParticleIndexes &pis) const =0
	Overload this method to specify the outputs. More...

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

virtual void	do_destroy ()

Member Function Documentation

virtual void IMP::SingletonModifier::apply_index	(	Model *	m,
		ParticleIndex	v
	)		const

pure virtual

Apply the function to a single value

Implemented in IMP::core::TransformationSymmetry, IMP::core::WeightedDerivativesToRefined, IMP::core::CentroidOfRefined, IMP::core::TransformationAndReflectionSymmetry, IMP::core::CoverRefined, IMP::example::ExampleSingletonModifier, IMP::spb::TransformationSymmetry, IMP::core::DerivativesFromRefined, IMP::core::DerivativesToRefined, IMP::core::Transform, IMP::atom::CoverBond, and IMP::spb::NuisanceRangeModifier.

virtual void IMP::SingletonModifier::apply_indexes	(	Model *	m,
		const ParticleIndexes &	o,
		unsigned int	lower_bound,
		unsigned int	upper_bound
	)		const

virtual

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

Reimplemented in IMP::core::TransformationSymmetry, IMP::core::WeightedDerivativesToRefined, IMP::core::CentroidOfRefined, IMP::core::TransformationAndReflectionSymmetry, IMP::core::CoverRefined, IMP::example::ExampleSingletonModifier, IMP::spb::TransformationSymmetry, IMP::core::DerivativesFromRefined, IMP::core::DerivativesToRefined, IMP::core::Transform, IMP::atom::CoverBond, and IMP::spb::NuisanceRangeModifier.

Definition at line 46 of file SingletonModifier.h.

virtual void IMP::SingletonModifier::apply_indexes_moved	(	Model *	m,
		const ParticleIndexes &	o,
		unsigned int	lower_bound,
		unsigned int	upper_bound,
		const ParticleIndexes &	moved_pis,
		const ParticleIndexes &	reset_pis
	)		const

virtual

Apply the function to a collection of ParticlesTemp Information on particles that moved since the last scoring function evaluation is also passed, which may be used to accelerate the computation.

Definition at line 58 of file SingletonModifier.h.

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

SingletonModifier.h

Detailed Description

Public Types

Public Member Functions

Additional Inherited Members

Member Function Documentation