IMP  2.0.0
The Integrative Modeling Platform
IMP::em2d::ParticlesDummyRestraint Class Reference

Dummy restraint for a set of particles. Same use as DummyRestraint.

#include <IMP/em2d/DummyRestraint.h>

+ Inheritance diagram for IMP::em2d::ParticlesDummyRestraint:

Public Member Functions

 ParticlesDummyRestraint (SingletonContainer *sc)
 
virtual void do_show (std::ostream &out) const
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
 
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms. More...
 
virtual ScoringFunctioncreate_scoring_function (double weight=1.0, double max=NO_MAX) const
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
virtual double get_last_score () const
 
double get_score () const
 
bool get_was_good () const
 
void set_weight (Float weight)
 
Float get_weight () const
 
double get_maximum_score () const
 
void set_maximum_score (double s)
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< ParticlesDummyRestraint > > 
ParticlesDummyRestraintsTemp
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::kernel::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
virtual void do_update_dependencies ()
 

Detailed Description

Definition at line 69 of file DummyRestraint.h.

Constructor & Destructor Documentation

IMP::em2d::ParticlesDummyRestraint::ParticlesDummyRestraint ( SingletonContainer sc)

Sets a dummy restraint for a set of particles

Parameters
scMust contain all the particles that are going to be restrained

Definition at line 78 of file DummyRestraint.h.

Member Function Documentation

void IMP::em2d::ParticlesDummyRestraint::show ( std::ostream &  out = std::cout) const

Shows information about the class

Parameters
outStream used to show the information

Definition at line 86 of file DummyRestraint.h.

Friends And Related Function Documentation

Pass a set of objects.

Definition at line 93 of file DummyRestraint.h.


The documentation for this class was generated from the following file: