IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
version 2.16.0
SingletonsOptimizerState.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/container_templates/container/ClassnamesOptimizerState.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/SingletonsOptimizerState.h
7  * \brief Use a SingletonModifier applied to a ParticlesTemp to
8  * maintain an invariant
9  *
10  * Copyright 2007-2021 IMP Inventors. All rights reserved.
11  */
12 
13 #ifndef IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H
14 #define IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H
15 
16 #include <IMP/container/container_config.h>
17 #include <IMP/SingletonContainer.h>
18 #include <IMP/SingletonModifier.h>
19 #include <IMP/OptimizerState.h>
20 #include <IMP/Pointer.h>
21 
22 IMPKERNEL_BEGIN_NAMESPACE
23 // for swig
24 class SingletonContainer;
25 class SingletonModifier;
26 IMPKERNEL_END_NAMESPACE
27 
28 IMPCONTAINER_BEGIN_NAMESPACE
29 //! Apply a SingletonFunction to a SingletonContainer to maintain an invariant
30 /** \ingroup restraint
31  \see SingletonOptimizerState
32  */
33 class IMPCONTAINEREXPORT SingletonsOptimizerState : public OptimizerState {
34  IMP::PointerMember<SingletonModifier> f_;
35  IMP::PointerMember<SingletonContainer> c_;
36 
37  public:
38  /** \param[in] c The Container to hold the elements to process
39  \param[in] gf The SingletonModifier to apply to all elements.
40  \param[in] name The name to use for this Object
41  */
42  SingletonsOptimizerState(SingletonContainerAdaptor c, SingletonModifier *gf,
43  std::string name = "SingletonsOptimizerState %1%");
44 
45  virtual void update() IMP_OVERRIDE;
46  IMP_OBJECT_METHODS(SingletonsOptimizerState);
47 };
48 
49 IMP_OBJECTS(SingletonsOptimizerState, SingletonsOptimizerStates);
50 
51 IMPCONTAINER_END_NAMESPACE
52 
53 #endif /* IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H */
IMP::SingletonModifier
A base class for modifiers of ParticlesTemp.
Definition: SingletonModifier.h:32
SingletonModifier.h
A Modifier on ParticlesTemp.
SingletonContainer.h
A container for Singletons.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::Vector
A more IMP-like version of the std::vector.
Definition: Vector.h:40
IMP::PointerMember
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:146
IMP_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
Pointer.h
A nullptr-initialized pointer to an IMP Object.
IMP::OptimizerState
Shared optimizer state that is invoked upon commitment of new coordinates.
Definition: OptimizerState.h:43
OptimizerState.h
Shared optimizer state.
IMP::container::SingletonsOptimizerState
Apply a SingletonFunction to a SingletonContainer to maintain an invariant.
Definition: SingletonsOptimizerState.h:33
IMP::OptimizerState::update
virtual void update()
Called when the Optimizer accepts a new conformation.
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78