IMP logo
Public Types | Public Member Functions
IMP::QuadModifier Class Reference

Detailed Description

A base class for modifiers of ParticleQuadsTemp.

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

See also:
IMP::QuadFunctor

Implementors should see IMP_QUAD_MODIFIER(). Also see QuadDerivativeModifier.

+ Inheritance diagram for IMP::QuadModifier:

List of all members.

Public Types

typedef ParticleQuad Argument
typedef ParticleIndexQuad IndexArgument

Public Member Functions

 QuadModifier (std::string name="QuadModifier %1%")
virtual void apply (const ParticleQuad &) const =0
virtual void apply_index (Model *m, const ParticleIndexQuad &v) const
virtual void apply_indexes (Model *m, const ParticleIndexQuads &o) const
virtual ContainersTemp get_input_containers (Particle *p) const =0
virtual ParticlesTemp get_input_particles (Particle *p) const =0
virtual ContainersTemp get_output_containers (Particle *p) const =0
virtual ParticlesTemp get_output_particles (Particle *p) const =0
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
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.
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)

Additional Inherited Members

- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)

Member Function Documentation

virtual void IMP::QuadModifier::apply ( const ParticleQuad &  ) const
pure virtual

Apply the function to a single value

virtual void IMP::QuadModifier::apply_index ( Model m,
const ParticleIndexQuad &  v 
) const
virtual

Apply the function to a single value

virtual void IMP::QuadModifier::apply_indexes ( Model m,
const ParticleIndexQuads &  o 
) const
virtual

Apply the function to a collection of ParticleQuadsTemp

virtual ContainersTemp IMP::QuadModifier::get_input_containers ( Particle p) const
pure virtual

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

virtual ParticlesTemp IMP::QuadModifier::get_input_particles ( Particle p) const
pure virtual

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

virtual ContainersTemp IMP::QuadModifier::get_output_containers ( Particle p) const
pure virtual

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

virtual ParticlesTemp IMP::QuadModifier::get_output_particles ( Particle p) const
pure virtual

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


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

Generated on Tue May 22 2012 23:33:24 for IMP by doxygen 1.8.1