frames.h

Go to the documentation of this file.

/**
 *  \file IMP/rmf/frames.h
 *  \brief Read or write RMF frames.
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPRMF_FRAMES_H
#define IMPRMF_FRAMES_H

#include <IMP/rmf/rmf_config.h>
#include <RMF/FileHandle.h>
#include <IMP/deprecation_macros.h>

IMPRMF_BEGIN_NAMESPACE

//! Load the given RMF frame into the state of the linked objects.
/** The specified frame from the RMF file is loaded into the state
    of the IMP::Objects that were previously associated with that file.

    The current frame is left as the passed frame number.
*/
IMPRMFEXPORT void load_frame(RMF::FileConstHandle file, RMF::FrameID frame);

//! Save the current state of the linked objects as a new RMF frame.
IMPRMFEXPORT RMF::FrameID save_frame(RMF::FileHandle file,
                                     std::string name = "");

IMPRMF_END_NAMESPACE

#endif /* IMPRMF_FRAMES_H */