IMP logo
IMP Reference Guide  2.6.1
The Integrative Modeling Platform
DynamicListPairContainer.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-59000/imp-2.6.1/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-59000/imp-2.6.1/tools/build/container_templates/container/DynamicListClassnameContainer.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/DynamicListPairContainer.h
7  * \brief Store a list of ParticlePairsTemp
8  *
9  * Copyright 2007-2016 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/object_macros.h>
17 #include <IMP/internal/DynamicListContainer.h>
18 
19 IMPCONTAINER_BEGIN_NAMESPACE
20 
21 //! Store a 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::internal::DynamicListContainer<PairContainer>
32 #endif
33  {
34  typedef IMP::internal::DynamicListContainer<PairContainer> P;
35 
36  public:
37  /** Constructs the dynamic list
38 
39  @param scope a container with a list of all possible particles that
40  are allowed to be dynamically added or removed in this
41  container
42  @param name the name of this container
43  */
44  DynamicListPairContainer(Container *scope, std::string name =
45  "ListPairContainer %1%");
46 
47  /** @name Methods to control the contained objects
48 
49  This container stores a list of Pair objects. To manipulate
50  the list use these methods.
51  */
52  /**@{*/
53 #if defined(SWIG) || defined(IMP_DOXYGEN)
54  //! Add a single const ParticleIndexPair& to the container.
55  void add(const ParticleIndexPair& vt);
56 
57  //! Add ParticleIndexPairs to the container.
58  void add(const ParticleIndexPairs &c);
59 
60  //! Set the contents of the container to the given ParticleIndexPairs.
61  void set(ParticleIndexPairs cp);
62 
63  //! Clear the contents of the container.
64  void clear();
65 #endif
66  /** \deprecated_at{2.5} Use add() with indexes instead */
67  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
68  void add_particle_pair(const ParticlePair& vt);
69 
70  /** \deprecated_at{2.5} Use add() with indexes instead */
71  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
72  void add_particle_pairs(const ParticlePairsTemp &c);
73 
74  /** \deprecated_at{2.5} Use set() instead */
75  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
76  void set_particle_pairs(ParticlePairsTemp c);
77 
78  /** \deprecated_at{2.5} Use clear() instead */
79  IMPCONTAINER_DEPRECATED_METHOD_DECL(2.5)
80  void clear_particle_pairs();
81 
82 /**@}*/
83 #ifdef SWIG
87  void do_apply(const PairModifier *sm) const;
89 #endif
91 };
92 
94 
95 IMPCONTAINER_END_NAMESPACE
96 
97 #endif /* IMPCONTAINER_DYNAMIC_LIST_PAIR_CONTAINER_H */
virtual ParticleIndexPairs get_range_indexes() const =0
A shared container for Pairs.
Definition: PairContainer.h:37
Various general useful macros for IMP.
A class to store an fixed array of same-typed values.
Definition: Array.h:33
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
A base class for modifiers of ParticlePairsTemp.
Definition: PairModifier.h:32
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Definition: object_macros.h:42
virtual ParticleIndexes get_all_possible_indexes() const =0
Get contained particles.
virtual ParticleIndexPairs get_indexes() const =0
Abstract class for containers of particles.
virtual ModelObjectsTemp do_get_inputs() const =0