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 32 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 ModelObjectsTemp	do_get_inputs (Model *m, const ParticleIndexes &pi) const
	Overload this method to specify the inputs. More...

virtual std::string	get_type_name () const

int	get_value (Particle *a) const

Ints	get_value (const ParticlesTemp &o) const

virtual int	get_value_index (Model *, ParticleIndex vt) const
	Compute the predicate and the derivative if needed. More...

Ints	get_value_index (Model *m, const ParticleIndexes &o) const

virtual ::IMP::VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...

Public Member Functions inherited from IMP::SingletonPredicate
	SingletonPredicate (std::string name="SingletonPredicate %1%")

int	operator() (Model *m, ParticleIndex vt) const
	Enable them to be use as functors. More...

Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp	get_inputs (Model *m, const ParticleIndexes &pis) const
	Get the ModelObjects read when the given list of particles is used. More...

Public Member Functions inherited from IMP::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::SingletonPredicate
typedef Particle *	Argument

typedef ParticleIndex	IndexArgument

Protected Member Functions inherited from IMP::Object
	Object (std::string name)
	Construct an object with the given name. More...

virtual void	do_destroy ()

Member Function Documentation

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

virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

Definition at line 46 of file InContainerSingletonFilter.h.

Here is the call graph for this function:

Ints IMP::container::InContainerSingletonFilter::get_value ( const 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::SingletonPredicate.

Definition at line 52 of file InContainerSingletonFilter.h.

int IMP::container::InContainerSingletonFilter::get_value ( 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::SingletonPredicate.

Definition at line 52 of file InContainerSingletonFilter.h.

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

virtual

Compute the predicate and the derivative if needed.

Reimplemented from IMP::SingletonPredicate.

Definition at line 42 of file InContainerSingletonFilter.h.

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

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 53 of file InContainerSingletonFilter.h.

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

InContainerSingletonFilter.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation