IMP  2.0.1
The Integrative Modeling Platform
ChildrenRefiner.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/ChildrenRefiner.h
3  * \brief Return the hierarchy children of a particle.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_CHILDREN_REFINER_H
9 #define IMPCORE_CHILDREN_REFINER_H
10 
11 #include <IMP/core/core_config.h>
12 #include "Hierarchy.h"
13 
14 #include <IMP/Refiner.h>
15 #include <IMP/refiner_macros.h>
16 
17 IMPCORE_BEGIN_NAMESPACE
18 
19 class HierarchyTraits;
20 
21 //! Return the hierarchy children of a particle.
22 /** \ingroup hierarchy
23  A simple example using is
24  \pythonexample{cover_particles}
25  \see Hierarchy
26  \see Hierarchy
27 */
28 class IMPCOREEXPORT ChildrenRefiner : public Refiner
29 {
30 
31  HierarchyTraits traits_;
32 public:
33  //! Create a refiner for a particular type of hierarchy
35 
37 };
38 
39 IMPCORE_END_NAMESPACE
40 
41 #endif /* IMPCORE_CHILDREN_REFINER_H */