IMP logo
IMP Reference Guide  develop.07f7673d5c,2020/04/01
The Integrative Modeling Platform
IMP::container::ListPairContainer Class Reference

Store a list of ParticleIndexPairs. More...

#include <IMP/container/ListPairContainer.h>

+ Inheritance diagram for IMP::container::ListPairContainer:

Detailed Description

Store a list of ParticleIndexPairs.

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 ScoreState).

Definition at line 33 of file ListPairContainer.h.

Public Member Functions

 ListPairContainer (Model *m, const ParticleIndexPairs &contents, std::string name="ListPairContainer%1%")
 
void add (const ParticleIndexPair &vt)
 Add a single const ParticleIndexPair& to the container. More...
 
void add (const ParticleIndexPairs &c)
 Add ParticleIndexPairs to the container. More...
 
void clear ()
 Clear the contents of the container. More...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set (ParticleIndexPairs cp)
 Set the contents of the container to the given ParticleIndexPairs. More...
 
- Public Member Functions inherited from IMP::PairContainer
void apply (const PairModifier *sm) const
 Apply a SingletonModifier to the contents. More...
 
void apply_generic (const PairModifier *m) const
 Just use apply() in the base class. More...
 
const ParticleIndexPairsget_contents () const
 
virtual ParticleIndexPairs get_indexes () const =0
 
ParticlePair get_particle_pair (unsigned int i) const
 
ParticlePairsTemp get_particle_pairs () const
 
virtual ParticleIndexPairs get_range_indexes () const =0
 
- Public Member Functions inherited from IMP::Container
ModelObjectsTemp do_get_outputs () const
 containers don't have outputs More...
 
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::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. 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::PairContainer
typedef ParticleIndexPair ContainedIndexType
 
typedef ParticleIndexPairs ContainedIndexTypes
 
typedef ParticlePair ContainedType
 
typedef ParticlePairsTemp ContainedTypes
 
typedef PairModifier Modifier
 
typedef const ParticleIndexPairPassContainedIndexType
 
- Protected Member Functions inherited from IMP::PairContainer
 PairContainer (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::Container
 Container (Model *m, std::string name="Container %1%")
 
virtual std::size_t do_get_contents_hash () const =0
 
- Protected Member Functions inherited from IMP::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::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

void IMP::container::ListPairContainer::add ( const ParticleIndexPair vt)

Add a single const ParticleIndexPair& to the container.

void IMP::container::ListPairContainer::add ( const ParticleIndexPairs c)

Add ParticleIndexPairs to the container.

void IMP::container::ListPairContainer::clear ( )

Clear the contents of the container.

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 76 of file ListPairContainer.h.

void IMP::container::ListPairContainer::set ( ParticleIndexPairs  cp)

Set the contents of the container to the given ParticleIndexPairs.


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