IMP  2.0.1
The Integrative Modeling Platform
IMP::container::InContainerSingletonFilter Class Reference

A filter which returns true if a container containers the Singleton. More...

#include <IMP/container/InContainerSingletonFilter.h>

+ Inheritance diagram for IMP::container::InContainerSingletonFilter:

Public Member Functions

 InContainerSingletonFilter (SingletonContainer *c, std::string name="SingletonFilter %1%")
 
 InContainerSingletonFilter (SingletonContainer *c, bool handle_permutations, std::string name="SingletonFilter %1%")
 
- Public Member Functions inherited from IMP::kernel::SingletonPredicate
 SingletonPredicate (std::string name="SingletonPredicate %1%")
 
ContainersTemp get_input_containers (Particle *p) const
 
ParticlesTemp get_input_particles (Particle *p) const
 
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 
virtual int get_value (Particle *vt) const =0
 Compute the predicate.
 
virtual Ints get_value (const ParticlesTemp &o) const
 
virtual int get_value_index (Model *m, ParticleIndex vt) const
 Compute the predicate and the derivative if needed.
 
virtual Ints get_value_index (Model *m, const ParticleIndexes &o) const
 
int operator() (Model *m, ParticleIndex vt) const
 Enable them to be use as functors. More...
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< InContainerSingletonFilter > > 
InContainerSingletonFiltersTemp
 

Additional Inherited Members

- Public Types inherited from IMP::kernel::SingletonPredicate
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::kernel::SingletonPredicate
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
 

Detailed Description

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.

Definition at line 31 of file InContainerSingletonFilter.h.

Friends And Related Function Documentation


The documentation for this class was generated from the following file: