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

Inheritance diagram for IMP::core::Reference:

Public Member Functions
	Reference (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)

	Reference (const IMP::kernel::ParticleAdaptor &d)

kernel::Particle *	get_reference_particle () const

void	show (std::ostream &out=std::cout) const

Public Member Functions inherited from IMP::kernel::Decorator
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::kernel::Particle *p)

static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)

static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)

static kernel::ParticleIndexKey	get_reference_key ()

static bool	particle_is_instance (::IMP::kernel::Particle *p)

static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)

static Reference	setup_particle (IMP::kernel::ParticleAdaptor decorator, kernel::ParticleIndexAdaptor reference)

static Reference	setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticleIndexAdaptor reference)

Static Public Member Functions inherited from IMP::kernel::Decorator
static bool	get_is_setup (Particle *p)
	Return true if the particle can be cast to the decorator. More...

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

	Decorator (ParticleAdaptor p)

Detailed Description

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

Definition at line 22 of file core/symmetry.h.

Member Function Documentation

static Reference IMP::core::Reference::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 30 of file core/symmetry.h.

static bool IMP::core::Reference::particle_is_instance ( ::IMP::kernel::Particle * p )

static

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 30 of file core/symmetry.h.

static bool IMP::core::Reference::particle_is_instance	(	IMP::kernel::Model *	m,
		IMP::kernel::ParticleIndex	pi
	)

static

Deprecated:: As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 30 of file core/symmetry.h.

static Reference IMP::core::Reference::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		kernel::ParticleIndexAdaptor	reference
	)

static

Make the first particle reference the passed particle. Setup the particle so it can be used with this decorator.

Definition at line 32 of file core/symmetry.h.

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