IMP::kernel::SingletonModifier Class Reference

A base class for modifiers of kernel::ParticlesTemp. More...

#include <IMP/kernel/SingletonModifier.h>

Inheritance diagram for IMP::kernel::SingletonModifier:

Detailed Description

A base class for modifiers of kernel::ParticlesTemp.

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

See Also

IMP::SingletonFunctor

Implementors should see IMP_SINGLETON_MODIFIER(). Also see SingletonDerivativeModifier.

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

Public Types
typedef kernel::Particle *	Argument
typedef kernel::ParticleIndex	IndexArgument

Public Member Functions
	SingletonModifier (std::string name="SingletonModifier %1%")
virtual void	apply (kernel::Particle *vt) const
virtual void	apply_index (kernel::Model *m, kernel::ParticleIndex v) const
virtual void	apply_indexes (kernel::Model *m, const kernel::ParticleIndexes &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::SingletonModifier::apply ( kernel::Particle *  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::SingletonModifier::apply_index ( kernel::Model *  m, kernel::ParticleIndex  v  ) const

virtual

Apply the function to a single value

Reimplemented in IMP::core::TransformationSymmetry, IMP::core::CentroidOfRefined, IMP::core::TransformationAndReflectionSymmetry, IMP::core::CoverRefined, IMP::example::ExampleSingletonModifier, IMP::core::Transform, and IMP::atom::CoverBond.

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

virtual

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

Reimplemented in IMP::core::TransformationSymmetry, IMP::core::CentroidOfRefined, IMP::core::TransformationAndReflectionSymmetry, IMP::core::CoverRefined, IMP::example::ExampleSingletonModifier, IMP::core::Transform, and IMP::atom::CoverBond.

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

---

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

• kernel/SingletonModifier.h