InContainerSingletonFilter.h

Go to the documentation of this file.

/**
 *  \file IMP/container/InContainerSingletonFilter.h
 *  \brief A filter for Singletons.
 *
 *  This file is generated by a script (core/tools/make-containers).
 *  Do not edit directly.
 *
 *  Copyright 2007-2013 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/base/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::base::OwnerPointer<internal::SingletonContainerIndex> c_;
public:
  InContainerSingletonFilter(SingletonContainer *c,
                             std::string name="SingletonFilter %1%");
  InContainerSingletonFilter(SingletonContainer *c,
                             bool handle_permutations,
                             std::string name="SingletonFilter %1%");

  IMP_INDEX_SINGLETON_PREDICATE(InContainerSingletonFilter,{
      IMP_UNUSED(m);
      return c_->get_contains(pi);
    },{
      ModelObjectsTemp ret;
      ret+= IMP::get_particles(m, pi);
      ret.push_back(c_);
      return ret;
    });
};


IMP_OBJECTS(InContainerSingletonFilter, InContainerSingletonFilters);

IMPCONTAINER_END_NAMESPACE

#endif  /* IMPCONTAINER_IN_CONTAINER_SINGLETON_FILTER_H */