IMP  2.2.1
The Integrative Modeling Platform
IMP::atom::Mass Class Reference

Add mass to a particle. More...

#include <IMP/atom/Mass.h>

+ Inheritance diagram for IMP::atom::Mass:

Public Member Functions

 Mass (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Mass (const IMP::kernel::ParticleAdaptor &d)
 
Float get_mass () const
 
void set_mass (Float d)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Decorator
Modelget_model () const
 Returns the Model containing the particle.
 
Particleget_particle () const
 
ParticleIndex get_particle_index () const
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static Mass decorate_particle (::IMP::kernel::Particle *p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static FloatKey get_mass_key ()
 
static Mass setup_particle (IMP::kernel::ParticleAdaptor decorator, Float mass)
 
static Mass setup_particle (kernel::Model *m, ParticleIndex pi, Float mass)
 

Additional Inherited Members

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

Detailed Description

The mass of the particle is assumed to be in Daltons.

Definition at line 23 of file Mass.h.

Member Function Documentation

static Mass IMP::atom::Mass::decorate_particle ( ::IMP::kernel::Particle p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 42 of file Mass.h.

static FloatKey IMP::atom::Mass::get_mass_key ( )
static

Get the key used to store the mass.

static Mass IMP::atom::Mass::setup_particle ( IMP::kernel::ParticleAdaptor  decorator,
Float  mass 
)
static
See Also
setup_particle(m, pi, mass )

Definition at line 44 of file Mass.h.

static Mass IMP::atom::Mass::setup_particle ( kernel::Model m,
ParticleIndex  pi,
Float  mass 
)
static

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

Definition at line 44 of file Mass.h.


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