IMP logo
IMP Reference Guide  develop.f6c15b4169,2024/11/06
The Integrative Modeling Platform
IMP::container::DynamicListSingletonContainer Class Reference

Store a ParticleIndexes. More...

#include <IMP/container/DynamicListSingletonContainer.h>

+ Inheritance diagram for IMP::container::DynamicListSingletonContainer:

Detailed Description

Store a ParticleIndexes.

In contrast to ListSingletonContainer, 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 DynamicListSingletonContainer.h.

Public Member Functions

 DynamicListSingletonContainer (Container *scope, std::string name="ListSingletonContainer %1%")
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::SingletonContainer
void apply (const SingletonModifier *sm) const
 Apply a SingletonModifier to the contents. More...
 
void apply_generic (const SingletonModifier *m) const
 Just use apply() in the base class. More...
 
void apply_generic_moved (const SingletonModifier *m, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
 Just use apply_moved() in the base class. More...
 
void apply_moved (const SingletonModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
 Apply a SingletonModifier to the contents. More...
 
const ParticleIndexesget_contents () const
 
virtual ParticleIndexes get_indexes () const =0
 
virtual ParticleIndexes get_range_indexes () const =0
 
- Public Member Functions inherited from IMP::Container
ModelObjectsTemp do_get_outputs () const override
 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)
 

Methods to control the contained objects

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

void add (ParticleIndex vt)
 Add a single ParticleIndex to the container. More...
 
void add (const ParticleIndexes &c)
 Add ParticleIndexes to the container. More...
 
void set (ParticleIndexes cp)
 Set the contents of the container to the given ParticleIndexes. More...
 
void clear ()
 Clear the contents of the container. More...
 

Additional Inherited Members

- Public Types inherited from IMP::SingletonContainer
typedef ParticleIndex ContainedIndexType
 
typedef ParticleIndexes ContainedIndexTypes
 
typedef ParticleContainedType
 
typedef ParticlesTemp ContainedTypes
 
typedef SingletonModifier Modifier
 
typedef ParticleIndex PassContainedIndexType
 
- Protected Member Functions inherited from IMP::SingletonContainer
 SingletonContainer (Model *m, std::string name="SingletonContainer %1%")
 
virtual void do_apply (const SingletonModifier *sm) const =0
 
virtual void do_apply_moved (const SingletonModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
 
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 ()
 

Constructor & Destructor Documentation

IMP::container::DynamicListSingletonContainer::DynamicListSingletonContainer ( Container scope,
std::string  name = "ListSingletonContainer %1%" 
)

Constructs the dynamic list

Parameters
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

void IMP::container::DynamicListSingletonContainer::add ( ParticleIndex  vt)

Add a single ParticleIndex to the container.

void IMP::container::DynamicListSingletonContainer::add ( const ParticleIndexes c)

Add ParticleIndexes to the container.

void IMP::container::DynamicListSingletonContainer::clear ( )

Clear the contents of the container.

virtual ::IMP::VersionInfo IMP::container::DynamicListSingletonContainer::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 78 of file DynamicListSingletonContainer.h.

void IMP::container::DynamicListSingletonContainer::set ( ParticleIndexes  cp)

Set the contents of the container to the given ParticleIndexes.


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