IMP  2.0.0
The Integrative Modeling Platform
IMP::atom::Bond Class Reference

A decorator for wrapping a particle representing a molecular bond. More...

#include <IMP/atom/bond_decorators.h>

+ Inheritance diagram for IMP::atom::Bond:

Public Types

enum  Type {
  UNKNOWN =-1, NONBIOLOGICAL, SINGLE =1, DOUBLE =2,
  TRIPLE =3, HYDROGEN, SALT, PEPTIDE,
  AMIDE, AROMATIC
}
 The types a bond can have right now.
 

Public Member Functions

 Bond (Model *m, ParticleIndex id)
 
 Bond (::IMP::kernel::Particle *p)
 
Bonded get_bonded (unsigned int i) const
 Get the atom i of the bond. More...
 
Float get_length () const
 
Int get_order () const
 
Float get_stiffness () const
 
Int get_type () const
 
void set_length (Float t)
 
void set_order (Int t)
 
void set_stiffness (Float t)
 
void set_type (Int t)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Decorator
ParticleIndex get_particle_index () const
 
Particleget_particle () const
 
Modelget_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static Bond decorate_particle (::IMP::kernel::Particle *p)
 
static FloatKey get_length_key ()
 
static bool particle_is_instance (Particle *p)
 Return true if the particle is a bond.
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool particle_is_instance (Particle *p)
 Return true if the particle can be cast to the decorator. More...
 

Related Functions

(Note that these are not member functions.)

Bonds get_internal_bonds (Hierarchy mhd)
 Get the bonds internal to this tree. More...
 

Additional Inherited Members

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

Detailed Description

As with Atom, the types of bonds will eventually be run-time expandible.

See Also
Bonded
IMP::atom::get_internal_bonds()

Definition at line 40 of file bond_decorators.h.

Member Function Documentation

Bonded IMP::atom::Bond::get_bonded ( unsigned int  i) const
Parameters
[in]i0 or 1
Returns
Bonded for the atom in question

Definition at line 208 of file bond_decorators.h.

Friends And Related Function Documentation

Bonds get_internal_bonds ( Hierarchy  mhd)
related
See Also
Bond

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