IMP logo
IMP Reference Guide  develop.1a86c4215a,2024/04/24
The Integrative Modeling Platform
version 20240424.develop.1a86c4215a
RigidLeavesRefiner.h
Go to the documentation of this file.
1 /**
2  * \file IMP/multifit/RigidLeavesRefiner.h
3  * \brief Return all rigid body members that are also hierarchy leaves.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPMULTIFIT_RIGID_LEAVES_REFINER_H
10 #define IMPMULTIFIT_RIGID_LEAVES_REFINER_H
11 
12 #include <IMP/Refiner.h>
13 #include <IMP/multifit/multifit_config.h>
14 
15 IMPMULTIFIT_BEGIN_NAMESPACE
16 
17 //! Return all rigid body members that are also hierarchy leaves.
18 class IMPMULTIFITEXPORT RigidLeavesRefiner : public Refiner {
19  public:
20  RigidLeavesRefiner(std::string name = "RigidLeavesRefiner%d")
21  : Refiner(name) {}
22  virtual bool get_can_refine(Particle *) const override;
23 #ifndef SWIG
24  using Refiner::get_refined;
25 #endif
26  virtual const ParticlesTemp get_refined(Particle *) const override;
27  virtual ModelObjectsTemp do_get_inputs(
28  Model *m, const ParticleIndexes &pis) const override;
29  IMP_OBJECT_METHODS(RigidLeavesRefiner);
30 };
31 
32 IMPMULTIFIT_END_NAMESPACE
33 
34 #endif /* IMPMULTIFIT_RIGID_LEAVES_REFINER_H */
IMP::Refiner::Refiner
Refiner(std::string name="Refiner %1%", bool is_by_ref=false)
Constructs the refiner.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::multifit::RigidLeavesRefiner
Return all rigid body members that are also hierarchy leaves.
Definition: RigidLeavesRefiner.h:18
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:86
IMP::Refiner::get_can_refine
virtual bool get_can_refine(Particle *) const
Return true if this refiner can refine that particle.
Definition: Refiner.h:52
Refiner.h
Refine a particle into a list of particles.
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:43