IMP logo
IMP Reference Guide  develop.29b24c6ad6,2021/05/15
The Integrative Modeling Platform
IMP::atom::Angle Class Reference

A particle that describes an angle between three particles. More...

#include <IMP/atom/angle_decorators.h>

+ Inheritance diagram for IMP::atom::Angle:

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.

Definition at line 23 of file angle_decorators.h.

Public Member Functions

 Angle (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Angle (const IMP::ParticleAdaptor &d)
 
Float get_ideal () const
 
Particleget_particle () const
 
Particleget_particle (unsigned int i) const
 Get the ith particle in the angle. More...
 
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
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 FloatKey get_ideal_key ()
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 Return true if the particle is an angle. More...
 
static ParticleIndexKey get_particle_key (unsigned int i)
 
static FloatKey get_stiffness_key ()
 
static Angle setup_particle (Model *m, ParticleIndex pi, core::XYZ a, core::XYZ b, core::XYZ c)
 
static Angle setup_particle (IMP::ParticleAdaptor decorator, core::XYZ a, core::XYZ b, core::XYZ c)
 

Additional Inherited Members

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

Member Function Documentation

Float IMP::atom::Angle::get_ideal ( ) const

returns the value of the ideal attribute, or -1 if \ the ideal attribute is missing

Definition at line 50 of file angle_decorators.h.

static bool IMP::atom::Angle::get_is_setup ( Model m,
ParticleIndex  pi 
)
static

Return true if the particle is an angle.

Definition at line 36 of file angle_decorators.h.

+ Here is the call graph for this function:

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

Get the ith particle in the angle.

Definition at line 46 of file angle_decorators.h.

+ Here is the call graph for this function:

Float IMP::atom::Angle::get_stiffness ( ) const

returns the value of the stiffness attribute, or 0. if \ the stiffness attribute is missing

Definition at line 51 of file angle_decorators.h.

void IMP::atom::Angle::set_ideal ( Float  t)

sets the ideal attribute to t

Definition at line 50 of file angle_decorators.h.

void IMP::atom::Angle::set_stiffness ( Float  t)

sets the stiffness attribute to t

Definition at line 51 of file angle_decorators.h.

static Angle IMP::atom::Angle::setup_particle ( Model m,
ParticleIndex  pi,
core::XYZ  a,
core::XYZ  b,
core::XYZ  c 
)
static

Setup the particle so it can be used with this decorator.

Definition at line 33 of file angle_decorators.h.


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