IMP  2.0.0
The Integrative Modeling Platform
particle_io.h
Go to the documentation of this file.
1 /**
2  * \file IMP/rmf/particle_io.h
3  * \brief Handle read/write of Model data from/to files.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPRMF_PARTICLE_IO_H
10 #define IMPRMF_PARTICLE_IO_H
11 
12 #include <IMP/rmf/rmf_config.h>
13 #include "link_macros.h"
14 #include <IMP/atom/Hierarchy.h>
15 
16 IMPRMF_BEGIN_NAMESPACE
17 
18 /** \name Particle I/O
19  Arbitrary (non IMP::atom::Hierarchy) particles can be written to
20  the file and read back from them. All non-IMP::Object attributes are
21  supported. Note that currently particles must be added so that
22  any particles that are stored in a given particles attributes are
23  added to the file first.
24 
25  The data is stored in a category named IMP.
26  @{
27 */
28 IMP_DECLARE_LINKERS(Particle, particle, particles,
29  Particle*, ParticlesTemp,
30  Particle*, ParticlesTemp,
31  (RMF::FileConstHandle fh, Model *m),
32  );
33 
34 /** @} */
35 
36 IMPRMF_END_NAMESPACE
37 
38 #endif /* IMPRMF_PARTICLE_IO_H */