 |
|
IMP Reference Guide
2.11.0
The Integrative Modeling Platform
|
A particle that has an associated reference particle. More...
#include <IMP/core/symmetry.h>
Inheritance diagram for IMP::core::Reference:A particle that has an associated reference particle.
This decorator is primarily designed to be used for implementing symmetry.
Definition at line 23 of file core/symmetry.h.
Public Member Functions | |
| Reference (::IMP::Model *m,::IMP::ParticleIndex id) | |
| Reference (const IMP::ParticleAdaptor &d) | |
| Particle * | get_reference_particle () const |
| void | show (std::ostream &out=std::cout) const |
| Public Member Functions inherited from IMP::Decorator | |
| bool | get_is_valid () const |
| Returns true if constructed with a non-default constructor. More... | |
| Model * | get_model () const |
| Returns the Model containing the particle. More... | |
| Particle * | get_particle () const |
| Returns the particle decorated by this decorator. More... | |
| ParticleIndex | get_particle_index () const |
| Returns the particle index decorated by this decorator. More... | |
| operator Particle * () const | |
| operator ParticleIndex () const | |
| Particle * | operator-> () const |
Static Public Member Functions | |
| static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
| static bool | get_is_setup (Model *m, ParticleIndex pi) |
| static ParticleIndexKey | get_reference_key () |
| static Reference | setup_particle (IMP::ParticleAdaptor decorator, ParticleIndexAdaptor reference) |
| static Reference | setup_particle (Model *m, ParticleIndex pi, ParticleIndexAdaptor reference) |
Additional Inherited Members | |
| Protected Member Functions inherited from IMP::Decorator | |
| Decorator (Model *m, ParticleIndex pi) | |
| Decorator (ParticleAdaptor p) | |
|
static |
Definition at line 32 of file core/symmetry.h.
|
static |
Make the first particle reference the passed particle. Setup the particle so that it can be used with this decorator
Definition at line 32 of file core/symmetry.h.