IMP logo
IMP Reference Guide  develop.e1fe35f,2019/09/16
The Integrative Modeling Platform
IMP::pmi::Uncertainty Class Reference

Add uncertainty to a particle. More...

#include <IMP/pmi/Uncertainty.h>

+ Inheritance diagram for IMP::pmi::Uncertainty:

Detailed Description

Add uncertainty to a particle.

The uncertainty of the particle can be assumed to be the radius of a particle.

Definition at line 24 of file Uncertainty.h.

Public Member Functions

 Uncertainty (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Uncertainty (const IMP::ParticleAdaptor &d)
 
Float get_uncertainty () const
 
void set_uncertainty (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_uncertainty_key ()
 
static Uncertainty setup_particle (Model *m, ParticleIndex pi, Float uncertainty)
 
static Uncertainty setup_particle (IMP::ParticleAdaptor decorator, Float uncertainty)
 

Additional Inherited Members

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

Member Function Documentation

static Uncertainty IMP::pmi::Uncertainty::setup_particle ( IMP::ParticleAdaptor  decorator,
Float  uncertainty 
)
static
See Also
setup_particle(m, pi, uncertainty )

Definition at line 45 of file Uncertainty.h.

static Uncertainty IMP::pmi::Uncertainty::setup_particle ( Model m,
ParticleIndex  pi,
Float  uncertainty 
)
static

Add the specified Uncertainty to the particle. Setup the particle so that it can be used with this decorator

Definition at line 45 of file Uncertainty.h.


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