Detailed Description

A decorator for a particle which has bonds.

Inheritance diagram for IMP::atom::Bonded:

Public Member Functions
	Bonded (Model *m, ParticleIndex id)
	Bonded (::IMP::Particle *p)
Bond	get_bond (unsigned int i) const
	Get a Bond of the ith bond.
Bonded	get_bonded (unsigned int i) const
	Get a Bonded of the ith bonded particle.
unsigned int	get_number_of_bonds () const
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::Decorator
std::size_t	__hash__ () const
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::Particle *p)
static bool	particle_is_instance (Particle *p)
	return true if it is a bonded particle
static Bonded	setup_particle (Particle *p)
static Decorator	setup_particle (Particle *p, extra_arguments)

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.
Bond	create_bond (Bonded a, Bonded b, Bond o)
	Connect the two wrapped particles by a custom bond.
Bond	create_custom_bond (Bonded a, Bonded b, Float length, Float stiffness=-1)
	Connect the two wrapped particles by a custom bond.
void	destroy_bond (Bond b)
	Destroy the bond connecting to particles.
Bond	get_bond (Bonded a, Bonded b)
	Get the bond between two particles.

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)
	Decorator (Particle *p)
int	compare (base::Object *o) const

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

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.

unsigned int IMP::atom::Bonded::get_number_of_bonds ( ) const

static bool IMP::atom::Bonded::particle_is_instance ( Particle * p )

static

return true if it is a bonded particle

Reimplemented from IMP::Decorator.

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