IMP logo
IMP Reference Guide  develop.d97d4ead1f,2024/11/21
The Integrative Modeling Platform
version 20241121.develop.d97d4ead1f
BondEndpointsRefiner.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/BondEndpointsRefiner.h
3  * \brief Return the endpoints of a bond.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPATOM_BOND_ENDPOINTS_REFINER_H
9 #define IMPATOM_BOND_ENDPOINTS_REFINER_H
10 
11 #include <IMP/atom/atom_config.h>
12 #include <IMP/Refiner.h>
13 
14 IMPATOM_BEGIN_NAMESPACE
15 
16 //! Return the endpoints of a bond.
17 /** \ingroup bond
18  \see Bond
19  */
20 class IMPATOMEXPORT BondEndpointsRefiner : public Refiner {
21  public:
22  //! no arguments
23  BondEndpointsRefiner();
24 
25  virtual bool get_can_refine(Particle *) const override;
26  virtual const ParticlesTemp get_refined(Particle *) const
27  override;
28 #ifndef SWIG
29  using Refiner::get_refined;
30 #endif
31  virtual ModelObjectsTemp do_get_inputs(
32  Model *m, const ParticleIndexes &pis) const override;
33  IMP_OBJECT_METHODS(BondEndpointsRefiner);
34 };
35 
36 IMP_OBJECTS(BondEndpointsRefiner, BondEndpointsRefiners);
37 
38 IMPATOM_END_NAMESPACE
39 
40 #endif /* IMPATOM_BOND_ENDPOINTS_REFINER_H */
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: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_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
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
IMP::atom::BondEndpointsRefiner
Return the endpoints of a bond.
Definition: BondEndpointsRefiner.h:20