IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
frames.h
Go to the documentation of this file.
1 /**
2  * \file IMP/rmf/frames.h
3  * \brief Read or write RMF frames.
4  *
5  * Copyright 2007-2022 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 given RMF frame into the state of the linked objects.
19 /** The specified frame from the RMF file is loaded into the state
20  of the IMP::Objects that were previously associated with that file.
21 
22  The current frame is left as the passed frame number.
23 */
24 IMPRMFEXPORT void load_frame(RMF::FileConstHandle file, RMF::FrameID frame);
25 
26 //! Save the current state of the linked objects as a new RMF frame.
27 IMPRMFEXPORT RMF::FrameID save_frame(RMF::FileHandle file,
28  std::string name = "");
29 
30 IMPRMF_END_NAMESPACE
31 
32 #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)
Load the given RMF frame into the state of the linked objects.