IMP logo
IMP Reference Guide  develop.d247202c1c,2019/10/23
The Integrative Modeling Platform
IMP::core::ScriptProvenance Class Reference

Track creation of a system fragment from running a script. More...

#include <IMP/core/provenance.h>

+ Inheritance diagram for IMP::core::ScriptProvenance:

Detailed Description

Track creation of a system fragment from running a script.

Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to have been generated by running a script (usually a Python script).

Definition at line 465 of file provenance.h.

Public Member Functions

 ScriptProvenance (::IMP::Model *m,::IMP::ParticleIndex id)
 
 ScriptProvenance (const IMP::ParticleAdaptor &d)
 
std::string get_filename () const
 
void set_filename (std::string filename) const
 Set the filename. More...
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::core::Provenance
 Provenance (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Provenance (const IMP::ParticleAdaptor &d)
 
Provenance get_previous () const
 
void set_previous (Provenance p)
 Set the previous provenance. More...
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::Decorator
bool get_is_valid () const
 Returns true if constructed with a non-default constructor. More...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_particle () const
 Returns the particle decorated by this decorator. More...
 
ParticleIndex get_particle_index () const
 Returns the particle index decorated by this decorator. More...
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static bool get_is_setup (Model *m, ParticleIndex pi)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static ScriptProvenance setup_particle (IMP::ParticleAdaptor decorator, std::string filename)
 
static ScriptProvenance setup_particle (Model *m, ParticleIndex pi, std::string filename)
 
static ScriptProvenance setup_particle (IMP::ParticleAdaptor decorator, ScriptProvenance o)
 
static ScriptProvenance setup_particle (Model *m, ParticleIndex pi, ScriptProvenance o)
 
- Static Public Member Functions inherited from IMP::core::Provenance
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static Provenance setup_particle (Model *m, ParticleIndex pi)
 
static Provenance setup_particle (IMP::ParticleAdaptor decorator)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

std::string IMP::core::ScriptProvenance::get_filename ( ) const
Returns
the filename, as an absolute path

Definition at line 497 of file provenance.h.

+ Here is the call graph for this function:

void IMP::core::ScriptProvenance::set_filename ( std::string  filename) const

Set the filename.

The path can be relative or absolute. Internally, an absolute path will be stored (although generally it will be converted to a relative path when storing in a file, such as RMF).

Definition at line 490 of file provenance.h.

+ Here is the call graph for this function:

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle ( IMP::ParticleAdaptor  decorator,
std::string  filename 
)
static
See Also
setup_particle(m, pi, filename )

Definition at line 502 of file provenance.h.

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle ( Model m,
ParticleIndex  pi,
std::string  filename 
)
static

Setup the particle so that it can be used with this decorator

Definition at line 502 of file provenance.h.

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle ( Model m,
ParticleIndex  pi,
ScriptProvenance  o 
)
static

Setup the particle so that it can be used with this decorator

Definition at line 503 of file provenance.h.

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle ( IMP::ParticleAdaptor  decorator,
ScriptProvenance  o 
)
static
See Also
setup_particle(m, pi, o )

Definition at line 503 of file provenance.h.


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