IMP logo

IMP::SingletonModifier Class Reference


Detailed Description

A base class for modifiers of Particles.

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

A given SingletonModifier may only work when passed a DerivativeAccumulator or when not passed one.

See also:
IMP::SingletonFunctor
Implementors should see IMP_SINGLETON_MODIFIER() and IMP_SINGLETON_MODIFIER_DA().
Inheritance diagram for IMP::SingletonModifier:

Inheritance graph
[legend]

Public Member Functions

def __disown__
virtual void apply (const ParticlesTemp &o, DerivativeAccumulator &da) const
virtual void apply (const ParticlesTemp &o) const
virtual void apply (Particle *vt) const
virtual void apply (Particle *vt, DerivativeAccumulator &da) const
virtual ContainersTemp get_input_containers (Particle *vt) const =0
virtual ParticlesTemp get_input_particles (Particle *vt) const =0
virtual ParticlesList get_interacting_particles (Particle *vt) const =0
virtual ContainersTemp get_output_containers (Particle *vt) const =0
virtual ParticlesTemp get_output_particles (Particle *vt) const =0
 SingletonModifier (std::string name="SingletonModifier %1%")

Member Function Documentation

virtual void IMP::SingletonModifier::apply ( const ParticlesTemp o,
DerivativeAccumulator da 
) const [virtual]

Apply the function to a collection of Particles

virtual void IMP::SingletonModifier::apply ( const ParticlesTemp o  )  const [virtual]

Apply the function to a collection of Particles

virtual void IMP::SingletonModifier::apply ( Particle vt  )  const [virtual]

Apply the function to a single value

virtual void IMP::SingletonModifier::apply ( Particle vt,
DerivativeAccumulator da 
) const [virtual]

Apply the function to a single value

virtual ContainersTemp IMP::SingletonModifier::get_input_containers ( Particle vt  )  const [pure virtual]

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

virtual ParticlesTemp IMP::SingletonModifier::get_input_particles ( Particle vt  )  const [pure virtual]

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

virtual ParticlesList IMP::SingletonModifier::get_interacting_particles ( Particle vt  )  const [pure virtual]

Get the set of interactions induced by applying to the argument.

virtual ContainersTemp IMP::SingletonModifier::get_output_containers ( Particle vt  )  const [pure virtual]

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

virtual ParticlesTemp IMP::SingletonModifier::get_output_particles ( Particle vt  )  const [pure virtual]

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


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

Generated on Mon Mar 8 23:08:45 2010 for IMP by doxygen 1.5.8