IMP logo
IMP Reference Guide  develop.7cb8855c60,2024/10/04
The Integrative Modeling Platform
IMP::npctransport::HierarchyWithSitesLoadLink Class Reference

Load sites data from an RMF file. More...

#include <IMP/npctransport/rmf_links.h>

+ Inheritance diagram for IMP::npctransport::HierarchyWithSitesLoadLink:

Detailed Description

Load sites data from an RMF file.

Definition at line 21 of file rmf_links.h.

Public Member Functions

 HierarchyWithSitesLoadLink (RMF::FileConstHandle fh)
 
- 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) override
 
virtual void do_load_hierarchy (RMF::NodeConstHandle root_node, Model *m, ParticleIndex pi) override
 
virtual void do_setup_particle (Model *m, ParticleIndex root, ParticleIndex cur, RMF::NodeConstHandle node) override
 
- 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::npctransport::HierarchyWithSitesLoadLink::do_link_particle ( Model m,
ParticleIndex  root,
ParticleIndex  cur,
RMF::NodeConstHandle  node 
)
overrideprotectedvirtual

Called by rmf::HierarchyLoadLink::add_link_recursive()

link the specified rmf node to particle cur. In addition, load the list of sites associated with the rmf node together with their coordinates (children of type RMF::Geometry decorated with RMF::BallConst) and associate them with the particle type of cur in the SimulationData of cur.

Reimplemented from IMP::rmf::HierarchyLoadLink.

virtual void IMP::npctransport::HierarchyWithSitesLoadLink::do_load_hierarchy ( RMF::NodeConstHandle  root_node,
Model m,
ParticleIndex  pi 
)
overrideprotectedvirtual

load the values of a hierarchy. also loads dynamic Transporting decorator transport directionality information if needed (which is used in ParticleTransportStatisticsOptimizerState)

Reimplemented from IMP::rmf::HierarchyLoadLink.

virtual void IMP::npctransport::HierarchyWithSitesLoadLink::do_setup_particle ( Model m,
ParticleIndex  root,
ParticleIndex  cur,
RMF::NodeConstHandle  node 
)
overrideprotectedvirtual

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 from IMP::rmf::HierarchyLoadLink.

Definition at line 52 of file rmf_links.h.


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