InContainerSingletonFilter.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/container_templates/container/InContainerClassnameFilter.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/container/InContainerSingletonFilter.h
 *  \brief A filter for Singletons.
 *
 *  Copyright 2007-2020 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H
#define IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H

#include <IMP/container/container_config.h>
#include <IMP/SingletonPredicate.h>
#include <IMP/SingletonContainer.h>
#include <IMP/internal/container_helpers.h>
#include "internal/SingletonContainerIndex.h"
#include <IMP/singleton_macros.h>
#include <IMP/object_macros.h>
#include <IMP/warning_macros.h>

IMPCONTAINER_BEGIN_NAMESPACE

//! A filter which returns true if a container containers the Singleton
/** This predicate returns 1 if the passed tuple is in the container.
    \note Use the handle_permutations parameter to the constructor to
    determine whether only exact matchers, or matches under permutation
    are considered matching. By default they are are.
 */
class IMPCONTAINEREXPORT InContainerSingletonFilter
    : public SingletonPredicate {
  IMP::PointerMember<internal::SingletonContainerIndex> c_;

 public:
  InContainerSingletonFilter(SingletonContainer *c,
                             std::string name = "SingletonFilter %1%");
  InContainerSingletonFilter(SingletonContainer *c, bool handle_permutations,
                             std::string name = "SingletonFilter %1%");

  virtual int get_value_index(Model *, ParticleIndex vt) const
      IMP_OVERRIDE {
    return c_->get_contains(vt);
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *m, const ParticleIndexes &pi) const IMP_OVERRIDE {
    ModelObjectsTemp ret = IMP::get_particles(m, pi);
    ret.push_back(c_);
    return ret;
  }
  IMP_SINGLETON_PREDICATE_METHODS(InContainerSingletonFilter);
  IMP_OBJECT_METHODS(InContainerSingletonFilter);
};

IMP_OBJECTS(InContainerSingletonFilter, InContainerSingletonFilters);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H */