IMP logo
Public Member Functions | Static Public Member Functions
IMP::atom::Angle Class Reference

Detailed Description

A particle that describes an angle between three particles.

An Angle decorator is a simple container of three particles, together with an ideal value (in radians) for the angle and a stiffness.

See also:
CHARMMParameters::create_angles(), AngleSingletonScore.
+ Inheritance diagram for IMP::atom::Angle:

List of all members.

Public Member Functions

 Angle (Model *m, ParticleIndex id)
 Angle (::IMP::Particle *p)
Float get_ideal () const
Particleget_particle () const
Particleget_particle (unsigned int i) const
 Get the ith particle in the angle.
Float get_stiffness () const
void set_ideal (Float t)
void set_stiffness (Float t)
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
Modelget_model () const
 Returns the Model containing the particle.
 Decorator (Particle *p)
 Decorator ()

Static Public Member Functions

static Angle decorate_particle (::IMP::Particle *p)
static FloatKey get_ideal_key ()
static ParticleKey get_particle_key (unsigned int i)
static FloatKey get_stiffness_key ()
static bool particle_is_instance (Particle *p)
 Return true if the particle is an angle.
static Angle setup_particle (Particle *p, core::XYZ a, core::XYZ b, core::XYZ c)
 Create an angle with the given particles.
static Decorator setup_particle (Particle *p, extra_arguments)

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

Particle* IMP::atom::Angle::get_particle ( ) const

Returns the particle decorated by this decorator. Returns the particle decorated by this decorator.

Reimplemented from IMP::Decorator.

Particle* IMP::atom::Angle::get_particle ( unsigned int  i) const

Get the ith particle in the angle.

static bool IMP::atom::Angle::particle_is_instance ( Particle p)
static

Return true if the particle is an angle.

Reimplemented from IMP::Decorator.

static Angle IMP::atom::Angle::setup_particle ( Particle p,
core::XYZ  a,
core::XYZ  b,
core::XYZ  c 
)
static

Create an angle with the given particles.


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

Generated on Tue May 22 2012 23:33:26 for IMP by doxygen 1.8.1