IMP logo
IMP Reference Guide  2.5.0
The Integrative Modeling Platform
IMP::atom::WritePDBOptimizerState Class Reference

#include <IMP/atom/pdb.h>

+ Inheritance diagram for IMP::atom::WritePDBOptimizerState:

Detailed Description

This writes a PDB file at the specified interval during optimization. If the file name contains %1% then a new file is written each time with the %1% replaced by the index. Otherwise a new model is written each time to the same file.

Definition at line 455 of file pdb.h.

Public Member Functions

 WritePDBOptimizerState (Model *m, const ParticleIndexesAdaptor &pis, std::string filename)
 WritePDBOptimizerState (const atom::Hierarchies mh, std::string filename)
virtual std::string get_type_name () const
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
- Public Member Functions inherited from IMP::OptimizerState
 OptimizerState (Model *m, std::string name)
unsigned int get_number_of_updates () const
 Return the number of times update has been called. More...
Optimizerget_optimizer () const
unsigned int get_period () const
virtual void reset ()
virtual void set_is_optimizing (bool)
void set_number_of_updates (unsigned int n)
 Set the counter. More...
void set_period (unsigned int p)
virtual void update ()
 Called when the Optimizer accepts a new conformation. More...
void update_always ()
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
bool get_has_required_score_states () const
 Return whether score states are computed. More...
ModelObjectsTemp get_inputs () const
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
Modelget_model () const
ModelObjectsTemp get_outputs () const
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
CheckLevel get_check_level () const
LogLevel get_log_level () const
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)

Protected Member Functions

virtual ModelObjectsTemp do_get_inputs () const
virtual void do_update (unsigned int call)
- Protected Member Functions inherited from IMP::OptimizerState
virtual ModelObjectsTemp do_get_outputs () const
virtual void do_set_is_optimizing (bool)
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
virtual void handle_set_has_required_score_states (bool)
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
virtual void do_destroy ()

Member Function Documentation

virtual ModelObjectsTemp IMP::atom::WritePDBOptimizerState::do_get_inputs ( ) const

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Reimplemented from IMP::OptimizerState.

virtual void IMP::atom::WritePDBOptimizerState::do_update ( unsigned int  )

This method is called every get_period() update calls. The number of times this method has been called since the last reset or start of the optimization run is passed.

Reimplemented from IMP::OptimizerState.

virtual ::IMP::VersionInfo IMP::atom::WritePDBOptimizerState::get_version_info ( ) const

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 468 of file pdb.h.

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