IMP  2.0.0
The Integrative Modeling Platform
IMP::core::Reference Class Reference

A a decorator for a particle with an associated reference particle. More...

#include <IMP/core/symmetry.h>

+ Inheritance diagram for IMP::core::Reference:

Public Member Functions

 Reference (Model *m, ParticleIndex id)
 
 Reference (::IMP::kernel::Particle *p)
 
Particleget_reference_particle () const
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Decorator
ParticleIndex get_particle_index () const
 
Particleget_particle () const
 
Modelget_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static Reference decorate_particle (::IMP::kernel::Particle *p)
 
static ParticleIndexKey get_reference_key ()
 
static bool particle_is_instance (Particle *p)
 
static Reference setup_particle (Particle *p, Particle *ref)
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool particle_is_instance (Particle *p)
 Return true if the particle can be cast to the decorator. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::kernel::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (Particle *p)
 

Detailed Description

This decorator is primarily designed to be used for implementing symmetry.

Definition at line 22 of file symmetry.h.

Member Function Documentation

static Reference IMP::core::Reference::setup_particle ( Particle p,
Particle ref 
)
static

Create a decorator with the passed reference particle.

Definition at line 29 of file symmetry.h.


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