IMP  2.3.0
The Integrative Modeling Platform
DynamicListPairContainer.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/DynamicListPairContainer.h
3  * \brief Store a list of kernel::ParticlePairsTemp
4  *
5  * WARNING This file was generated from DynamicListPairContainer.h
6  * in /tmp/nightly-build-54722/imp-2.3.0/tools/build/container_templates/container
7  * by tools/build/make_containers.py.
8  *
9  * Copyright 2007-2014 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCONTAINER_DYNAMIC_LIST_PAIR_CONTAINER_H
13 #define IMPCONTAINER_DYNAMIC_LIST_PAIR_CONTAINER_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/base/object_macros.h>
17 #include <IMP/kernel/internal/DynamicListContainer.h>
18 
19 IMPCONTAINER_BEGIN_NAMESPACE
20 
21 //! Store a kernel::ParticleIndexPairs
22 /** In contrast to ListPairContainer, 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 DynamicListPairContainer :
28 #if defined(IMP_DOXYGEN) || defined(SWIG)
29  public PairContainer
30 #else
31  public IMP::kernel::internal::DynamicListContainer<
32  kernel::PairContainer>
33 #endif
34  {
35  typedef IMP::kernel::internal::DynamicListContainer<
37 
38  public:
39  /** Constructs the dynamic list
40 
41  @param scope a container with a list of all possible particles that
42  are allowed to be dynamically added or removed in this
43  container
44  @param name the name of this container
45  */
46  DynamicListPairContainer(Container *scope, std::string name =
47  "ListPairContainer %1%");
48 
49  /** @name Methods to control the contained objects
50 
51  This container stores a list of Pair objects. To manipulate
52  the list use these methods.
53  */
54  /**@{*/
55  void add_particle_pair(const kernel::ParticlePair& vt);
56  void add_particle_pairs(const kernel::ParticlePairsTemp &c);
57  void set_particle_pairs(kernel::ParticlePairsTemp c);
58  void clear_particle_pairs();
59 /**@}*/
60 #ifdef SWIG
64  void do_apply(const PairModifier *sm) const;
66 #endif
68 };
69 
71 
72 IMPCONTAINER_END_NAMESPACE
73 
74 #endif /* IMPCONTAINER_DYNAMIC_LIST_PAIR_CONTAINER_H */
Various general useful macros for IMP.
virtual ParticleIndexes get_all_possible_indexes() const =0
Get contained particles.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
virtual kernel::ParticleIndexPairs get_indexes() const =0
A shared container for Pairs.
A class to store an fixed array of same-typed values.
Definition: Array.h:33
Abstract class for containers of particles.
virtual kernel::ParticleIndexPairs get_range_indexes() const =0
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Definition: object_macros.h:52
virtual ModelObjectsTemp do_get_inputs() const =0
Store a kernel::ParticleIndexPairs.
A base class for modifiers of kernel::ParticlePairsTemp.