IMP logo
IMP Reference Guide  develop.e1fe35f,2019/09/16
The Integrative Modeling Platform
IMP::pmi::Symmetric Class Reference

Add symmetric attribute to a particle. More...

#include <IMP/pmi/Symmetric.h>

+ Inheritance diagram for IMP::pmi::Symmetric:

Detailed Description

Add symmetric attribute to a particle.

False means the particle is reference or non symmetric.

Definition at line 23 of file Symmetric.h.

Public Member Functions

 Symmetric (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Symmetric (const IMP::ParticleAdaptor &d)
 
Float get_symmetric () const
 
void set_symmetric (Float d)
 
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 (Model *m, ParticleIndex pi)
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static FloatKey get_symmetric_key ()
 
static Symmetric setup_particle (Model *m, ParticleIndex pi, Float symmetric)
 
static Symmetric setup_particle (IMP::ParticleAdaptor decorator, Float symmetric)
 

Additional Inherited Members

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

Member Function Documentation

static Symmetric IMP::pmi::Symmetric::setup_particle ( IMP::ParticleAdaptor  decorator,
Float  symmetric 
)
static
See Also
setup_particle(m, pi, symmetric )

Definition at line 44 of file Symmetric.h.

static Symmetric IMP::pmi::Symmetric::setup_particle ( Model m,
ParticleIndex  pi,
Float  symmetric 
)
static

Set the symmetric attribute to the particle. Setup the particle so that it can be used with this decorator

Definition at line 44 of file Symmetric.h.


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