IMP  2.1.0
The Integrative Modeling Platform
frames.h
Go to the documentation of this file.
1 /**
2  * \file IMP/rmf/frames.h
3  * \brief Handle read/write of kernel::Model data from/to files.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPRMF_FRAMES_H
10 #define IMPRMF_FRAMES_H
11 
12 #include <IMP/rmf/rmf_config.h>
13 #include <RMF/FileHandle.h>
14 
15 IMPRMF_BEGIN_NAMESPACE
16 
17 /** Load the specified frame into the state of the associated
18  IMP::base::Objects with the RMF file.
19 
20  The current frame is left as the passed frame number.
21 */
22 IMPRMFEXPORT void load_frame(RMF::FileConstHandle file, int frame);
23 
24 /** Save the current state of the objects linked to the RMF
25  file as the frameth frame.
26 
27  The current frame is left as the passed frame number.
28 */
29 IMPRMFEXPORT void save_frame(RMF::FileHandle file, int frame,
30  std::string name = "frame");
31 
32 IMPRMF_END_NAMESPACE
33 
34 #endif /* IMPRMF_FRAMES_H */
void save_frame(RMF::FileHandle file, int frame, std::string name="frame")
void load_frame(RMF::FileConstHandle file, int frame)