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 511 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...

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 ScriptProvenance	setup_particle (IMP::ParticleAdaptor pa, std::string filename)

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

static ScriptProvenance	setup_particle (IMP::ParticleAdaptor pa, 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 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::ScriptProvenance::get_filename ( ) const

Returns: the filename, as an absolute path

Definition at line 543 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 536 of file provenance.h.

Here is the call graph for this function:

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle	(	IMP::ParticleAdaptor	pa,
		std::string	filename
	)

static

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

See Also: setup_particle(m, pi, filename )

Definition at line 548 of file provenance.h.

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

static

Returns: a ScriptProvenance object that decorates particle pi

Definition at line 548 of file provenance.h.

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

static

Returns: a ScriptProvenance object that decorates particle pi

Definition at line 549 of file provenance.h.

static ScriptProvenance IMP::core::ScriptProvenance::setup_particle	(	IMP::ParticleAdaptor	pa,
		ScriptProvenance	o
	)

static

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

See Also: setup_particle(m, pi, o )

Definition at line 549 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