IMP::atom::Mass Class Reference

Add mass to a particle. More...

#include <IMP/atom/Mass.h>

Inheritance diagram for IMP::atom::Mass:

Detailed Description

Add mass to a particle.

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

Definition at line 23 of file Mass.h.

Public Member Functions
	Mass (::IMP::Model *m,::IMP::ParticleIndex id)
	Mass (const IMP::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::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 (Model *m, ParticleIndex pi)
static bool	get_is_setup (const IMP::ParticleAdaptor &p)
static FloatKey	get_mass_key ()
static Mass	setup_particle (Model *m, ParticleIndex pi, Float mass)
static Mass	setup_particle (IMP::ParticleAdaptor pa, Float mass)
static Mass	setup_particle (IMP::ParticleAdaptor pa, Mass other)
static Mass	setup_particle (Model *m, ParticleIndex pi, Mass other)

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

Member Function Documentation

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

static

Get the key used to store the mass.

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

static

Add the specified mass to the particle.

Returns

a Mass object that decorates particle pi

Definition at line 48 of file Mass.h.

static Mass IMP::atom::Mass::setup_particle ( IMP::ParticleAdaptor  pa, Float  mass  )

static

Returns

a Mass object that decorates the particle specified by pa

See Also

setup_particle(m, pi, mass )

Definition at line 48 of file Mass.h.

static Mass IMP::atom::Mass::setup_particle ( Model *  m, ParticleIndex  pi, Mass  other  )

static

Returns

a Mass object that decorates particle pi

Definition at line 49 of file Mass.h.

static Mass IMP::atom::Mass::setup_particle ( IMP::ParticleAdaptor  pa, Mass  other  )

static

Returns

a Mass object that decorates the particle specified by pa

See Also

setup_particle(m, pi, other )

Definition at line 49 of file Mass.h.

---

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

• Mass.h