IMP::container::ListPairContainer Class Reference

Store a kernel::ParticleIndexPairs. More...

#include <IMP/container/ListPairContainer.h>

Inheritance diagram for IMP::container::ListPairContainer:

Public Member Functions
	ListPairContainer (kernel::Model *m, const kernel::ParticleIndexPairs &contents, std::string name="ListPairContainer%1%")
	ListPairContainer (const kernel::ParticlePairsTemp &ps, std::string name="ListPairContainer%1%")
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.
void	set_particle_pairs (const kernel::ParticlePairsTemp &ps)
void	set_particle_pairs (const kernel::ParticleIndexPairs &contents)
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
virtual kernel::ParticleIndexPairs	get_indexes () const =0
unsigned int	get_number_of_particle_pairs () const
kernel::ParticlePair	get_particle_pair (unsigned int i) const
kernel::ParticlePairsTemp	get_particle_pairs () const
virtual kernel::ParticleIndexPairs	get_range_indexes () const =0
Public Member Functions inherited from IMP::kernel::Container
ModelObjectsTemp	do_get_outputs () const
	containers don't have outputs
virtual ParticleIndexes	get_all_possible_indexes () const =0
	Get contained particles. More...
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)

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
Protected Member Functions inherited from IMP::kernel::PairContainer
	PairContainer (kernel::Model *m, std::string name="PairContainer %1%")
virtual void	do_apply (const PairModifier *sm) const =0
virtual bool	do_get_provides_access () const
Protected Member Functions inherited from IMP::kernel::Container
	Container (kernel::Model *m, std::string name="Container %1%")
virtual std::size_t	do_get_contents_hash () const =0
Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemp	do_get_inputs () const =0
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...

Detailed Description

Note

The order may change when particles are inserted as the list is maintained in sorted order.

Changing the contents of the container is a fairly heavy weight operation as it resets part of the dependency graph. Use a DynamicListPairContainer if you want to change the contents frequently (eg via a kernel::ScoreState).

Definition at line 33 of file ListPairContainer.h.

---

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

• ListPairContainer.h