SingletonsOptimizerState.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-469/imp-2.23.0/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-469/imp-2.23.0/tools/build/container_templates/container/ClassnamesOptimizerState.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/container/SingletonsOptimizerState.h
 *  \brief Use a SingletonModifier applied to a ParticlesTemp to
 *  maintain an invariant
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H
#define IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H

#include <IMP/container/container_config.h>
#include <IMP/SingletonContainer.h>
#include <IMP/SingletonModifier.h>
#include <IMP/OptimizerState.h>
#include <IMP/Pointer.h>

IMPKERNEL_BEGIN_NAMESPACE
// for swig
class SingletonContainer;
class SingletonModifier;
IMPKERNEL_END_NAMESPACE

IMPCONTAINER_BEGIN_NAMESPACE
//! Apply a SingletonFunction to a SingletonContainer to maintain an invariant
/** \ingroup restraint
    \see SingletonOptimizerState
 */
class IMPCONTAINEREXPORT SingletonsOptimizerState : public OptimizerState {
  IMP::PointerMember<SingletonModifier> f_;
  IMP::PointerMember<SingletonContainer> c_;

 public:
  /** \param[in] c The Container to hold the elements to process
      \param[in] gf The SingletonModifier to apply to all elements.
      \param[in] name The name to use for this Object
   */
  SingletonsOptimizerState(SingletonContainerAdaptor c, SingletonModifier *gf,
                           std::string name = "SingletonsOptimizerState %1%");

  virtual void do_update(unsigned int call) override;
  IMP_OBJECT_METHODS(SingletonsOptimizerState);
};

IMP_OBJECTS(SingletonsOptimizerState, SingletonsOptimizerStates);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_SINGLETONS_OPTIMIZER_STATE_H */