IMP::core::HierarchyTraits Class Reference

Define the type for a type of hierarchy. More...

#include <IMP/core/Hierarchy.h>

Public Member Functions
	HierarchyTraits (std::string name)
	Create a HierarchyTraits with the given name.
ParticleIndexesKey	get_children_key () const
ParticleIndexKey	get_parent_key () const
bool	operator== (const HierarchyTraits &o) const
void	show (std::ostream &out=std::cout) const

Detailed Description

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.Model()
p1 = IMP.Particle(m)
p2 = IMP.Particle(m)
p3 = IMP.Particle(m)
custom_hierarchy(p1, (p2, p3))

See Also

Hierarchy

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

---

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

• core/Hierarchy.h