IMP  2.1.0
The Integrative Modeling Platform
Public Member Functions | List of all members
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.
 
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
 

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:

1 ## \example core/custom_hierarchy.py
2 # This example shows how to create and use a custom hierarchy of particles.
3 
4 import IMP
5 import IMP.core
6 
7 
8 def custom_hierarchy(parent_particle, children_particles):
9  tr = IMP.core.HierarchyTraits("my hierarchy")
10  pd = IMP.core.Hierarchy.setup_particle(parent_particle, tr)
11  for p in children_particles:
12  cd = IMP.core.Hierarchy.setup_particle(p, tr)
13  pd.add_child(cd)
14  pd.show()
15 
16 m = IMP.kernel.Model()
17 p1 = IMP.kernel.Particle(m)
18 p2 = IMP.kernel.Particle(m)
19 p3 = IMP.kernel.Particle(m)
20 custom_hierarchy(p1, (p2, p3))
See Also
Hierarchy

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

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