IMP  2.1.0
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:

Public Member Functions

 SingletonContainerSet (kernel::Model *m, std::string name="SingletonContainerSet %1%")
 Construct and empty set.
 
 SingletonContainerSet (const SingletonContainersTemp &pc, std::string name="SingletonContainerSet %1%")
 
template<class M >
void apply_generic (const M *m) const
 apply modifer sm to all singleton containers
 
kernel::ParticleIndexes get_all_possible_indexes () const
 Get contained particles. More...
 
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.
 
- Public Member Functions inherited from IMP::kernel::SingletonContainer
void apply (const SingletonModifier *sm) const
 Apply a SingletonModifier to the contents.
 
void apply_generic (const SingletonModifier *m) const
 Just use apply() in the base class.
 
bool get_contains_particle (Particle *v) const
 This function is very slow and you should think hard about using it. More...
 
virtual ParticleIndexes get_indexes () const =0
 
unsigned int get_number_of_particles () const
 
Particleget_particle (unsigned int i) const
 
ParticlesTemp get_particles () const
 
virtual ParticleIndexes get_range_indexes () const =0
 
- Public Member Functions inherited from IMP::kernel::Container
virtual void do_after_evaluate (DerivativeAccumulator *accpt)
 Reset changed status.
 
ModelObjectsTemp do_get_outputs () const
 containers don't have outputs
 
ParticlesTemp get_all_possible_particles () const
 
int get_contents_version () const
 
bool get_is_changed () const
 
virtual bool get_is_decomposable () const
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (kernel::Model *m, std::string name)
 
 ScoreState (kernel::Model *m)
 
 ScoreState (std::string name="ScoreState %1%")
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed.
 
void before_evaluate ()
 Force update of the structure.
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
ContainersTemp get_output_containers () const
 
ParticlesTemp get_output_particles () const
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (kernel::Model *m, std::string name)
 
 ModelObject (std::string name)
 
virtual void do_set_model (kernel::Model *)
 
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
 
bool get_is_part_of_model () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 
void set_has_dependencies (bool tf)
 
void set_has_required_score_states (bool tf)
 
virtual void set_model (kernel::Model *m)
 
- 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)
 

Methods to control the nested container

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

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 reserve_singleton_containers (unsigned int sz)
 

Additional Inherited Members

- Public Types inherited from IMP::kernel::SingletonContainer
typedef ParticleIndex ContainedIndexType
 
typedef ParticleIndexes ContainedIndexTypes
 
typedef ParticleContainedType
 
typedef ParticlesTemp ContainedTypes
 
- Protected Member Functions inherited from IMP::kernel::SingletonContainer
 SingletonContainer (kernel::Model *m, std::string name="SingletonContainer %1%")
 
virtual void do_apply (const SingletonModifier *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%")
 
void set_is_changed (bool tf)
 Call this with true when the contents of the container change. More...
 
- Protected Member Functions inherited from IMP::kernel::ScoreState
virtual void do_before_evaluate ()=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...
 
 Object ()
 

Detailed Description

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 28 of file SingletonContainerSet.h.

Member Function Documentation

kernel::ParticleIndexes IMP::container::SingletonContainerSet::get_all_possible_indexes ( ) const
virtual

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

Implements IMP::kernel::Container.


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