IMP  2.1.0
The Integrative Modeling Platform
InContainerSingletonFilter.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/InContainerSingletonFilter.h
3  * \brief A filter for Singletons.
4  *
5  * This file is generated by a script (core/tools/make-containers).
6  * Do not edit directly.
7  *
8  * Copyright 2007-2013 IMP Inventors. All rights reserved.
9  */
10 
11 #ifndef IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H
12 #define IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H
13 
14 #include <IMP/container/container_config.h>
15 #include <IMP/SingletonPredicate.h>
16 #include <IMP/SingletonContainer.h>
17 #include <IMP/kernel/internal/container_helpers.h>
18 #include "internal/SingletonContainerIndex.h"
19 #include <IMP/singleton_macros.h>
20 #include <IMP/base/object_macros.h>
22 
23 IMPCONTAINER_BEGIN_NAMESPACE
24 
25 //! A filter which returns true if a container containers the Singleton
26 /** This predicate returns 1 if the passed tuple is in the container.
27  \note Use the handle_permutations parameter to the constructor to
28  determine whether only exact matchers, or matches under permutation
29  are considered matching. By default they are are.
30  */
31 class IMPCONTAINEREXPORT InContainerSingletonFilter
32  : public SingletonPredicate {
34 
35  public:
37  std::string name = "SingletonFilter %1%");
38  InContainerSingletonFilter(SingletonContainer *c, bool handle_permutations,
39  std::string name = "SingletonFilter %1%");
40 
41  virtual int get_value_index(kernel::Model *, ParticleIndex vt) const IMP_OVERRIDE {
42  return c_->get_contains(vt);
43  }
45  const IMP_OVERRIDE {
47  ret.push_back(c_);
48  return ret;
49  }
52 };
53 
55 
56 IMPCONTAINER_END_NAMESPACE
57 
58 #endif /* IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H */
Import IMP/kernel/SingletonContainer.h in the namespace.
ParticlesTemp get_particles(kernel::Model *m, const ParticleIndexes &ps)
Import IMP/kernel/singleton_macros.h in the namespace.
virtual int get_value_index(kernel::Model *, ParticleIndex vt) const
Compute the predicate and the derivative if needed.
Import IMP/kernel/SingletonPredicate.h in the namespace.
A filter which returns true if a container containers the Singleton.
Various general useful macros for IMP.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
#define IMP_SINGLETON_PREDICATE_METHODS(Name)
Define extra the functions needed for a SingletonPredicate.
Abstract predicate function.
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *m, const kernel::ParticleIndexes &pi) const
Various general useful macros for IMP.
A shared container for Singletons.
Class for storing model, its restraints, constraints, and particles.