IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
version 2.13.0
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-2020 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 
16 IMPCORE_BEGIN_NAMESPACE
17 
18 class HierarchyTraits;
19 
20 //! Return the hierarchy children of a particle.
21 /** \ingroup hierarchy
22  A simple example using is
23  \include cover_particles.py
24  \see Hierarchy
25  \see Hierarchy
26 */
27 class IMPCOREEXPORT ChildrenRefiner : public Refiner {
28 
29  HierarchyTraits traits_;
30 
31  public:
32  //! Create a refiner for a particular type of hierarchy
33  ChildrenRefiner(HierarchyTraits tr);
34 
35  virtual bool get_can_refine(Particle *) const IMP_OVERRIDE;
36  virtual const ParticlesTemp get_refined(Particle *) const
37  IMP_OVERRIDE;
38 #ifndef SWIG
39  using Refiner::get_refined;
40 #endif
41  virtual ModelObjectsTemp do_get_inputs(
42  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
43  IMP_OBJECT_METHODS(ChildrenRefiner);
44 };
45 
46 IMPCORE_END_NAMESPACE
47 
48 #endif /* IMPCORE_CHILDREN_REFINER_H */
IMP::core::ChildrenRefiner
Return the hierarchy children of a particle.
Definition: ChildrenRefiner.h:27
Hierarchy.h
Decorator for helping deal with a hierarchy.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
IMP::Refiner::get_can_refine
virtual bool get_can_refine(Particle *) const
Return true if this refiner can refine that particle.
Definition: Refiner.h:51
Refiner.h
Refine a particle into a list of particles.
IMP::core::HierarchyTraits
Define the type for a type of hierarchy.
Definition: core/Hierarchy.h:47
IMP::ParticleInputs::do_get_inputs
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
IMP::Refiner::get_refined
virtual const ParticlesTemp get_refined(Particle *a) const =0
Refine the passed particle into a set of particles.
IMP::Refiner
Abstract class to implement hierarchical methods.
Definition: Refiner.h:34
IMP::Particle
Class to handle individual particles of a Model object.
Definition: Particle.h:41
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78