SingletonContainerSet.h

Go to the documentation of this file.

/**
 *  \file IMP/container/SingletonContainerSet.h
 *  \brief Store a set of SingletonContainers
 *
 *  This file is generated by a script (tools/maintenance/make-container).
 *  Do not edit directly.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_SINGLETON_CONTAINER_SET_H
#define IMPCONTAINER_SINGLETON_CONTAINER_SET_H

#include <IMP/container/container_config.h>
#include <IMP/SingletonContainer.h>
#include <IMP/container_macros.h>
#include <IMP/kernel/internal/container_helpers.h>
#include <IMP/scoped.h>

IMPCONTAINER_BEGIN_NAMESPACE

//! Stores a set of SingletonContainers
/** The input sets must be disjoint. This can change if there is
    demand for it.

    \usesconstraint
*/
class IMPCONTAINEREXPORT SingletonContainerSet : public SingletonContainer {
  Ints versions_;
  static SingletonContainerSet *get_set(SingletonContainer *c) {
    return dynamic_cast<SingletonContainerSet *>(c);
  }
  virtual std::size_t do_get_contents_hash() const IMP_OVERRIDE;

 public:
  //! Construct and empty set
  SingletonContainerSet(kernel::Model *m,
                        std::string name = "SingletonContainerSet %1%");

  SingletonContainerSet(const SingletonContainersTemp &pc,
                        std::string name = "SingletonContainerSet %1%");

  /** \brief apply modifer sm to all singleton containers */
  IMP_IMPLEMENT(void do_apply(const SingletonModifier *sm) const);

  template <class M>
  void apply_generic(const M *m) const {
    apply(m);
  }

  kernel::ParticleIndexes get_all_possible_indexes() const;
  IMP_OBJECT_METHODS(SingletonContainerSet);

  /** @name Methods to control the nested container

      This container merges a set of nested containers. To add
      or remove nested containers, use the methods below.
  */
  /**@{*/
  IMP_LIST_ACTION(public, SingletonContainer, SingletonContainers,
                  singleton_container, singleton_containers,
                  SingletonContainer *, SingletonContainers,
  {
    obj->set_was_used(true);
    versions_.clear();
  },
                  {}, );
/**@}*/

#ifndef IMP_DOXYGEN
  kernel::ParticleIndexes get_indexes() const;
  kernel::ParticleIndexes get_range_indexes() const;
  kernel::ModelObjectsTemp do_get_inputs() const;
#endif
};

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_SINGLETON_CONTAINER_SET_H */