IMP  2.1.0
The Integrative Modeling Platform
ListPairContainer.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/ListPairContainer.h
3  * \brief Store a list of ParticlePairsTemp
4  *
5  * WARNING This file was generated from ListPairContainer.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_LIST_PAIR_CONTAINER_H
13 #define IMPCONTAINER_LIST_PAIR_CONTAINER_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/base/object_macros.h>
17 #include <IMP/kernel/internal/InternalListPairContainer.h>
18 
19 IMPCONTAINER_BEGIN_NAMESPACE
20 
21 //! Store a ParticleIndexPairs
22 /** \note The order may change when particles are inserted
23  as the list is maintained in sorted order.
24 
25  \note Changing the contents of the container is a fairly heavy
26  weight operation as it resets part of the dependency graph. Use
27  a DynamicListPairContainer if you want to change the contents
28  frequently (eg via a kernel::ScoreState).
29  */
30 class IMPCONTAINEREXPORT ListPairContainer :
31 #if defined(IMP_DOXYGEN) || defined(SWIG)
32  public PairContainer
33 #else
34  public IMP::kernel::internal::InternalListPairContainer
35 #endif
36  {
37  typedef IMP::kernel::internal::InternalListPairContainer P;
38 
39  public:
41  std::string name = "ListPairContainer%1%");
42 
44  std::string name = "ListPairContainer%1%");
45 
46  void set_particle_pairs(const ParticlePairsTemp &ps);
47  void set_particle_pairs(const ParticleIndexPairs &contents);
48 #ifndef IMP_DOXYGEN
50  std::string name = "ListPairContainer %1%");
51  ListPairContainer(kernel::Model *m, const char *name);
52 
53  void add_particle_pair(const ParticlePair& vt);
54  void add_particle_pairs(const ParticlePairsTemp &c);
55  void clear_particle_pairs();
56 #endif
57 #ifdef SWIG
60  void do_before_evaluate();
62  void do_apply(const PairModifier *sm) const;
64 #endif
66 };
67 
69 
70 IMPCONTAINER_END_NAMESPACE
71 
72 #endif /* IMPCONTAINER_LIST_PAIR_CONTAINER_H */
virtual ParticleIndexes get_all_possible_indexes() const =0
Get contained particles.
A shared container for Pairs.
virtual ParticleIndexPairs get_indexes() const =0
A class to store an fixed array of same-typed values.
Definition: base/Array.h:33
Store a ParticleIndexPairs.
virtual ParticleIndexPairs get_range_indexes() const =0
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
#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.
A base class for modifiers of ParticlePairsTemp.
Class for storing model, its restraints, constraints, and particles.