restraint_io.h File Reference

Handle read/write of kernel::Model data from/to files. More...

#include <IMP/rmf/rmf_config.h>
#include "link_macros.h"
#include <IMP/base/object_macros.h>
#include <IMP/kernel/Restraint.h>
#include <IMP/restraint_macros.h>

Include dependency graph for restraint_io.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	IMP
	All IMP::kernel code is brought into the IMP namespace.
	IMP::rmf
	See IMP.rmf for more information.

kernel::Restraint I/O
kernel::Restraints are written as am RMF::FEATURE node with subnodes for the decomposed restraints (kernel::Restraint::create_current_decompositon()). The kernel::Restraints::get_last_score() value is what is saved to the file, so make sure that the restraints have been evaluated before saving a frame. Any particles returnd by kernel::Restraint::get_input_particles() that are also linked in the RMF file will be included in the RMF file as inputs for the kernel::Restraint. This allows external software like e.g., Chimera to associate these restrains with a certain set of particles.
void	IMP::rmf::add_restraints (RMF::FileHandle fh, const kernel::Restraints &hs)
void	IMP::rmf::add_restraints (RMF::NodeHandle fh, const kernel::Restraints &hs)
void	IMP::rmf::add_restraint (RMF::FileHandle fh, kernel::Restraint *hs)
kernel::Restraints	IMP::rmf::create_restraints (RMF::FileConstHandle fh, kernel::Model *m)
void	IMP::rmf::link_restraints (RMF::FileConstHandle fh, const kernel::Restraints &hs)
void	IMP::rmf::set_maximum_number_of_terms (RMF::FileHandle fh, unsigned int num)

Detailed Description

Copyright 2007-2013 IMP Inventors. All rights reserved.

Definition in file restraint_io.h.