IMP  2.0.1
The Integrative Modeling Platform
CloseBipartitePairContainer.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/CloseBipartitePairContainer.h
3  * \brief Return all pairs from a SingletonContainer
4  *
5  * This file is generated by a script (core/tools/make-container).
6  * Do not edit directly.
7  *
8  * Copyright 2007-2013 IMP Inventors. Close rights reserved.
9  */
10 
11 #ifndef IMPCONTAINER_CLOSE_BIPARTITE_PAIR_CONTAINER_H
12 #define IMPCONTAINER_CLOSE_BIPARTITE_PAIR_CONTAINER_H
13 
14 #include <IMP/container/container_config.h>
16 #include <IMP/core/internal/CoreCloseBipartitePairContainer.h>
17 #include <IMP/core/internal/MovedSingletonContainer.h>
18 #include <IMP/PairContainer.h>
19 #include <IMP/PairPredicate.h>
20 #include <IMP/SingletonContainer.h>
22 
23 IMPCONTAINER_BEGIN_NAMESPACE
24 
25 /** \brief Return all close ordered pairs of particles taken from the
26  two SingletonContainers.
27 
28  See ClosePairContainer for a more detailed description. This
29  container lists all close pairs of particles where one particle is
30  taken from each of the input sets.
31 
32  \usesconstraint
33  */
34 class IMPCONTAINEREXPORT CloseBipartitePairContainer:
35 #if defined(IMP_DOXYGEN) || defined(SWIG)
36 public PairContainer
37 #else
38 public IMP::core::internal::CoreCloseBipartitePairContainer
39 #endif
40 {
41  typedef IMP::core::internal::CoreCloseBipartitePairContainer P;
42 public:
43  //! Get the individual particles from the passed SingletonContainer
44  CloseBipartitePairContainer(SingletonContainerAdaptor a,
45  SingletonContainerAdaptor b,
46  double distance,
47  double slack=1);
48 #ifndef IMP_DOXYGEN
49  //! Get the individual particles from the passed SingletonContainer
50  CloseBipartitePairContainer(SingletonContainerAdaptor a,
51  SingletonContainerAdaptor b,
52  double distance,
54  double slack=1);
55 #endif
56 
57 #if defined(IMP_DOXYGEN) || defined(SWIG)
58 
59  /** @name Methods to control the set of filters
60 
61  PairPredicate objects can be used as filters to prevent
62  the addition of pairs to the containeroutput list. Pairs
63  for which the predicates evaluate to a non-zero value are
64  excluded from the list.
65  */
66  /**@{*/
67  IMP_LIST_ACTION(public, PairPredicate, PairPredicates, pair_filter,
68  pair_filters,
69  PairPredicate*, PairPredicates, obj->set_was_used(true);,,);
70  /**@}*/
72 #endif
73 };
74 
75 IMPCONTAINER_END_NAMESPACE
76 
77 #endif /* IMPCONTAINER_CLOSE_BIPARTITE_PAIR_CONTAINER_H */