IMP::core::Reference Class Reference

---

Detailed Description

A a decorator for a particle with an associated reference particle.

This decorator is primarily designed to be used for implementing symmetry.

Examples: symmetry

Inheritance diagram for IMP::core::Reference:

List of all members.

Public Member Functions
	Reference (Model *m, ParticleIndex id)
	Reference (::IMP::Particle *p)
Particle *	get_reference_particle () const
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 Reference	decorate_particle (::IMP::Particle *p)
static ParticleKey	get_reference_key ()
static bool	particle_is_instance (Particle *p)
	Return true if the particle can be cast to the decorator.
static Reference	setup_particle (Particle *p, Particle *ref)
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::core::Reference::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.

static Reference IMP::core::Reference::setup_particle ( Particle *  p, Particle *  ref  )

static

Create a decorator with the passed reference particle.

---

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

• symmetry.h