IMP logo
IMP Reference Guide  2.15.0
The Integrative Modeling Platform
ExampleSingletonModifier.h
Go to the documentation of this file.
1 /**
2  * \file IMP/example/ExampleSingletonModifier.h
3  * \brief A singleton modifier which wraps an attribute into a
4  * given range.
5  *
6  * Copyright 2007-2021 IMP Inventors. All rights reserved.
7  */
8 
9 #ifndef IMPEXAMPLE_EXAMPLE_SINGLETON_MODIFIER_H
10 #define IMPEXAMPLE_EXAMPLE_SINGLETON_MODIFIER_H
11 
12 #include <IMP/example/example_config.h>
13 #include <IMP/SingletonModifier.h>
15 #include <IMP/singleton_macros.h>
16 
17 IMPEXAMPLE_BEGIN_NAMESPACE
18 
19 //! An example singleton modifier
20 /** A simple singleton modifier which ensures the x,y,z coordinates
21  stay in a box by wrapping them.
22 
23  Such a class could be coupled with an IMP::core::SingletonConstraint
24  or IMP::container::SingletonsConstraint to keep a set of particles
25  in a box.
26 
27  \include range_restriction.py
28 
29  The source code is as follows:
30  \include ExampleSingletonModifier.h
31  \include ExampleSingletonModifier.cpp
32  */
33 class IMPEXAMPLEEXPORT ExampleSingletonModifier : public SingletonModifier {
35 
36  public:
38 
39  // note, Doxygen wants a semicolon at the end of macro lines
40  virtual void apply_index(Model *m, ParticleIndex p) const
43  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
45  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
48 };
49 
50 IMPEXAMPLE_END_NAMESPACE
51 
52 #endif /* IMPEXAMPLE_EXAMPLE_SINGLETON_MODIFIER_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:40
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
#define IMP_SINGLETON_MODIFIER_METHODS(Name)
A bounding box in D dimensions.
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.