IMP logo
IMP Reference Guide  develop.95736ecade,2024/03/01
The Integrative Modeling Platform
IMP::pmi::Resolution Class Reference

Add resolution to a particle. More...

#include <IMP/pmi/Resolution.h>

+ Inheritance diagram for IMP::pmi::Resolution:

Detailed Description

Add resolution to a particle.

The resolution of the particle is assumed to be in number of residues (see Resolution in PMI).

Definition at line 24 of file Resolution.h.

Public Member Functions

 Resolution (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Resolution (const IMP::ParticleAdaptor &d)
 
Float get_resolution () const
 
void set_resolution (Float d)
 
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...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_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
 
Particleoperator-> () const
 

Static Public Member Functions

static bool get_is_setup (Model *m, ParticleIndex pi)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static FloatKey get_resolution_key ()
 
static Resolution setup_particle (Model *m, ParticleIndex pi, Float resolution)
 
static Resolution setup_particle (IMP::ParticleAdaptor pa, Float resolution)
 

Additional Inherited Members

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

Member Function Documentation

static Resolution IMP::pmi::Resolution::setup_particle ( IMP::ParticleAdaptor  pa,
Float  resolution 
)
static
Returns
a Resolution object that decorates the particle specified by pa
See Also
setup_particle(m, pi, resolution )

Definition at line 45 of file Resolution.h.

static Resolution IMP::pmi::Resolution::setup_particle ( Model m,
ParticleIndex  pi,
Float  resolution 
)
static

Add the specified resolution to the particle.

Returns
a Resolution object that decorates particle pi

Definition at line 45 of file Resolution.h.


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