IMP logo
IMP Reference Guide  2.14.0
The Integrative Modeling Platform
InternalCoordinatesConstraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/pmi/InternalCoordinatesConstraint.h
3  * \brief A modifier that enforce identical internal coordinates for NonRigidMembers.
4  *
5  * Copyright 2007-2020 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPPMI_INTERNAL_COORDINATES_CONSTRAINT_H
9 #define IMPPMI_INTERNAL_COORDINATES_CONSTRAINT_H
10 
11 #include <IMP/pmi/pmi_config.h>
12 #include <IMP/SingletonModifier.h>
13 #include <IMP/singleton_macros.h>
14 
15 IMPPMI_BEGIN_NAMESPACE
16 
17 //! An example singleton modifier
18 /** A simple singleton modifier which ensures the x,y,z coordinates
19  stay in a box by wrapping them.
20 
21  Such a class could be coupled with an IMP::core::SingletonConstraint
22  or IMP::container::SingletonsConstraint to keep a set of particles
23  in a box.
24 
25  The source code is as follows:
26  \include InternalCoordinatesConstraint.h
27  \include InternalCoordinatesConstraint.cpp
28  */
29 class IMPPMIEXPORT InternalCoordinatesConstraint : public SingletonModifier {
30 
31  public:
32  IMPPMI_DEPRECATED_OBJECT_DECL(2.14)
34 
35  // note, Doxygen wants a semicolon at the end of macro lines
36  virtual void apply_index(Model *m, ParticleIndex p) const
39  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
41  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
44 };
45 
46 IMPPMI_END_NAMESPACE
47 
48 #endif /* IMPPMI_INTERNAL_COORDINATES_CONSTRAINT_H */
A base class for modifiers of ParticlesTemp.
A Modifier on ParticlesTemp.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Macros for various classes.
virtual ModelObjectsTemp do_get_outputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the outputs.
A more IMP-like version of the std::vector.
Definition: Vector.h:39
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
#define IMP_SINGLETON_MODIFIER_METHODS(Name)
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
virtual void apply_index(Model *m, ParticleIndex v) const =0
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.