IMP  2.1.0
The Integrative Modeling Platform
DynamicListSingletonContainer.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/DynamicListSingletonContainer.h
3  * \brief Store a list of ParticlesTemp
4  *
5  * WARNING This file was generated from DynamicListSingletonContainer.h
6  * in /tmp/nightly-build-90783/imp-2.1.0/tools/build/container_templates/container
7  * by tools/maintenance/setup_containers.py.
8  *
9  * Copyright 2007-2013 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H
13 #define IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/base/object_macros.h>
17 #include <IMP/kernel/internal/InternalDynamicListSingletonContainer.h>
18 
19 IMPCONTAINER_BEGIN_NAMESPACE
20 
21 //! Store a ParticleIndexes
22 /** In contrast to ListSingletonContainer, this list is designed to act
23  as the output of a ScoreState or another container. The key difference
24  is that it uses the passed Container to define the list of all
25  possible contents of the container.
26  */
27 class IMPCONTAINEREXPORT DynamicListSingletonContainer :
28 #if defined(IMP_DOXYGEN) || defined(SWIG)
29  public SingletonContainer
30 #else
31  public IMP::kernel::internal::InternalDynamicListSingletonContainer
32 #endif
33  {
34  typedef IMP::kernel::internal::InternalDynamicListSingletonContainer P;
35 
36  public:
37  DynamicListSingletonContainer(Container *m, std::string name =
38  "ListSingletonContainer %1%");
39 
40  /** @name Methods to control the contained objects
41 
42  This container stores a list of Singleton objects. To manipulate
43  the list use these methods.
44  */
45  /**@{*/
46  void add_particle(Particle* vt);
47  void add_particles(const ParticlesTemp &c);
48  void set_particles(ParticlesTemp c);
49  void clear_particles();
50 /**@}*/
51 #ifdef SWIG
54  void do_before_evaluate();
56  void do_apply(const SingletonModifier *sm) const;
58 #endif
60 };
61 
63 
64 IMPCONTAINER_END_NAMESPACE
65 
66 #endif /* IMPCONTAINER_DYNAMIC_LIST_SINGLETON_CONTAINER_H */
virtual ParticleIndexes get_all_possible_indexes() const =0
Get contained particles.
virtual ParticleIndexes get_indexes() const =0
A base class for modifiers of ParticlesTemp.
Abstract class for containers of particles.
void add_particles(RMF::FileHandle fh, const kernel::ParticlesTemp &hs)
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Class to handle individual model particles.
virtual ParticleIndexes get_range_indexes() const =0
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
virtual ModelObjectsTemp do_get_inputs() const =0
Various general useful macros for IMP.
void add_particle(RMF::FileHandle fh, kernel::Particle *hs)
A shared container for Singletons.