IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
WeightRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/isd/WeightRestraint.h
3  * \brief Put description here
4  *
5  * Copyright 2007-2015 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPISD_WEIGHT_RESTRAINT_H
10 #define IMPISD_WEIGHT_RESTRAINT_H
11 #include <IMP/isd/Scale.h>
12 #include "isd_config.h"
13 #include <IMP/Restraint.h>
14 
15 IMPISD_BEGIN_NAMESPACE
16 /** A restraint for in-vivo ensemble FRET data
17  */
18 
19 class IMPISDEXPORT WeightRestraint : public Restraint {
20  Particle *w_;
21  Float wmin_;
22  Float wmax_;
23  Float kappa_;
24 
25  public:
26  //! Create the restraint.
27  /** Restraints should store the particles they are to act on,
28  preferably in a Singleton or PairContainer as appropriate.
29  */
30 
31  WeightRestraint(Particle *w, Float wmin, Float wmax, Float kappa);
32 
33  /** This macro declares the basic needed methods: evaluate and show
34  */
35  virtual double unprotected_evaluate(IMP::DerivativeAccumulator *accum)
36  const IMP_OVERRIDE;
37  virtual IMP::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
38  IMP_OBJECT_METHODS(WeightRestraint);
39 };
40 
41 IMPISD_END_NAMESPACE
42 
43 #endif /* IMPISD_WEIGHT_RESTRAINT_H */
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
Scale.h
A decorator for scale parameters particles.
IMP::Float
double Float
Basic floating-point value (could be float, double...)
Definition: types.h:20
IMP::Particle
Class to handle individual model particles.
Definition: Particle.h:37
Restraint.h
Abstract base class for all restraints.
IMP::ModelObject::do_get_inputs
virtual ModelObjectsTemp do_get_inputs() const =0
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:80
IMP::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition: DerivativeAccumulator.h:25
IMP::Restraint
A restraint is a term in an IMP ScoringFunction.
Definition: Restraint.h:52