IMP  2.3.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:

Detailed Description

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.

Definition at line 31 of file InContainerSingletonFilter.h.

Public Member Functions

 InContainerSingletonFilter (SingletonContainer *c, std::string name="SingletonFilter %1%")
 
 InContainerSingletonFilter (SingletonContainer *c, bool handle_permutations, std::string name="SingletonFilter %1%")
 
virtual kernel::ModelObjectsTemp do_get_inputs (kernel::Model *m, const kernel::ParticleIndexes &pi) const
 
virtual std::string get_type_name () const
 
int get_value (kernel::Particle *a) const
 
Ints get_value (const kernel::ParticlesTemp &o) const
 
virtual int get_value_index (kernel::Model *, kernel::ParticleIndex vt) const
 Compute the predicate and the derivative if needed. More...
 
Ints get_value_index (kernel::Model *m, const kernel::ParticleIndexes &o) const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::kernel::SingletonPredicate
 SingletonPredicate (std::string name="SingletonPredicate %1%")
 
int operator() (kernel::Model *m, kernel::ParticleIndex vt) const
 Enable them to be use as functors. More...
 
- Public Member Functions inherited from IMP::kernel::ParticleInputs
virtual ContainersTemp get_input_containers (Particle *p) const
 
virtual ParticlesTemp get_input_particles (Particle *p) const
 
ModelObjectsTemp get_inputs (kernel::Model *m, const ParticleIndexes &pis) const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
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)
 

Additional Inherited Members

- Public Types inherited from IMP::kernel::SingletonPredicate
typedef kernel::ParticleArgument
 
typedef kernel::ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::container::InContainerSingletonFilter::do_get_inputs ( kernel::Model m,
const kernel::ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Reimplemented from IMP::kernel::ParticleInputs.

Definition at line 45 of file InContainerSingletonFilter.h.

+ Here is the call graph for this function:

Ints IMP::container::InContainerSingletonFilter::get_value ( const kernel::ParticlesTemp o) const
virtual
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the index based version.

Reimplemented from IMP::kernel::SingletonPredicate.

Definition at line 51 of file InContainerSingletonFilter.h.

int IMP::container::InContainerSingletonFilter::get_value ( kernel::Particle vt) const
virtual
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the index based version.

Reimplemented from IMP::kernel::SingletonPredicate.

Definition at line 51 of file InContainerSingletonFilter.h.

virtual int IMP::container::InContainerSingletonFilter::get_value_index ( kernel::Model m,
kernel::ParticleIndex  vt 
) const
virtual

Compute the predicate and the derivative if needed.

Reimplemented from IMP::kernel::SingletonPredicate.

Definition at line 41 of file InContainerSingletonFilter.h.

virtual ::IMP::base::VersionInfo IMP::container::InContainerSingletonFilter::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 52 of file InContainerSingletonFilter.h.


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