IMP  2.0.1
The Integrative Modeling Platform
DynamicListTripletContainer.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/DynamicListTripletContainer.h
3  * \brief Store a list of ParticleTripletsTemp
4  *
5  * WARNING This file was generated from DynamicListTripletContainer.h
6  * in /tmp/nightly-build-36540/imp-2.0.1/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_TRIPLET_CONTAINER_H
13 #define IMPCONTAINER_DYNAMIC_LIST_TRIPLET_CONTAINER_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/internal/InternalDynamicListTripletContainer.h>
17 
18 IMPCONTAINER_BEGIN_NAMESPACE
19 
20 //! Store a list of ParticleTripletsTemp
21 /** In contrast to ListTripletContainer, this list is designed to act
22  as the output of a ScoreState or another container. The key difference
23  is that it uses the passed Container to define the list of all
24  possible contents of the container.
25  */
26 class IMPCONTAINEREXPORT DynamicListTripletContainer:
27 #if defined(IMP_DOXYGEN) || defined(SWIG)
28 public TripletContainer
29 #else
30 public IMP::kernel::internal::InternalDynamicListTripletContainer
31 #endif
32 {
33  typedef IMP::kernel::internal::InternalDynamicListTripletContainer P;
34 public:
35  DynamicListTripletContainer(Container *m,
36  std::string name= "ListTripletContainer %1%");
37 
38  /** @name Methods to control the contained objects
39 
40  This container stores a list of Triplet objects. To manipulate
41  the list use these methods.
42  */
43  /**@{*/
44  void add_particle_triplet(const ParticleTriplet& vt);
45  void add_particle_triplets(const ParticleTripletsTemp &c);
46  void set_particle_triplets(ParticleTripletsTemp c);
47  void clear_particle_triplets();
48  /**@}*/
49 #ifdef SWIG
50  IMP_TRIPLET_CONTAINER(DynamicListTripletContainer);
51 #endif
52 };
53 
54 IMP_OBJECTS(DynamicListTripletContainer,DynamicListTripletContainers);
55 
56 IMPCONTAINER_END_NAMESPACE
57 
58 #endif /* IMPCONTAINER_DYNAMIC_LIST_TRIPLET_CONTAINER_H */