IMP  2.1.0
The Integrative Modeling Platform
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-2013 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 
13 #include <IMP/Refiner.h>
14 #include <IMP/refiner_macros.h>
15 IMPATOM_BEGIN_NAMESPACE
16 
17 //! Return the endpoints of a bond.
18 /**
19  \ingroup bond
20  \see Bond
21  */
22 class IMPATOMEXPORT BondEndpointsRefiner : public Refiner {
23  public:
24  //! no arguments
25  BondEndpointsRefiner();
26 
27  virtual bool get_can_refine(kernel::Particle *) const IMP_OVERRIDE;
28  virtual const kernel::ParticlesTemp get_refined(kernel::Particle *) const
29  IMP_OVERRIDE;
30 #ifndef SWIG
31  using Refiner::get_refined;
32 #endif
33  virtual kernel::ModelObjectsTemp do_get_inputs(
34  kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE;
35  IMP_OBJECT_METHODS(BondEndpointsRefiner);
36 };
37 
38 IMP_OBJECTS(BondEndpointsRefiner, BondEndpointsRefiners);
39 
40 IMPATOM_END_NAMESPACE
41 
42 #endif /* IMPATOM_BOND_ENDPOINTS_REFINER_H */
IMP::kernel::Refiner::get_refined
virtual const ParticlesTemp get_refined(Particle *a) const =0
Refine the passed particle into a set of particles.
IMP::kernel::Refiner::get_can_refine
virtual bool get_can_refine(Particle *) const
Return true if this refiner can refine that particle.
Definition: kernel/Refiner.h:38
Refiner.h
Import IMP/kernel/Refiner.h in the namespace.
IMP::kernel::ParticleInputs::do_get_inputs
virtual ModelObjectsTemp do_get_inputs(kernel::Model *m, const ParticleIndexes &pis) const
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: base/object_macros.h:25
IMP::kernel::Particle
Class to handle individual model particles.
Definition: kernel/declare_Particle.h:34
refiner_macros.h
Import IMP/kernel/refiner_macros.h in the namespace.
IMP_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Definition: base/object_macros.h:77
IMP::atom::BondEndpointsRefiner
Return the endpoints of a bond.
Definition: BondEndpointsRefiner.h:22
IMP::kernel::Refiner
Abstract class to implement hierarchical methods.
Definition: kernel/Refiner.h:30
IMP::kernel::Model
Class for storing model, its restraints, constraints, and particles.
Definition: kernel/declare_Model.h:72