SaveOptimizerState.h

Go to the documentation of this file.

/**
 *  \file IMP/rmf/SaveOptimizerState.h
 *  \brief Handle read/write of kernel::Model data from/to files.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPRMF_SAVE_OPTIMIZER_STATE_H
#define IMPRMF_SAVE_OPTIMIZER_STATE_H

#include <IMP/rmf/rmf_config.h>
#include "atom_io.h"
#include "restraint_io.h"
#include "particle_io.h"
#include "geometry_io.h"
#include <IMP/kernel/OptimizerState.h>
#include <IMP/atom/Simulator.h>

IMPRMF_BEGIN_NAMESPACE

/** Periodically call the save_frame() method to save the everything
    associated with the RMF file to file.
*/
class IMPRMFEXPORT SaveOptimizerState : public kernel::OptimizerState {
  RMF::FileHandle fh_;
  base::WeakPointer<atom::Simulator> sim_;

 public:
  SaveOptimizerState(kernel::Model *m, RMF::FileHandle fh);
  /** \deprecated_at{2.1} Use one that takes a model. */
  IMPRMF_DEPRECATED_FUNCTION_DECL(2.1)
  SaveOptimizerState(RMF::FileHandle fh);
#ifndef IMP_DOXYGEN
  IMP_LIST_ACTION(public, Hierarchy, Hierarchies, hierarchy, hierarchies,
                  kernel::Particle *, kernel::Particles,
                  { rmf::add_hierarchy(fh_, atom::Hierarchy(obj)); }, {}, {});
  IMP_LIST_ACTION(public, Restraint, estraints, restraint, restraints,
                  kernel::Restraint *, kernel::Restraints,
                  { rmf::add_restraints(fh_, kernel::RestraintsTemp(1, obj)); },
                  {}, {});
  IMP_LIST_ACTION(public, Particle, Particles, particle, particles,
                  kernel::Particle *, kernel::Particles,
                  { rmf::add_particles(fh_, kernel::ParticlesTemp(1, obj)); },
                  {}, {});
  IMP_LIST_ACTION(
      public, Geometry, Geometries, geometry, geometries, display::Geometry *,
      display::Geometries,
      { rmf::add_geometries(fh_, display::GeometriesTemp(1, obj)); }, {}, {});
#endif
  //! Use the simulator to tag frames with current time
  /** \note This may change to a more general mechanism at some point
      in the future.
   */
  void set_simulator(atom::Simulator *sim);
  //! Write a frame with a given name
  void update_always(std::string name);
  // to prevent it from being hidden
  void update_always() { kernel::OptimizerState::update_always(); }
  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
  IMP_OBJECT_METHODS(SaveOptimizerState);
};

IMPRMF_END_NAMESPACE

#endif /* IMPRMF_SAVE_OPTIMIZER_STATE_H */