SingletonsRestraint.h

Go to the documentation of this file.

/**
 *  \file SingletonsRestraint.h
 *  \brief Apply a SingletonScore to each Singleton in a list.
 *
 *  This file is generated by a script (core/tools/make-container).
 *  Do not edit directly.
 *
 *  Copyright 2007-2012 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCONTAINER_SINGLETONS_RESTRAINT_H
#define IMPCONTAINER_SINGLETONS_RESTRAINT_H

#include "container_config.h"

#include <IMP/internal/InternalSingletonsRestraint.h>

#include <iostream>

IMPCONTAINER_BEGIN_NAMESPACE

//! Applies a SingletonScore to each Singleton in a list.
/** This restraint stores the used particles in a ParticlesTemp.
    The container used can be set so that the list can be shared
    with other containers (or a nonbonded list can be used). By default
    a ListSingletonContainer is used and the
    {add_, set_, clear_}particle{s} methodas can be used.

    Examples using various multiplicity containers:
    \pythonexample{restrain_in_sphere}
    \pythonexample{nonbonded_interactions}

    \see SingletonRestraint
 */
class IMPCONTAINEREXPORT SingletonsRestraint :
#if defined(SWIG) || defined(IMP_DOXYGEN)
public Restraint
#else
public IMP::internal::InternalSingletonsRestraint
#endif
{
  typedef IMP::internal::InternalSingletonsRestraint P;
public:

 //! Create the restraint with a shared container
  /** \param[in] ss The function to apply to each particle.
      \param[in] pc The container containing the stored particles. This
      container is not copied.
      \param[in] name The object name
   */
  SingletonsRestraint(SingletonScore *ss,
                      SingletonContainerInput pc,
                      std::string name="SingletonsRestraint %1%");

#if defined(IMP_DOXYGEN) || defined(SWIG)
  IMP_RESTRAINT(SingletonsRestraint);

  //! Get the container used to store Particles
  ParticlesTemp get_arguments() const;

  SingletonContainer* get_container() const;

  SingletonScore* get_score() const;
#else
  IMP_OBJECT(SingletonsRestraint);
#endif
};

IMP_OBJECTS(SingletonsRestraint,SingletonsRestraints);

IMPCONTAINER_END_NAMESPACE

#endif  /* IMPCONTAINER_SINGLETONS_RESTRAINT_H */