Detailed Description

Track creation of a system fragment by combination.

Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to be a single frame within an ensemble that was created by combining a number of independent runs. One of those runs should be the 'previous' provenance. The runs should be essentially identical, differing at most only in the number of frames. The total size of the resulting ensemble is stored here.

Definition at line 280 of file provenance.h.

Public Member Functions
	CombineProvenance (::IMP::Model *m,::IMP::ParticleIndex id)

	CombineProvenance (const IMP::ParticleAdaptor &d)

int	get_number_of_frames () const

int	get_number_of_runs () const

void	set_number_of_frames (int frames) const
	Set the total number of frames. More...

void	set_number_of_runs (int runs) const
	Set the number of runs. 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 CombineProvenance	setup_particle (IMP::ParticleAdaptor pa, int runs, int frames)

static CombineProvenance	setup_particle (Model *m, ParticleIndex pi, int runs, int frames)

static CombineProvenance	setup_particle (IMP::ParticleAdaptor pa, CombineProvenance o)

static CombineProvenance	setup_particle (Model *m, ParticleIndex pi, CombineProvenance 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

int IMP::core::CombineProvenance::get_number_of_frames ( ) const

Returns: the total number of frames

Definition at line 309 of file provenance.h.

Here is the call graph for this function:

int IMP::core::CombineProvenance::get_number_of_runs ( ) const

Returns: the number of runs

Definition at line 320 of file provenance.h.

Here is the call graph for this function:

void IMP::core::CombineProvenance::set_number_of_frames ( int frames ) const

Set the total number of frames.

Definition at line 303 of file provenance.h.

Here is the call graph for this function:

void IMP::core::CombineProvenance::set_number_of_runs ( int runs ) const

Set the number of runs.

Definition at line 314 of file provenance.h.

Here is the call graph for this function:

static CombineProvenance IMP::core::CombineProvenance::setup_particle	(	Model *	m,
		ParticleIndex	pi,
		int	runs,
		int	frames
	)

static

Returns: a CombineProvenance object that decorates particle pi

Definition at line 325 of file provenance.h.

static CombineProvenance IMP::core::CombineProvenance::setup_particle	(	IMP::ParticleAdaptor	pa,
		int	runs,
		int	frames
	)

static

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

See Also: setup_particle(m, p, runs , frames )

Definition at line 325 of file provenance.h.

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

static

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

See Also: setup_particle(m, pi, o )

Definition at line 326 of file provenance.h.

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

static

Returns: a CombineProvenance object that decorates particle pi

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