IMP logo
IMP Reference Guide  2.9.0
The Integrative Modeling Platform
Edit on GitHub version 2.9.0
BondedPairFilter.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/BondedPairFilter.h
3  * \brief A fake container for bonds
4  *
5  * Copyright 2007-2018 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPATOM_BONDED_PAIR_FILTER_H
9 #define IMPATOM_BONDED_PAIR_FILTER_H
10 
11 #include <IMP/atom/atom_config.h>
12 #include "bond_decorators.h"
13 #include <IMP/PairPredicate.h>
14 #include <IMP/pair_macros.h>
15 IMPATOM_BEGIN_NAMESPACE
16 
17 //! A filter for bonds.
18 /** This is to be used with a core::ClosePairsScoreState to exclude all
19  bonded pairs.
20  \ingroup bond
21  \see Bonded
22  */
23 class IMPATOMEXPORT BondedPairFilter : public PairPredicate {
24  public:
25  //! no arguments
26  BondedPairFilter();
27 
28  virtual int get_value_index(Model *m,
29  const ParticleIndexPair &p) const
30  IMP_OVERRIDE;
31  virtual ModelObjectsTemp do_get_inputs(
32  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
33  IMP_PAIR_PREDICATE_METHODS(BondedPairFilter);
34  IMP_OBJECT_METHODS(BondedPairFilter);
35  ;
36 };
37 
38 IMP_OBJECTS(BondedPairFilter, BondedPairFilters);
39 
40 IMPATOM_END_NAMESPACE
41 
42 #endif /* IMPATOM_BONDED_PAIR_FILTER_H */
IMP::PairPredicate::get_value_index
virtual int get_value_index(Model *m, const ParticleIndexPair &vt) const
Compute the predicate and the derivative if needed.
pair_macros.h
Macros for various classes.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::Vector
A more IMP-like version of the std::vector.
Definition: Vector.h:39
bond_decorators.h
Contains decorators for a bond.
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
PairPredicate.h
Define PairPredicate.
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_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
IMP::PairPredicate
Abstract predicate function.
Definition: PairPredicate.h:31
IMP::atom::BondedPairFilter
A filter for bonds.
Definition: BondedPairFilter.h:23
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:80
IMP_PAIR_PREDICATE_METHODS
#define IMP_PAIR_PREDICATE_METHODS(Name)
Define extra the functions needed for a PairPredicate.
Definition: pair_macros.h:47