IMP  2.0.0
The Integrative Modeling Platform
SingletonRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/SingletonRestraint.h
3  * \brief Apply a SingletonScore to a Singleton.
4  *
5  * WARNING This file was generated from SingletonRestraint.h
6  * in /tmp/nightly-build-5687/imp-2.0.0/tools/build/container_templates/core
7  * by tools/maintenance/setup_containers.py.
8  *
9  * Copyright 2007-2013 IMP Inventors. All rights reserved.
10  *
11  */
12 
13 #ifndef IMPCORE_SINGLETON_RESTRAINT_H
14 #define IMPCORE_SINGLETON_RESTRAINT_H
15 
16 #include <IMP/core/core_config.h>
17 
18 #include <IMP/internal/TupleRestraint.h>
19 #include <IMP/SingletonScore.h>
20 #include <IMP/restraint_macros.h>
21 
22 #include <iostream>
23 
24 IMPCORE_BEGIN_NAMESPACE
25 
26 //! Applies a SingletonScore to a Singleton.
27 /** This restraint stores a Singleton.
28  \see SingletonRestraint
29  */
30 class SingletonRestraint :
31 #if defined(SWIG) || defined(IMP_DOXYGEN)
32  public Restraint
33 #else
34  public IMP::kernel::internal::TupleRestraint<SingletonScore>
35 #endif
36 {
37 public:
38  //! Create the restraint.
39  /** This function takes the function to apply to the
40  stored Singleton and the Singleton.
41  */
42  SingletonRestraint(SingletonScore *ss,
43  Particle* vt,
44  std::string name="SingletonRestraint %1%"):
45  IMP::kernel::internal::TupleRestraint<SingletonScore>(ss,
46  IMP::kernel::internal::get_model(vt),
47  IMP::kernel::internal::get_index(vt),
48  name)
49  {}
50 
51 #if defined(SWIG) || defined(IMP_DOXYGEN)
52  protected:
53  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
54  IMP::ModelObjectsTemp do_get_inputs() const;
55  IMP_OBJECT_METHODS(SingletonRestraint)
56 #endif
57 };
58 
59 IMPCORE_END_NAMESPACE
60 
61 #endif /* IMPCORE_SINGLETON_RESTRAINT_H */