IMP  2.0.0
The Integrative Modeling Platform
PairsOptimizerState.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/PairsOptimizerState.h
3  * \brief Use a PairModifier applied to a ParticlePairsTemp to
4  * maintain an invariant
5  *
6  * WARNING This file was generated from PairsOptimizerState.h
7  * in /tmp/nightly-build-5687/imp-2.0.0/tools/build/container_templates/container
8  * by tools/maintenance/setup_containers.py.
9  *
10  * Copyright 2007-2013 IMP Inventors. All rights reserved.
11  */
12 
13 #ifndef IMPCONTAINER_PAIRS_OPTIMIZER_STATE_H
14 #define IMPCONTAINER_PAIRS_OPTIMIZER_STATE_H
15 
16 #include <IMP/container/container_config.h>
17 #include <IMP/PairContainer.h>
18 #include <IMP/PairModifier.h>
19 #include <IMP/OptimizerState.h>
20 #include <IMP/optimizer_state_macros.h>
21 
22 IMPKERNEL_BEGIN_NAMESPACE
23 // for swig
24 class PairContainer;
25 class PairModifier;
26 IMPKERNEL_END_NAMESPACE
27 
28 IMPCONTAINER_BEGIN_NAMESPACE
29 //! Apply a PairFunction to a PairContainer to maintain an invariant
30 /** \ingroup restraint
31  \see PairOptimizerState
32  */
33 class IMPCONTAINEREXPORT PairsOptimizerState : public OptimizerState
34 {
35  IMP::OwnerPointer<PairModifier> f_;
36  IMP::OwnerPointer<PairContainer> c_;
37 public:
38  /** \param[in] c The Container to hold the elements to process
39  \param[in] gf The PairModifier to apply to all elements.
40  \param[in] name The name to use for this Object
41  */
42  PairsOptimizerState(PairContainerAdaptor c, PairModifier *gf,
43  std::string name="PairsOptimizerState %1%");
44 
45  IMP_OPTIMIZER_STATE(PairsOptimizerState);
46 };
47 
48 IMP_OBJECTS(PairsOptimizerState,PairsOptimizerStates);
49 
50 
51 IMPCONTAINER_END_NAMESPACE
52 
53 #endif /* IMPCONTAINER_PAIRS_OPTIMIZER_STATE_H */