IMP logo
IMP Reference Guide  2.14.0
The Integrative Modeling Platform
IMP::rmf::HierarchyLoadLink Class Reference

#include <IMP/rmf/HierarchyLoadLink.h>

+ Inheritance diagram for IMP::rmf::HierarchyLoadLink:

Detailed Description

Manage the loading link between an RMF file and an atom::Hierarchy.

Warning: HierarchyLoadLink has not been stabilized and is likely to change without notice.

Definition at line 37 of file HierarchyLoadLink.h.

Public Member Functions

 HierarchyLoadLink (RMF::FileConstHandle fh)
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Static Public Member Functions

static const char * get_name ()
 

Protected Member Functions

virtual void do_link_particle (Model *m, ParticleIndex root, ParticleIndex cur, RMF::NodeConstHandle node)
 
virtual void do_load_hierarchy (RMF::NodeConstHandle root_node, Model *m, ParticleIndex root)
 
virtual void do_setup_particle (Model *m, ParticleIndex root, ParticleIndex cur, RMF::NodeConstHandle node)
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual void IMP::rmf::HierarchyLoadLink::do_link_particle ( Model m,
ParticleIndex  root,
ParticleIndex  cur,
RMF::NodeConstHandle  node 
)
protectedvirtual

Overload this to take specific action on linking a member of the hierarchy.

Warning: do_add_link_recursive has not been stabilized and is likely to change without notice.

Reimplemented in IMP::npctransport::HierarchyWithSitesLoadLink.

Definition at line 118 of file HierarchyLoadLink.h.

virtual void IMP::rmf::HierarchyLoadLink::do_load_hierarchy ( RMF::NodeConstHandle  root_node,
Model m,
ParticleIndex  root 
)
protectedvirtual

This method is called for the hierarchy.

Reimplemented in IMP::npctransport::HierarchyWithSitesLoadLink.

Definition at line 97 of file HierarchyLoadLink.h.

virtual void IMP::rmf::HierarchyLoadLink::do_setup_particle ( Model m,
ParticleIndex  root,
ParticleIndex  cur,
RMF::NodeConstHandle  node 
)
protectedvirtual

Overload this to take specific action on creating a member of the hierarchy.

Warning: do_create_recursive has not been stabilized and is likely to change without notice.

Reimplemented in IMP::npctransport::HierarchyWithSitesLoadLink.

Definition at line 106 of file HierarchyLoadLink.h.

virtual ::IMP::VersionInfo IMP::rmf::HierarchyLoadLink::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 132 of file HierarchyLoadLink.h.


The documentation for this class was generated from the following file: