IMP logo
IMP Reference Guide  2.20.1
The Integrative Modeling Platform
IMP::core::Provenanced Class Reference

Tag part of the system to track how it was created. More...

#include <IMP/core/provenance.h>

+ Inheritance diagram for IMP::core::Provenanced:

Detailed Description

Tag part of the system to track how it was created.

Definition at line 632 of file provenance.h.

Public Member Functions

 Provenanced (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Provenanced (const IMP::ParticleAdaptor &d)
 
Provenance get_provenance () const
 
void set_provenance (Provenance p) const
 
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 Provenanced setup_particle (Model *m, ParticleIndex pi, Provenance p)
 
static Provenanced setup_particle (IMP::ParticleAdaptor pa, Provenance p)
 

Additional Inherited Members

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

Member Function Documentation

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

Definition at line 657 of file provenance.h.

static Provenanced IMP::core::Provenanced::setup_particle ( Model m,
ParticleIndex  pi,
Provenance  p 
)
static
Returns
a Provenanced object that decorates particle pi

Definition at line 657 of file provenance.h.


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