IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::spb::HelixDecorator Class Reference

Add helix parameters to a particle. More...

#include <IMP/spb/HelixDecorator.h>

+ Inheritance diagram for IMP::spb::HelixDecorator:

Detailed Description

Add helix parameters to a particle.

Definition at line 22 of file HelixDecorator.h.

Public Member Functions

 HelixDecorator (::IMP::Model *m,::IMP::ParticleIndex id)
 
 HelixDecorator (const IMP::ParticleAdaptor &d)
 
Float get_begin () const
 Get the beginning. More...
 
Float get_end () const
 Get the end. More...
 
void set_begin (Float v)
 set begin More...
 
void set_end (Float v)
 set end More...
 
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 bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (IMP::Model *m, IMP::ParticleIndex id)
 
static HelixDecorator setup_particle (Particle *p, Float b, Float e)
 

Additional Inherited Members

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

Member Function Documentation

Float IMP::spb::HelixDecorator::get_begin ( ) const

Get the beginning.

Definition at line 36 of file HelixDecorator.h.

+ Here is the call graph for this function:

Float IMP::spb::HelixDecorator::get_end ( ) const

Get the end.

Definition at line 41 of file HelixDecorator.h.

+ Here is the call graph for this function:

void IMP::spb::HelixDecorator::set_begin ( Float  v)

set begin

Definition at line 54 of file HelixDecorator.h.

+ Here is the call graph for this function:

void IMP::spb::HelixDecorator::set_end ( Float  v)

set end

Definition at line 57 of file HelixDecorator.h.

+ Here is the call graph for this function:


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