IMP logo
IMP Reference Guide  develop.e004443c3b,2024/04/25
The Integrative Modeling Platform
IMP::core::SoftwareProvenance Class Reference

Track creation of a system fragment from running some software. More...

#include <IMP/core/provenance.h>

+ Inheritance diagram for IMP::core::SoftwareProvenance:

Detailed Description

Track creation of a system fragment from running some software.

Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to have been generated by running the given software (e.g. IMP itself, or an extension module).

Note
While obviously every model has to be generated by IMP, it is useful to track the version of IMP used, as during a long protocol it's possible (although not ideal!) for different IMP versions to be used for different steps.

Definition at line 562 of file provenance.h.

Public Member Functions

 SoftwareProvenance (::IMP::Model *m,::IMP::ParticleIndex id)
 
 SoftwareProvenance (const IMP::ParticleAdaptor &d)
 
std::string get_location () const
 
std::string get_software_name () const
 
std::string get_version () const
 
void set_location (std::string location) const
 Set the location. More...
 
void set_software_name (std::string name) const
 Set the name. More...
 
void set_version (std::string version) const
 Set the version. 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 SoftwareProvenance setup_particle (IMP::ParticleAdaptor pa, std::string name, std::string version, std::string location)
 
static SoftwareProvenance setup_particle (Model *m, ParticleIndex pi, std::string name, std::string version, std::string location)
 
static SoftwareProvenance setup_particle (IMP::ParticleAdaptor pa, SoftwareProvenance o)
 
static SoftwareProvenance setup_particle (Model *m, ParticleIndex pi, SoftwareProvenance 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 pa)
 

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::SoftwareProvenance::get_location ( ) const
Returns
the location

Definition at line 620 of file provenance.h.

+ Here is the call graph for this function:

std::string IMP::core::SoftwareProvenance::get_software_name ( ) const
Returns
the name

Definition at line 597 of file provenance.h.

+ Here is the call graph for this function:

std::string IMP::core::SoftwareProvenance::get_version ( ) const
Returns
the version

Definition at line 608 of file provenance.h.

+ Here is the call graph for this function:

void IMP::core::SoftwareProvenance::set_location ( std::string  location) const

Set the location.

Definition at line 614 of file provenance.h.

+ Here is the call graph for this function:

void IMP::core::SoftwareProvenance::set_software_name ( std::string  name) const

Set the name.

Definition at line 591 of file provenance.h.

+ Here is the call graph for this function:

void IMP::core::SoftwareProvenance::set_version ( std::string  version) const

Set the version.

Definition at line 602 of file provenance.h.

+ Here is the call graph for this function:

static SoftwareProvenance IMP::core::SoftwareProvenance::setup_particle ( Model m,
ParticleIndex  pi,
std::string  name,
std::string  version,
std::string  location 
)
static
Returns
a SoftwareProvenance object that decorates particle pi

Definition at line 627 of file provenance.h.

static SoftwareProvenance IMP::core::SoftwareProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
std::string  name,
std::string  version,
std::string  location 
)
static
Returns
a SoftwareProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, pi, name , version , location )

Definition at line 627 of file provenance.h.

static SoftwareProvenance IMP::core::SoftwareProvenance::setup_particle ( IMP::ParticleAdaptor  pa,
SoftwareProvenance  o 
)
static
Returns
a SoftwareProvenance object that decorates the particle specified by pa
See Also
setup_particle(m, pi, o )

Definition at line 628 of file provenance.h.

static SoftwareProvenance IMP::core::SoftwareProvenance::setup_particle ( Model m,
ParticleIndex  pi,
SoftwareProvenance  o 
)
static
Returns
a SoftwareProvenance object that decorates particle pi

Definition at line 628 of file provenance.h.


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