Detailed Description

Define the type for a type of hierarchy.

The hierarchy class is identified by the passed string so two hierarchies created with the same initialization string will be the same.

This example shows how to make and use a custom hierarchy:

 ## \example core/custom_hierarchy.py
 # This example shows how to create and use a custom hierarchy of particles.
 
 import IMP
 import IMP.core
 
 
 def custom_hierarchy(parent_particle, children_particles):
     tr = IMP.core.HierarchyTraits("my hierarchy")
     pd = IMP.core.Hierarchy.setup_particle(parent_particle, tr)
     for p in children_particles:
         cd = IMP.core.Hierarchy.setup_particle(p, tr)
         pd.add_child(cd)
     pd.show()
 
 m = IMP.kernel.Model()
 p1 = IMP.kernel.Particle(m)
 p2 = IMP.kernel.Particle(m)
 p3 = IMP.kernel.Particle(m)
 custom_hierarchy(p1, (p2, p3))

See Also: Hierarchy

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

Public Member Functions
	HierarchyTraits (std::string name)
	Create a HierarchyTraits with the given name. More...

kernel::ParticleIndexesKey	get_children_key () const

kernel::ParticleIndexKey	get_parent_key () const

bool	operator== (const HierarchyTraits &o) const

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

Constructor & Destructor Documentation

IMP::core::HierarchyTraits::HierarchyTraits ( std::string name )

Create a HierarchyTraits with the given name.

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

core/Hierarchy.h

Detailed Description

Public Member Functions

Constructor & Destructor Documentation