Detailed Description

Track how parts of the system were created.

Particles are linked with this decorator into a directed acyclic graph that tracks all IMP transformations of the system all the way back to raw inputs (such as PDB files).

Typically, part of an IMP::Model (usually an atom::Hierarchy particle) is decorated with Provenanced that points to the root of this graph.

Definition at line 31 of file provenance.h.

Public Member Functions
	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...

Model *	get_model () const
	Returns the Model containing the particle. More...

Particle *	get_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

Particle *	operator-> () const

Static Public Member Functions
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

Provenance IMP::core::Provenance::get_previous ( ) const

Returns: the previous provenance, or Provenance() if none exists.

Definition at line 45 of file provenance.h.

Here is the call graph for this function:

void IMP::core::Provenance::set_previous ( Provenance p )

Set the previous provenance.

This can be used to show that a given part of the system was generated through multiple steps in order, for example by first being read from a PDB file, then sampled, filtered, and finally clustered.

Note: it is considered an error to try to set this more than once.

Definition at line 64 of file provenance.h.

Here is the call graph for this function:

static Provenance IMP::core::Provenance::setup_particle ( IMP::ParticleAdaptor pa )

static

Returns: a Provenance object that decorates the particle specified by pa

See Also: setup_particle(m, p)

Definition at line 74 of file provenance.h.

static Provenance IMP::core::Provenance::setup_particle	(	Model *	m,
		ParticleIndex	pi
	)

static

Returns: a Provenance object that decorates particle pi

Definition at line 74 of file provenance.h.

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

provenance.h

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation