IMP  2.3.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-2014 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 /**
18  \ingroup bond
19  \see Bond
20  */
21 class IMPATOMEXPORT BondEndpointsRefiner : public Refiner {
22  public:
23  //! no arguments
24  BondEndpointsRefiner();
25 
26  virtual bool get_can_refine(kernel::Particle *) const IMP_OVERRIDE;
27  virtual const kernel::ParticlesTemp get_refined(kernel::Particle *) const
28  IMP_OVERRIDE;
29 #ifndef SWIG
30  using Refiner::get_refined;
31 #endif
32  virtual kernel::ModelObjectsTemp do_get_inputs(
33  kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE;
34  IMP_OBJECT_METHODS(BondEndpointsRefiner);
35 };
36 
37 IMP_OBJECTS(BondEndpointsRefiner, BondEndpointsRefiners);
38 
39 IMPATOM_END_NAMESPACE
40 
41 #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_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
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:51
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::kernel::Particle
Class to handle individual model particles.
Definition: kernel/Particle.h:37
IMP_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing sets of objects.
Definition: object_macros.h:52
IMP::atom::BondEndpointsRefiner
Return the endpoints of a bond.
Definition: BondEndpointsRefiner.h:21
IMP::kernel::Refiner
Abstract class to implement hierarchical methods.
Definition: kernel/Refiner.h:34
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:75
IMP::kernel::Model
Class for storing model, its restraints, constraints, and particles.
Definition: kernel/Model.h:73