IMP  2.1.1
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:

Public Member Functions

 Angle (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Angle (const IMP::kernel::ParticleAdaptor &d)
 
Float get_ideal () const
 
kernel::Particleget_particle () const
 
kernel::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::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 Angle decorate_particle (::IMP::kernel::Particle *p)
 
static FloatKey get_ideal_key ()
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 Return true if the particle is an angle.
 
static kernel::ParticleIndexKey get_particle_key (unsigned int i)
 
static FloatKey get_stiffness_key ()
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static Angle setup_particle (IMP::kernel::ParticleAdaptor decorator, core::XYZ a, core::XYZ b, core::XYZ c)
 
static Angle setup_particle (kernel::Model *m, ParticleIndex pi, core::XYZ a, core::XYZ b, core::XYZ c)
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool get_is_setup (Particle *p)
 Return true if the particle can be cast to the decorator. More...
 

Additional Inherited Members

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

Detailed Description

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.

Member Function Documentation

static Angle IMP::atom::Angle::decorate_particle ( ::IMP::kernel::Particle p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 32 of file angle_decorators.h.

static bool IMP::atom::Angle::particle_is_instance ( ::IMP::kernel::Particle p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file angle_decorators.h.

static bool IMP::atom::Angle::particle_is_instance ( IMP::kernel::Model m,
IMP::kernel::ParticleIndex  pi 
)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file angle_decorators.h.

static Angle IMP::atom::Angle::setup_particle ( kernel::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: