IMP logo
IMP Reference Guide  develop.36b5e40f34,2024/10/14
The Integrative Modeling Platform
IMP::atom::Bonded Class Reference

A decorator for a particle which has bonds. More...

#include <IMP/atom/bond_decorators.h>

+ Inheritance diagram for IMP::atom::Bonded:

Detailed Description

A decorator for a particle which has bonds.

See Also
Bond

Definition at line 89 of file bond_decorators.h.

Public Member Functions

 Bonded (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Bonded (const IMP::ParticleAdaptor &d)
 
Bond get_bond (unsigned int i) const
 Get a Bond of the ith bond. More...
 
ParticleIndexes get_bond_indexes () const
 
Bonded get_bonded (unsigned int i) const
 Get a Bonded of the ith bonded particle. More...
 
unsigned int get_number_of_bonds () const
 
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 (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static Bonded setup_particle (IMP::ParticleAdaptor pa)
 
static Bonded setup_particle (Model *m, ParticleIndex pi)
 

Iterate through the bonds

BondIterator bonds_begin () const
 
BondIterator bonds_end () const
 

Iterate through the bondeds

BondedIterator bondeds_begin () const
 
BondedIterator bondeds_end () const
 

Additional Inherited Members

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

Member Function Documentation

Bond IMP::atom::Bonded::get_bond ( unsigned int  i) const

Get a Bond of the ith bond.

Returns
decorator of the ith child, or throw an exception if there is no such bond

Definition at line 134 of file bond_decorators.h.

+ Here is the call graph for this function:

Bonded IMP::atom::Bonded::get_bonded ( unsigned int  i) const

Get a Bonded of the ith bonded particle.

Returns
decorator of the ith child, or throw an exception if there is no such bond
Note
I don't entirely like having this here as it duplicates functionality available otherwise, however it is such a fundamental operation and kind of a pain to write. It also means that we could later pull the edge endpoints into the vertex if desired.

Definition at line 150 of file bond_decorators.h.

+ Here is the call graph for this function:

static Bonded IMP::atom::Bonded::setup_particle ( Model m,
ParticleIndex  pi 
)
static
Returns
a Bonded object that decorates particle pi

Definition at line 113 of file bond_decorators.h.

static Bonded IMP::atom::Bonded::setup_particle ( IMP::ParticleAdaptor  pa)
static
Returns
a Bonded object that decorates the particle specified by pa
See Also
setup_particle(m, p)

Definition at line 113 of file bond_decorators.h.


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