IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
ListPairContainer.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/container_templates/container/ListClassnameContainer.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/ListPairContainer.h
7  * \brief Store a list of ParticleIndexPairs.
8  *
9  * Copyright 2007-2022 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCONTAINER_LIST_PAIR_CONTAINER_H
13 #define IMPCONTAINER_LIST_PAIR_CONTAINER_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/object_macros.h>
17 #include <IMP/internal/StaticListContainer.h>
18 #include <IMP/PairContainer.h>
19 #include <IMP/PairModifier.h>
20 #include <IMP/base_types.h>
21 #include <cereal/access.hpp>
22 #include <cereal/types/base_class.hpp>
23 
24 IMPCONTAINER_BEGIN_NAMESPACE
25 
26 //! Store a list of ParticleIndexPairs
27 /** \note The order may change when particles are inserted
28  as the list is maintained in sorted order.
29 
30  \note Changing the contents of the container is a fairly heavy
31  weight operation as it resets part of the dependency graph. Use
32  a DynamicListPairContainer if you want to change the contents
33  frequently (eg via a ScoreState).
34  */
35 class IMPCONTAINEREXPORT ListPairContainer :
36 #if defined(IMP_DOXYGEN) || defined(SWIG)
37  public PairContainer
38 #else
39  public IMP::internal::StaticListContainer<PairContainer>
40 #endif
41  {
42  typedef IMP::internal::StaticListContainer<PairContainer> P;
43 
44  public:
45  ListPairContainer(Model *m, const ParticleIndexPairs &contents,
46  std::string name = "ListPairContainer%1%");
47 
48 #ifndef IMP_DOXYGEN
50  std::string name = "ListPairContainer %1%");
51  ListPairContainer(Model *m, const char *name);
53 
54 #endif
55 #if defined(SWIG) || defined(IMP_DOXYGEN)
56  //! Add a single const ParticleIndexPair& to the container.
57  void add(const ParticleIndexPair& vt);
58 
59  //! Add ParticleIndexPairs to the container.
60  void add(const ParticleIndexPairs &c);
61 
62  //! Set the contents of the container to the given ParticleIndexPairs.
63  void set(ParticleIndexPairs cp);
64 
65  //! Clear the contents of the container.
66  void clear();
67 #endif
68 
69 #ifdef SWIG
73  void do_apply(const PairModifier *sm) const;
74  void do_apply_moved(const PairModifier *sm,
75  const ParticleIndexes &moved_pis,
76  const ParticleIndexes &reset_pis) const;
78 
79  private:
80  std::size_t do_get_contents_hash() const;
81 #endif
83 
84  friend class cereal::access;
85 
86  template<class Archive> void serialize(Archive &ar) {
87  ar(cereal::base_class<P>(this));
88  }
90 };
91 
93 
94 IMPCONTAINER_END_NAMESPACE
95 
96 #endif /* IMPCONTAINER_LIST_PAIR_CONTAINER_H */
virtual ParticleIndexPairs get_range_indexes() const =0
A shared container for Pairs.
Definition: PairContainer.h:39
Helper macros for implementing IMP Objects.
Basic types used by IMP.
#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
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:86
Store a list of ParticleIndexPairs.
A container for Pairs.
#define IMP_OBJECT_SERIALIZE_DECL(Name)
Declare methods needed for serialization of Object pointers.
Definition: object_macros.h:95
A Modifier on ParticlePairsTemp.
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
virtual ParticleIndexes get_all_possible_indexes() const =0
Get contained particles.
virtual ParticleIndexPairs get_indexes() const =0
virtual ModelObjectsTemp do_get_inputs() const =0