IMP logo
IMP Reference Guide  develop.3e83b1f578,2019/10/15
The Integrative Modeling Platform
IMP::core::ClusterProvenance Class Reference

Track creation of a system fragment from clustering. More...

#include <IMP/core/provenance.h>

+ Inheritance diagram for IMP::core::ClusterProvenance:

Detailed Description

Track creation of a system fragment from clustering.

Part of the system (usually the top of a Hierarchy) tagged with this decorator is understood to be a single frame inside a cluster of specified size. The rest of the cluster members are generally stored in a file (e.g. an RMF file).

Definition at line 426 of file provenance.h.

Public Member Functions

 ClusterProvenance (::IMP::Model *m,::IMP::ParticleIndex id)
 
 ClusterProvenance (const IMP::ParticleAdaptor &d)
 
int get_number_of_members () const
 
void set_number_of_members (int members) const
 Set the number of cluster members. 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 ClusterProvenance setup_particle (IMP::ParticleAdaptor decorator, int members)
 
static ClusterProvenance setup_particle (Model *m, ParticleIndex pi, int members)
 
static ClusterProvenance setup_particle (IMP::ParticleAdaptor decorator, ClusterProvenance o)
 
static ClusterProvenance setup_particle (Model *m, ParticleIndex pi, ClusterProvenance 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 decorator)
 

Additional Inherited Members

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

Member Function Documentation

int IMP::core::ClusterProvenance::get_number_of_members ( ) const
Returns
the number of cluster members

Definition at line 451 of file provenance.h.

+ Here is the call graph for this function:

void IMP::core::ClusterProvenance::set_number_of_members ( int  members) const

Set the number of cluster members.

Definition at line 445 of file provenance.h.

+ Here is the call graph for this function:

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  decorator,
int  members 
)
static
See Also
setup_particle(m, pi, members )

Definition at line 456 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( Model m,
ParticleIndex  pi,
int  members 
)
static

Setup the particle so that it can be used with this decorator

Definition at line 456 of file provenance.h.

static ClusterProvenance IMP::core::ClusterProvenance::setup_particle ( IMP::ParticleAdaptor  decorator,
ClusterProvenance  o 
)
static
See Also
setup_particle(m, pi, o )

Definition at line 457 of file provenance.h.

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

Setup the particle so that it can be used with this decorator

Definition at line 457 of file provenance.h.


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