ListSingletonContainer.h

Go to the documentation of this file.

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

/**
 *  \file IMP/container/ListSingletonContainer.h
 *  \brief Store a list of ParticleIndexes.
 *
 *  Copyright 2007-2015 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_LIST_SINGLETON_CONTAINER_H
#define IMPCONTAINER_LIST_SINGLETON_CONTAINER_H

#include <IMP/container/container_config.h>
#include <IMP/object_macros.h>
#include <IMP/internal/StaticListContainer.h>
#include <IMP/SingletonContainer.h>
#include <IMP/SingletonModifier.h>
#include <IMP/base_types.h>

IMPCONTAINER_BEGIN_NAMESPACE

//! Store a list of ParticleIndexes
/** \note The order may change when particles are inserted
    as the list is maintained in sorted order.

    \note Changing the contents of the container is a fairly heavy
    weight operation as it resets part of the dependency graph. Use
    a DynamicListSingletonContainer if you want to change the contents
    frequently (eg via a ScoreState).
 */
class IMPCONTAINEREXPORT ListSingletonContainer :
#if defined(IMP_DOXYGEN) || defined(SWIG)
    public SingletonContainer
#else
    public IMP::internal::StaticListContainer<SingletonContainer>
#endif
    {
  typedef IMP::internal::StaticListContainer<SingletonContainer> P;

 public:
  ListSingletonContainer(Model *m, const ParticleIndexes &contents,
                         std::string name = "ListSingletonContainer%1%");

  ListSingletonContainer(const ParticlesTemp &ps,
                         std::string name = "ListSingletonContainer%1%");

  /** \deprecated_at{2.5} Use set() with indexes instead */
  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
  void set_particles(const ParticlesTemp &ps);

  /** \deprecated_at{2.5} Use set() instead */
  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
  void set_particles(const ParticleIndexes &contents);
#ifndef IMP_DOXYGEN
  ListSingletonContainer(Model *m,
                         std::string name = "ListSingletonContainer %1%");
  ListSingletonContainer(Model *m, const char *name);

  /** \deprecated_at{2.5} Use add() with indexes instead */
  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
  void add_particle(Particle* vt);

  /** \deprecated_at{2.5} Use add() with indexes instead */
  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
  void add_particles(const ParticlesTemp &c);

  /** \deprecated_at{2.5} Use clear() instead */
  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
  void clear_particles();
#endif
#if defined(SWIG) || defined(IMP_DOXYGEN)
  //! Add a single ParticleIndex to the container.
  void add(ParticleIndex vt);

  //! Add ParticleIndexes to the container.
  void add(const ParticleIndexes &c);

  //! Set the contents of the container to the given ParticleIndexes.
  void set(ParticleIndexes cp);

  //! Clear the contents of the container.
  void clear();
#endif

#ifdef SWIG
  ParticleIndexes get_indexes() const;
  ParticleIndexes get_range_indexes() const;
  ModelObjectsTemp do_get_inputs() const;
  void do_apply(const SingletonModifier *sm) const;
  ParticleIndexes get_all_possible_indexes() const;

 private:
  std::size_t do_get_contents_hash() const;
#endif
  IMP_OBJECT_METHODS(ListSingletonContainer);
};

IMP_OBJECTS(ListSingletonContainer, ListSingletonContainers);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_LIST_SINGLETON_CONTAINER_H */