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:Public Member Functions | |
| Bonded (Model *m, ParticleIndex id) | |
| Bonded (::IMP::kernel::Particle *p) | |
| Bond | get_bond (unsigned int i) const |
| Get a Bond of the ith bond. More... | |
| Bonded | get_bonded (unsigned int i) const |
| Get a Bonded of the ith bonded particle. More... | |
| ParticleIndexes | get_bonds () const |
| moving towards particle indexes | |
| unsigned int | get_number_of_bonds () const |
| void | show (std::ostream &out=std::cout) const |
| Public Member Functions inherited from IMP::kernel::Decorator | |
| ParticleIndex | get_particle_index () const |
| Particle * | get_particle () const |
| Model * | get_model () const |
| Returns the Model containing the particle. | |
| Decorator (Particle *p) | |
| Decorator () | |
Static Public Member Functions | |
| static Bonded | decorate_particle (::IMP::kernel::Particle *p) |
| static bool | particle_is_instance (Particle *p) |
| return true if it is a bonded particle | |
| static Bonded | setup_particle (Particle *p) |
| 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.) | |
| Bond | create_bond (Bonded a, Bonded b, Int t) |
| Connect the two wrapped particles by a bond. More... | |
| Bond | create_bond (Bonded a, Bonded b, Bond o) |
| Connect the two wrapped particles by a custom bond. More... | |
| Bond | create_custom_bond (Bonded a, Bonded b, Float length, Float stiffness=-1) |
| Connect the two wrapped particles by a custom bond. More... | |
| void | destroy_bond (Bond b) |
| Destroy the bond connecting to particles. More... | |
| Bond | get_bond (Bonded a, Bonded b) |
| Get the bond between two particles. More... | |
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::kernel::Decorator | |
| Decorator (Model *m, ParticleIndex pi) | |
| Decorator (Particle *p) | |
Detailed Description
- See Also
- Bond
Definition at line 92 of file bond_decorators.h.
Member Function Documentation
| Bond IMP::atom::Bonded::get_bond | ( | unsigned int | i | ) | const |
- Returns
- decorator of the ith child, or throw an exception if there is no such bond
Definition at line 144 of file bond_decorators.h.
Here is the call graph for this function:| Bonded IMP::atom::Bonded::get_bonded | ( | unsigned int | i | ) | const |
- 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 160 of file bond_decorators.h.
Here is the call graph for this function:The documentation for this class was generated from the following file: