IMP logo
IMP Reference Guide  develop.29b24c6ad6,2021/05/15
The Integrative Modeling Platform
IMP::SingletonContainer Class Referenceabstract

A shared container for Singletons. More...

#include <IMP/SingletonContainer.h>

+ Inheritance diagram for IMP::SingletonContainer:

Detailed Description

A shared container for Singletons.

Stores a shared collection of Singletons.

Definition at line 37 of file SingletonContainer.h.

Public Types

typedef ParticleIndex ContainedIndexType
typedef ParticleIndexes ContainedIndexTypes
typedef ParticleContainedType
typedef ParticlesTemp ContainedTypes
typedef SingletonModifier Modifier
typedef ParticleIndex PassContainedIndexType

Public Member Functions

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...
const ParticleIndexesget_contents () const
virtual ParticleIndexes get_indexes () const =0
ParticlesTemp get_particles () const
virtual ParticleIndexes 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
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
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)
virtual std::string get_type_name () const

Protected Member Functions

 SingletonContainer (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::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::SingletonContainer::apply ( const SingletonModifier sm) const

Apply a SingletonModifier to the contents.

void IMP::SingletonContainer::apply_generic ( const SingletonModifier m) const

Just use apply() in the base class.

virtual ParticleIndexes IMP::SingletonContainer::get_indexes ( ) const
pure virtual

Get all the indexes contained in the container.

This should be protected but isn't for compatibility reasons.

External callers should use get_contents().

ParticlesTemp IMP::SingletonContainer::get_particles ( ) const
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_contents() instead.
virtual ParticleIndexes IMP::SingletonContainer::get_range_indexes ( ) const
pure virtual

Get all the indexes that might possibly be contained in the container, useful with dynamic containers. For example, with a container::ClosePairContainer, this is the list of all pairs taken from the input list (those that are far apart in addition to those that are close).

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