DynamicListSingletonContainer.h

Go to the documentation of this file.

/**
 *  \file IMP/container/DynamicListSingletonContainer.h
 *  \brief Store a list of kernel::ParticlesTemp
 *
 *  WARNING This file was generated from DynamicListSingletonContainer.h
 *  in /tmp/nightly-build-90828/imp-2.2.1/tools/build/container_templates/container
 *  by tools/maintenance/setup_containers.py.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H
#define IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H

#include <IMP/container/container_config.h>
#include <IMP/base/object_macros.h>
#include <IMP/kernel/internal/DynamicListContainer.h>

IMPCONTAINER_BEGIN_NAMESPACE

//! Store a kernel::ParticleIndexes
/** In contrast to ListSingletonContainer, this list is designed to act
    as the output of a ScoreState or another container. The key difference
    is that it uses the passed Container to define the list of all
    possible contents of the container.
 */
class IMPCONTAINEREXPORT DynamicListSingletonContainer :
#if defined(IMP_DOXYGEN) || defined(SWIG)
    public SingletonContainer
#else
    public IMP::kernel::internal::DynamicListContainer<
        kernel::SingletonContainer>
#endif
    {
  typedef IMP::kernel::internal::DynamicListContainer<
      kernel::SingletonContainer> P;

 public:
  DynamicListSingletonContainer(Container *m, std::string name =
                                                  "ListSingletonContainer %1%");

  /** @name Methods to control the contained objects

      This container stores a list of Singleton objects. To manipulate
      the list use these methods.
   */
  /**@{*/
  void add_particle(kernel::Particle* vt);
  void add_particles(const kernel::ParticlesTemp &c);
  void set_particles(kernel::ParticlesTemp c);
  void clear_particles();
/**@}*/
#ifdef SWIG
  kernel::ParticleIndexes get_indexes() const;
  kernel::ParticleIndexes get_range_indexes() const;
  kernel::ModelObjectsTemp do_get_inputs() const;
  void do_apply(const SingletonModifier *sm) const;
  kernel::ParticleIndexes get_all_possible_indexes() const;
#endif
  IMP_OBJECT_METHODS(DynamicListSingletonContainer);
};

IMP_OBJECTS(DynamicListSingletonContainer, DynamicListSingletonContainers);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H */