IMP::atom::Mass Class Reference

---

Detailed Description

Add mass to a particle.

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

Examples: decay, restraint cache, rigid brownian dynamics, simulation, local fitting, analyze convergence

Inheritance diagram for IMP::atom::Mass:

List of all members.

Public Member Functions
	Mass (Model *m, ParticleIndex id)
	Mass (::IMP::Particle *p)
Float	get_mass () const
void	set_mass (Float d)
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::Decorator
std::size_t	__hash__ () const
ParticleIndex	get_particle_index () const
Particle *	get_particle () const
Model *	get_model () const
	Returns the Model containing the particle.
	Decorator (Particle *p)
	Decorator ()

Static Public Member Functions
static Mass	decorate_particle (::IMP::Particle *p)
static FloatKey	get_mass_key ()
static bool	particle_is_instance (Particle *p)
	Return true if the particle can be cast to the decorator.
static Mass	setup_particle (Particle *p, double mass)
static Decorator	setup_particle (Particle *p, extra_arguments)

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)
	Decorator (Particle *p)
int	compare (base::Object *o) const

---

Member Function Documentation

static bool IMP::atom::Mass::particle_is_instance ( Particle *  p )

static

Return true if the particle can be cast to the decorator.

That is, if particle_is_instance() returns true, then it is legal to construct an instance of the decorator with that particle. If not, setup_particle() must be called first.

  IMP::Particle *p = new IMP::Particle(m);
  // it is false
  std::cout << IMP::core::XYZ::particle_is_instance(p) << std::endl;
  // As a result this is an error
  IMP::core::XYZ d(p);
  // now set it up
  IMP::core::XYZ(p);
  // now it is true
  std::cout << IMP::core::XYZ::particle_is_instance(p) << std::endl;
  // and now this code is OK
  IMP::core::XYZ d(p);

Reimplemented from IMP::Decorator.

---

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

• Mass.h