 |
|
IMP Reference Guide
2.23.0
The Integrative Modeling Platform
|
Class to handle individual particles of a Model object. More...
#include <IMP/Particle.h>
Inheritance diagram for IMP::Particle:Class to handle individual particles of a Model object.
A particle is a lightweight object that serves as a place holder for the particle index in a given Model object. The Model object itself stores the particle attributes of various types: Float, Int, String, Object, and WeakObject, and any data concerning the optimization of these particles by Optimizer and Simulator classes.
Definition at line 43 of file Particle.h.
Public Member Functions | |
| Particle (Model *m, std::string name) | |
| Construct a particle and add it to the Model. More... | |
| Particle (Model *m) | |
| Construct a particle and add it to the Model. More... | |
| ParticleIndex | get_index () const |
| returns the particle index of this particle in its model 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::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... | |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| const ScoreStatesTemp & | get_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 ModelObjectsTemp | do_get_inputs () const overridefinal |
| virtual ModelObjectsTemp | do_get_outputs () const overridefinal |
| Protected Member Functions inherited from IMP::ModelObject | |
| 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 () |
| IMP::Particle::Particle | ( | Model * | m, |
| std::string | name | ||
| ) |
Construct a particle and add it to the Model.
|
finaloverrideprotectedvirtual |
Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.
Implements IMP::ModelObject.
Definition at line 158 of file Particle.h.
|
finaloverrideprotectedvirtual |
Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.
Implements IMP::ModelObject.
Definition at line 161 of file Particle.h.
| ParticleIndex IMP::Particle::get_index | ( | ) | const |
returns the particle index of this particle in its model
|
overridevirtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 50 of file Particle.h.