Return all unordered pairs of particles taken from the SingletonContainer. More...

#include <IMP/container/AllPairContainer.h>

Inheritance diagram for IMP::container::AllPairContainer:

Public Member Functions
	AllPairContainer (SingletonContainerAdaptor c, std::string name="AllPairContainer%1%")
	Get the individual particles from the passed SingletonContainer.

template<class F >
void	apply_generic (F *f) const

void	do_apply (const PairModifier *sm) const

virtual kernel::ModelObjectsTemp	do_get_inputs () const

virtual kernel::ParticleIndexes	get_all_possible_indexes () const
	Get contained particles. More...

virtual kernel::ParticleIndexPairs	get_indexes () const

virtual kernel::ParticleIndexPairs	get_range_indexes () const

virtual std::string	get_type_name () const

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

Public Member Functions inherited from IMP::kernel::PairContainer
void	apply (const PairModifier *sm) const
	Apply a SingletonModifier to the contents.

void	apply_generic (const PairModifier *m) const
	Just use apply() in the base class.

const kernel::ParticleIndexPairs &	get_contents () const

unsigned int	get_number_of_particle_pairs () const

kernel::ParticlePair	get_particle_pair (unsigned int i) const

kernel::ParticlePairsTemp	get_particle_pairs () const

Public Member Functions inherited from IMP::kernel::Container
ModelObjectsTemp	do_get_outputs () const
	containers don't have outputs

std::size_t	get_contents_hash () const

virtual bool	get_is_decomposable () const

Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (kernel::Model *m, std::string name)

bool	get_has_dependencies () const
	Return whether this object has dependencies computed.

bool	get_has_required_score_states () const

ModelObjectsTemp	get_inputs () const

ModelObjectsTemps	get_interactions () const

Model *	get_model () const

ModelObjectsTemp	get_outputs () const

const ScoreStatesTemp &	get_required_score_states () const

void	set_has_dependencies (bool tf)

void	set_has_required_score_states (bool tf)

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

virtual void	do_destroy ()

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)

Protected Member Functions
virtual std::size_t	do_get_contents_hash () const

Protected Member Functions inherited from IMP::kernel::PairContainer
	PairContainer (kernel::Model *m, std::string name="PairContainer %1%")

virtual bool	do_get_provides_access () const

Protected Member Functions inherited from IMP::kernel::Container
	Container (kernel::Model *m, std::string name="Container %1%")

Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps	do_get_interactions () const

virtual void	handle_set_has_required_score_states (bool)

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

Additional Inherited Members
Public Types inherited from IMP::kernel::PairContainer
typedef kernel::ParticleIndexPair	ContainedIndexType

typedef kernel::ParticleIndexPairs	ContainedIndexTypes

typedef kernel::ParticlePair	ContainedType

typedef kernel::ParticlePairsTemp	ContainedTypes

typedef PairModifier	Modifier

typedef const kernel::ParticleIndexPair &	PassContainedIndexType

Detailed Description

Definition at line 27 of file AllPairContainer.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::container::AllPairContainer::do_get_inputs ( ) const

virtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

virtual kernel::ParticleIndexes IMP::container::AllPairContainer::get_all_possible_indexes ( ) const

virtual

Get a list of all particles contained in this one, given that the input containers are up to date.

Implements IMP::kernel::Container.

virtual kernel::ParticleIndexPairs IMP::container::AllPairContainer::get_indexes ( ) const

virtual

Get all the indexes contained in the container.

This should be protected but isn't for compatibility reasons.

External callers should use get_contents().

Implements IMP::kernel::PairContainer.

virtual kernel::ParticleIndexPairs IMP::container::AllPairContainer::get_range_indexes ( ) const

virtual

Get all the indexes that might possibly be contained in the container, useful with dynamic containers. For example, with a container::ClosePairContainer, this is the list of all pairs taken from input list (those that are far apart in addition to those that are close).

Implements IMP::kernel::PairContainer.

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

AllPairContainer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation