IMP  2.2.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-2014 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>
15 
16 IMPRMF_BEGIN_NAMESPACE
17 
18 /** Load the specified frame into the state of the associated
19  IMP::base::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 /** \deprecated_at{2.2} Pass the frame as an RMF::FrameID. */
26 IMPRMF_DEPRECATED_FUNCTION_DECL(2.2)
27 inline void load_frame(RMF::FileConstHandle file, unsigned int frame) {
28  IMPRMF_DEPRECATED_FUNCTION_DEF(2.2, "Pass the frame as an RMF::FrameID");
29  load_frame(file, RMF::FrameID(frame));
30 }
31 
32 /** Save the current state of the objects linked to the RMF
33  file as the frameth frame.
34 
35  The current frame is left as the passed frame number.
36 */
37 IMPRMFEXPORT RMF::FrameID save_frame(RMF::FileHandle file,
38  std::string name = "");
39 
40 /** \deprecated_at{2.2} You cannot specify the frame. Drop it. */
41 IMPRMF_DEPRECATED_FUNCTION_DECL(2.2)
42 inline void save_frame(RMF::FileHandle file, unsigned int,
43  std::string name = "") {
44  IMPRMF_DEPRECATED_FUNCTION_DEF(
45  2.2, "Don't try to specify the frame index, it is ignored");
46  save_frame(file, name);
47 }
48 
49 IMPRMF_END_NAMESPACE
50 
51 #endif /* IMPRMF_FRAMES_H */
void save_frame(RMF::FileHandle file, unsigned int, std::string name="")
Definition: frames.h:42
void load_frame(RMF::FileConstHandle file, unsigned int frame)
Definition: frames.h:27
Control display of deprecation information.