IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::pmi1::InternalCoordinatesConstraint Class Reference

An example singleton modifier. More...

#include <IMP/pmi1/InternalCoordinatesConstraint.h>

+ Inheritance diagram for IMP::pmi1::InternalCoordinatesConstraint:

Detailed Description

An example singleton modifier.

A simple singleton modifier which ensures the x,y,z coordinates stay in a box by wrapping them.

Such a class could be coupled with an IMP::core::SingletonConstraint or IMP::container::SingletonsConstraint to keep a set of particles in a box.

The source code is as follows:

Definition at line 31 of file InternalCoordinatesConstraint.h.

Public Member Functions

virtual void apply_index (Model *m, ParticleIndex p) const override
 
virtual void apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const overridefinal
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const override
 Overload this method to specify the inputs. More...
 
virtual ModelObjectsTemp do_get_outputs (Model *m, const ParticleIndexes &pis) const override
 Overload this method to specify the outputs. More...
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
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
 
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)
 

Additional Inherited Members

- Public Types inherited from IMP::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- 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::pmi1::InternalCoordinatesConstraint::apply_index ( Model m,
ParticleIndex  v 
) const
overridevirtual

Apply the function to a single value

Implements IMP::SingletonModifier.

virtual void IMP::pmi1::InternalCoordinatesConstraint::apply_indexes ( Model m,
const ParticleIndexes o,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
finaloverridevirtual

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

Reimplemented from IMP::SingletonModifier.

Definition at line 42 of file InternalCoordinatesConstraint.h.

virtual ModelObjectsTemp IMP::pmi1::InternalCoordinatesConstraint::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
overridevirtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual ModelObjectsTemp IMP::pmi1::InternalCoordinatesConstraint::do_get_outputs ( Model m,
const ParticleIndexes pis 
) const
overridevirtual

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::pmi1::InternalCoordinatesConstraint::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 43 of file InternalCoordinatesConstraint.h.


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