frames.h

Go to the documentation of this file.

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

#ifndef IMPRMF_FRAMES_H
#define IMPRMF_FRAMES_H

#include <IMP/rmf/rmf_config.h>
#include <RMF/FileHandle.h>

IMPRMF_BEGIN_NAMESPACE

/** Load the specified frame into the state of the associated
    IMP::base::Objects with the RMF file.

    The current frame is left as the passed frame number.
*/
IMPRMFEXPORT void load_frame(RMF::FileConstHandle file, int frame);

/** Save the current state of the objects linked to the RMF
    file as the frameth frame.

    The current frame is left as the passed frame number.
*/
IMPRMFEXPORT void save_frame(RMF::FileHandle file, int frame,
                             std::string name = "frame");

IMPRMF_END_NAMESPACE

#endif /* IMPRMF_FRAMES_H */