IMP logo
IMP Reference Guide  2.6.1
The Integrative Modeling Platform
IMP::atom::StructureSource Class Reference

Store strings describing the source of this structure fragment. More...

#include <IMP/atom/StructureSource.h>

+ Inheritance diagram for IMP::atom::StructureSource:

Detailed Description

Store strings describing the source of this structure fragment.

Definition at line 23 of file StructureSource.h.

Public Member Functions

 StructureSource (::IMP::Model *m,::IMP::ParticleIndex id)
 
 StructureSource (const IMP::ParticleAdaptor &d)
 
std::string get_source_chain_id () const
 Get the source ID. More...
 
std::string get_source_id () const
 Get the source ID. More...
 
void set_source_chain_id (std::string source_chain_id)
 Set the structure ID. More...
 
void set_source_id (std::string source_id)
 Set the structure ID. 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 StructureSource setup_particle (Model *m, ParticleIndex pi, std::string source_id, std::string source_chain_id)
 
static StructureSource setup_particle (IMP::ParticleAdaptor decorator, std::string source_id, std::string source_chain_id)
 

Additional Inherited Members

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

Member Function Documentation

std::string IMP::atom::StructureSource::get_source_chain_id ( ) const

Get the source ID.

Definition at line 45 of file StructureSource.h.

+ Here is the call graph for this function:

std::string IMP::atom::StructureSource::get_source_id ( ) const

Get the source ID.

Definition at line 40 of file StructureSource.h.

+ Here is the call graph for this function:

void IMP::atom::StructureSource::set_source_chain_id ( std::string  source_chain_id)

Set the structure ID.

Definition at line 56 of file StructureSource.h.

+ Here is the call graph for this function:

void IMP::atom::StructureSource::set_source_id ( std::string  source_id)

Set the structure ID.

Definition at line 50 of file StructureSource.h.

+ Here is the call graph for this function:

static StructureSource IMP::atom::StructureSource::setup_particle ( Model m,
ParticleIndex  pi,
std::string  source_id,
std::string  source_chain_id 
)
static

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

Definition at line 63 of file StructureSource.h.


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