IMP  2.3.0
The Integrative Modeling Platform
IMP::display::WriteOptimizerState Class Reference

#include <IMP/display/LogOptimizerState.h>

+ Inheritance diagram for IMP::display::WriteOptimizerState:

Detailed Description

Write to a Writer periodically.

Definition at line 24 of file LogOptimizerState.h.

Public Member Functions

 WriteOptimizerState (kernel::Model *m, WriterAdaptor w)
 
void add_geometries (const Geometries &objs)
 
unsigned int add_geometry (Geometry *obj)
 
void clear_geometries ()
 
Geometries get_geometries () const
 
Geometryget_geometry (unsigned int i) const
 
bool get_has_geometries ()
 
unsigned int get_number_of_geometries () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void remove_geometries (const Geometries &d)
 
void remove_geometry (Geometry *d)
 
void reserve_geometries (unsigned int sz)
 
void set_geometries (const Geometries &ps)
 
void set_geometries_order (const Geometries &objs)
 
void write (WriterAdaptor w) const
 
- Public Member Functions inherited from IMP::kernel::OptimizerState
 OptimizerState (kernel::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::kernel::ModelObject
 ModelObject (kernel::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::base::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 void do_update (unsigned int)
 
- Protected Member Functions inherited from IMP::kernel::OptimizerState
virtual ModelObjectsTemp do_get_inputs () const
 
virtual ModelObjectsTemp do_get_outputs () const
 
virtual void do_set_is_optimizing (bool)
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual void IMP::display::WriteOptimizerState::do_update ( unsigned int  )
protectedvirtual

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::kernel::OptimizerState.

virtual ::IMP::base::VersionInfo IMP::display::WriteOptimizerState::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::base::Object.

Definition at line 35 of file LogOptimizerState.h.


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