IMP logo
IMP Reference Guide  2.5.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-2015 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 #include <IMP/deprecation_macros.h>
15 
16 IMPRMF_BEGIN_NAMESPACE
17 
18 /** Load the specified frame into the state of the associated
19  IMP::Objects with the RMF file.
20 
21  The current frame is left as the passed frame number.
22 */
23 IMPRMFEXPORT void load_frame(RMF::FileConstHandle file, RMF::FrameID frame);
24 
25 //! Save the current state of the linked objects as a new RMF frame.
26 IMPRMFEXPORT RMF::FrameID save_frame(RMF::FileHandle file,
27  std::string name = "");
28 
29 IMPRMF_END_NAMESPACE
30 
31 #endif /* IMPRMF_FRAMES_H */
Control display of deprecation information.
RMF::FrameID save_frame(RMF::FileHandle file, std::string name="")
Save the current state of the linked objects as a new RMF frame.
void load_frame(RMF::FileConstHandle file, RMF::FrameID frame)