IMP  2.4.0
The Integrative Modeling Platform
Public Member Functions | List of all members
IMP::container::DynamicListPairContainer Class Reference

Store a kernel::ParticleIndexPairs. More...

#include <IMP/container/DynamicListPairContainer.h>

+ Inheritance diagram for IMP::container::DynamicListPairContainer:

Detailed Description

Store a kernel::ParticleIndexPairs.

In contrast to ListPairContainer, this list is designed to act as the output of a ScoreState or another container. The key difference is that it uses the passed Container to define the list of all possible contents of the container.

Definition at line 27 of file DynamicListPairContainer.h.

Public Member Functions

 DynamicListPairContainer (Container *scope, 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. More...
- Public Member Functions inherited from IMP::kernel::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 kernel::ParticleIndexPairsget_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 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::kernel::ModelObject
 ModelObject (kernel::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::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)

Methods to control the contained objects

This container stores a list of Pair objects. To manipulate the list use these methods.

void add_particle_pair (const kernel::ParticlePair &vt)
void add_particle_pairs (const kernel::ParticlePairsTemp &c)
void set_particle_pairs (kernel::ParticlePairsTemp c)
void clear_particle_pairs ()

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
- 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...
virtual void do_destroy ()

Constructor & Destructor Documentation

IMP::container::DynamicListPairContainer::DynamicListPairContainer ( Container scope,
std::string  name = "ListPairContainer %1%" 

Constructs the dynamic list

scopea container with a list of all possible particles that are allowed to be dynamically added or removed in this container
namethe name of this container

Member Function Documentation

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

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 67 of file DynamicListPairContainer.h.

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