IMP logo
IMP Reference Guide  develop.cb469e0f11,2024/05/28
The Integrative Modeling Platform
IMP::container::SingletonContainerSet Class Reference

Stores a set of SingletonContainers. More...

#include <IMP/container/SingletonContainerSet.h>

+ Inheritance diagram for IMP::container::SingletonContainerSet:

Detailed Description

Stores a set of SingletonContainers.

The input sets must be disjoint. This can change if there is demand for it.

Note
The maintenance of the invariant is done by an associated IMP::Constraint. As a result, the state is only guaranteed to be correct either during model evaluation, or immediately following model evaluation before any particles have been changed.

Definition at line 29 of file SingletonContainerSet.h.

Public Member Functions

 SingletonContainerSet (Model *m, std::string name="SingletonContainerSet %1%")
 Construct an empty set. More...
 
 SingletonContainerSet (const SingletonContainersTemp &pc, std::string name="SingletonContainerSet %1%")
 
template<class M >
void apply_generic (const M *m) const
 apply modifier sm to all singleton containers More...
 
template<class M >
void apply_generic_moved (const M *m, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const
 
ParticleIndexes get_all_possible_indexes () const override
 Get contained particles. More...
 
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...
 
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)
 

Protected Member Functions

virtual void get_indexes_in_place (ParticleIndexes &output) const override
 
- 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%")
 
- 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 ()
 

Methods to control the nested container

This container merges a set of nested containers. To add or remove nested containers, use the methods below.

list singleton_containers
 A Python list of SingletonContainers More...
 
void remove_singleton_container (SingletonContainer *d)
 
void remove_singleton_containers (const SingletonContainers &d)
 
void set_singleton_containers (const SingletonContainers &ps)
 
void set_singleton_containers_order (const SingletonContainers &objs)
 
unsigned int add_singleton_container (SingletonContainer *obj)
 
void add_singleton_containers (const SingletonContainers &objs)
 
void clear_singleton_containers ()
 
unsigned int get_number_of_singleton_containers () const
 
bool get_has_singleton_containers ()
 
SingletonContainerget_singleton_container (unsigned int i) const
 
SingletonContainers get_singleton_containers () const
 
void erase_singleton_container (unsigned int i)
 
void reserve_singleton_containers (unsigned int sz)
 

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
 

Constructor & Destructor Documentation

IMP::container::SingletonContainerSet::SingletonContainerSet ( Model m,
std::string  name = "SingletonContainerSet %1%" 
)

Construct an empty set.

Member Function Documentation

template<class M >
void IMP::container::SingletonContainerSet::apply_generic ( const M *  m) const

apply modifier sm to all singleton containers

Definition at line 52 of file SingletonContainerSet.h.

+ Here is the call graph for this function:

ParticleIndexes IMP::container::SingletonContainerSet::get_all_possible_indexes ( ) const
overridevirtual

Get contained particles.

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

Implements IMP::Container.

virtual void IMP::container::SingletonContainerSet::get_indexes_in_place ( ParticleIndexes output) const
overrideprotectedvirtual

Insert the contents of the container into output instead of output's current content

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 63 of file SingletonContainerSet.h.

Member Data Documentation

list IMP::container::SingletonContainerSet::singleton_containers

A Python list of SingletonContainers

Note
This class member is only available in Python.

Definition at line 78 of file SingletonContainerSet.h.


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