A decorator for helping deal with a hierarchy. More...

#include <IMP/core/Hierarchy.h>

Inheritance diagram for IMP::core::Hierarchy:

Public Types
typedef HierarchyTraits	DecoratorTraits

Public Member Functions
	Hierarchy (const IMP::kernel::ParticleAdaptor &d, const HierarchyTraits &tr=get_default_traits())

	Hierarchy (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id, const HierarchyTraits &tr=get_default_traits())

void	add_child (Hierarchy h) const

void	add_child_at (Hierarchy h, unsigned int pos)

void	clear_children ()

Hierarchy	get_child (unsigned int i) const

kernel::ParticleIndex	get_child_index (unsigned int i) const

int	get_child_index () const

GenericHierarchies	get_children () const

const DecoratorTraits &	get_decorator_traits () const

unsigned int	get_number_of_children () const

Hierarchy	get_parent () const

HierarchyTraits	get_traits ()

void	remove_child (unsigned int i)

void	remove_child (Hierarchy h)

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 Hierarchy	decorate_particle (::IMP::kernel::Particle *p, const HierarchyTraits &tr=get_default_traits())

static const DecoratorTraits &	get_default_decorator_traits ()

static const HierarchyTraits &	get_default_traits ()
	Get the default hierarchy traits.

static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p, const HierarchyTraits &tr=get_default_traits())

static bool	get_is_setup (kernel::Model *, kernel::ParticleIndex, HierarchyTraits=Hierarchy::get_default_traits())

static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi, const HierarchyTraits &tr=get_default_traits())

static bool	particle_is_instance (::IMP::kernel::Particle *p, const HierarchyTraits &tr=get_default_traits())

static Hierarchy	setup_particle (IMP::kernel::ParticleAdaptor d, DecoratorTraits tr=get_default_decorator_traits())

static Hierarchy	setup_particle (kernel::Model *m, ParticleIndex pi, DecoratorTraits tr=get_default_decorator_traits())

static Hierarchy	setup_particle (IMP::kernel::ParticleAdaptor d, kernel::ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())

static Hierarchy	setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticleIndexes children, DecoratorTraits tr=get_default_decorator_traits())

static Hierarchy	setup_particle (kernel::Model *m, ParticleIndex pi, kernel::ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())

static Hierarchy	setup_particle (IMP::kernel::ParticleAdaptor d, kernel::ParticlesTemp children, DecoratorTraits tr=get_default_decorator_traits())

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

See HierarchyTraits for an example of how to define a custom hierarchy and Hierarchy for a hierarchy for molecules.

See Also: HierarchyTraits

Definition at line 79 of file core/Hierarchy.h.

Member Function Documentation

static Hierarchy IMP::core::Hierarchy::decorate_particle	(	::IMP::kernel::Particle *	p,
		const HierarchyTraits &	tr = `get_default_traits()`
	)

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 98 of file core/Hierarchy.h.

int IMP::core::Hierarchy::get_child_index ( ) const

Return i such that get_parent().get_child(i) == this

static bool IMP::core::Hierarchy::get_is_setup	(	kernel::Model *	,
		kernel::ParticleIndex	,
		HierarchyTraits	= `Hierarchy::get_default_traits()`
	)

static

Check if the particle has the needed attributes for a cast to succeed

Definition at line 106 of file core/Hierarchy.h.

Hierarchy IMP::core::Hierarchy::get_parent ( ) const

Returns: the parent particle, or Hierarchy() if it has no parent.

Definition at line 113 of file core/Hierarchy.h.

Here is the call graph for this function:

static bool IMP::core::Hierarchy::particle_is_instance	(	::IMP::kernel::Particle *	p,
		const HierarchyTraits &	tr = `get_default_traits()`
	)

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 98 of file core/Hierarchy.h.

static bool IMP::core::Hierarchy::particle_is_instance	(	IMP::kernel::Model *	m,
		IMP::kernel::ParticleIndex	pi,
		const HierarchyTraits &	tr = `get_default_traits()`
	)

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 98 of file core/Hierarchy.h.

static Hierarchy IMP::core::Hierarchy::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		DecoratorTraits	tr = `get_default_decorator_traits()`
	)

static

Setup the particle so it can be used with this decorator.

Definition at line 99 of file core/Hierarchy.h.

static Hierarchy IMP::core::Hierarchy::setup_particle	(	kernel::Model *	m,
		ParticleIndex	pi,
		kernel::ParticleIndexes	children,
		DecoratorTraits	tr = `get_default_decorator_traits()`
	)

static

Setup the particle and add children.

Definition at line 101 of file core/Hierarchy.h.

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

core/Hierarchy.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation