IMP  2.0.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 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
23 void load_frame(RMF::FileConstHandle file, int frame);
24 
25 /** Save the current state of the objects linked to the RMF
26  file as the frameth frame.
27 
28  The current frame is left as the passed frame number.
29 */
30 IMPRMFEXPORT
31 void save_frame(RMF::FileHandle file, int frame,
32  std::string name="frame");
33 
34 
35 IMPRMF_END_NAMESPACE
36 
37 #endif /* IMPRMF_FRAMES_H */