InContainerPairFilter.h

Go to the documentation of this file.

/**
 *  \file IMP/container/InContainerPairFilter.h
 *  \brief A filter for Pairs.
 *
 *  This file is generated by a script (core/tools/make-containers).
 *  Do not edit directly.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 */

#ifndef IMPCONTAINER_IN_CONTAINER_PAIR_FILTER_H
#define IMPCONTAINER_IN_CONTAINER_PAIR_FILTER_H

#include <IMP/container/container_config.h>
#include <IMP/PairPredicate.h>
#include <IMP/PairContainer.h>
#include <IMP/kernel/internal/container_helpers.h>
#include "internal/PairContainerIndex.h"
#include <IMP/pair_macros.h>
#include <IMP/base/object_macros.h>
#include <IMP/base/warning_macros.h>

IMPCONTAINER_BEGIN_NAMESPACE

//! A filter which returns true if a container containers the Pair
/** 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 InContainerPairFilter
    : public PairPredicate {
  IMP::base::PointerMember<internal::PairContainerIndex> c_;

 public:
  InContainerPairFilter(PairContainer *c,
                             std::string name = "PairFilter %1%");
  InContainerPairFilter(PairContainer *c, bool handle_permutations,
                             std::string name = "PairFilter %1%");

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

IMP_OBJECTS(InContainerPairFilter, InContainerPairFilters);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_IN_CONTAINER_PAIR_FILTER_H */