 |
|
IMP Reference Guide
develop.63b38c487d,2024/12/21
The Integrative Modeling Platform
|
#include <IMP/domino/particle_states.h>
Inheritance diagram for IMP::domino::ParticleStates:Handle the states for a particular particle (or "class" of particles. For example a state enumerator class could take a bounding box and a number,n, and generate n points in the bounding box. Then the get_number function would return n and update_to_state would modify the particle to have the coordinates for state i.
Definition at line 37 of file particle_states.h.
Public Member Functions | |
| ParticleStates (std::string name="ParticleStates %1%") | |
| virtual algebra::VectorKD | get_embedding (unsigned int i) const |
| Return an embedding of the state. More... | |
| virtual unsigned int | get_nearest_state (const algebra::VectorKD &v) const |
| Return the state closest to a given embedding. More... | |
| virtual unsigned int | get_number_of_particle_states () const =0 |
| virtual void | load_particle_state (unsigned int, Particle *) const =0 |
| 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 |
Additional Inherited Members | |
| Protected Member Functions inherited from IMP::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| virtual void | do_destroy () |
|
virtual |
Return an embedding of the state.
By default this just returns a 1D vector containing the index. The vector needs to have the same dimension for each value of i.
Reimplemented in IMP::domino::NestedRigidBodyStates, IMP::domino::RigidBodyStates, and IMP::domino::XYZStates.
Definition at line 47 of file particle_states.h.
|
virtual |
Return the state closest to a given embedding.
Reimplemented in IMP::domino::NestedRigidBodyStates, IMP::domino::RigidBodyStates, and IMP::domino::XYZStates.
Definition at line 52 of file particle_states.h.