 |
IMP
2.1.0
The Integrative Modeling Platform
|
|
IMP
2.1.0
The Integrative Modeling Platform
|
Abstract class for containers of particles. More...
#include <IMP/kernel/container_base.h>
Inheritance diagram for IMP::kernel::Container:Public Member Functions | |
| virtual void | do_after_evaluate (DerivativeAccumulator *accpt) |
| Reset changed status. | |
| ModelObjectsTemp | do_get_outputs () const |
| containers don't have outputs | |
| virtual ParticleIndexes | get_all_possible_indexes () const =0 |
| Get contained particles. More... | |
| 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 |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| const ScoreStatesTemp & | get_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 |
| virtual VersionInfo | get_version_info () const |
| Get information about the module and version of the object. | |
| 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 | |
| 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 () | |
Containers store sets of tuples of particles. The degree of the tuple (i.e. whether each tuple contains one, two, three or four particles) is constant for each container. That is, a SingletonContainer is a set of single particles, a PairContainer is a set of pairs of particles etc.
These sets can come from a variety of sources, such as
Most basically, containers allow you to get their contents (eg SingletonContainer::get_indexes()) or do an operation on their contents IMP_CONTAINER_FOREACH().
Definition at line 44 of file kernel/container_base.h.
|
pure virtual |
Get a list of all particles contained in this one, given that the input containers are up to date.
Implemented in IMP::container::ExclusiveConsecutivePairContainer, IMP::container::ClosePairContainer, IMP::container::CloseBipartitePairContainer, IMP::container::ConnectingPairContainer, IMP::container::ConsecutivePairContainer, IMP::atom::BondPairContainer, IMP::container::AllBipartitePairContainer, IMP::container::AllPairContainer, IMP::container::PairContainerSet, IMP::container::QuadContainerSet, IMP::container::SingletonContainerSet, and IMP::container::TripletContainerSet.
| ParticlesTemp IMP::kernel::Container::get_all_possible_particles | ( | ) | const |
Definition at line 111 of file kernel/container_base.h.
Here is the call graph for this function:| int IMP::kernel::Container::get_contents_version | ( | ) | const |
Return a counter that can be used to detect when the contents of the container changed. Store the value and then compare against the version next time to detect if it is different. It is initially 0.
Definition at line 85 of file kernel/container_base.h.
| bool IMP::kernel::Container::get_is_changed | ( | ) | const |
Return true if the container changed since the last evaluate.
|
virtual |
True if the container's contents are not independent from one another, and so it cannot be decomposed into a sum of terms. Examples include connectivity.
Definition at line 98 of file kernel/container_base.h.
|
protected |
See get_contents_version() to monitor the container for changes.
Static containers should call this in their constructor.