IMP logo
IMP Reference Guide  develop.8b7eb21230,2024/06/24
The Integrative Modeling Platform
IMP::npc::SlabWithSphericalIndent Class Reference

A decorator for a particle that represents a slab containing a spherical cap indent. More...

#include <IMP/npc/SlabWithSphericalIndent.h>

+ Inheritance diagram for IMP::npc::SlabWithSphericalIndent:

Detailed Description

A decorator for a particle that represents a slab containing a spherical cap indent.

Definition at line 25 of file SlabWithSphericalIndent.h.

Public Member Functions

 SlabWithSphericalIndent (::IMP::Model *m,::IMP::ParticleIndex id)
 
 SlabWithSphericalIndent (const IMP::ParticleAdaptor &d)
 
std::string get_decorator_name () const
 Get the name added to the particle (Ensures decorator_name to be the same as the name_key) More...
 
Float get_sphere_depth () const
 return the sphere depth More...
 
Float get_sphere_radius () const
 return the sphere radius More...
 
void set_decorator_name (std::string nm)
 Set the name added to the particle. More...
 
void set_sphere_depth (double h)
 
void set_sphere_radius (double R)
 
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)
 return true if the particle has a R and h defined More...
 
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static FloatKey get_sphere_depth_key ()
 get the decorator key for the sphere depth More...
 
static FloatKey get_sphere_radius_key ()
 get the decorator key for sphere radius More...
 
static SlabWithSphericalIndent setup_particle (Model *m, ParticleIndex pi, double R, double h)
 
static SlabWithSphericalIndent setup_particle (IMP::ParticleAdaptor pa, double R, double h)
 

Additional Inherited Members

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

Member Function Documentation

std::string IMP::npc::SlabWithSphericalIndent::get_decorator_name ( ) const

Get the name added to the particle (Ensures decorator_name to be the same as the name_key)

Definition at line 81 of file SlabWithSphericalIndent.h.

+ Here is the call graph for this function:

static bool IMP::npc::SlabWithSphericalIndent::get_is_setup ( Model m,
ParticleIndex  pi 
)
static

return true if the particle has a R and h defined

Definition at line 45 of file SlabWithSphericalIndent.h.

+ Here is the call graph for this function:

Float IMP::npc::SlabWithSphericalIndent::get_sphere_depth ( ) const

return the sphere depth

Definition at line 65 of file SlabWithSphericalIndent.h.

+ Here is the call graph for this function:

static FloatKey IMP::npc::SlabWithSphericalIndent::get_sphere_depth_key ( )
static

get the decorator key for the sphere depth

Float IMP::npc::SlabWithSphericalIndent::get_sphere_radius ( ) const

return the sphere radius

Definition at line 60 of file SlabWithSphericalIndent.h.

+ Here is the call graph for this function:

static FloatKey IMP::npc::SlabWithSphericalIndent::get_sphere_radius_key ( )
static

get the decorator key for sphere radius

void IMP::npc::SlabWithSphericalIndent::set_decorator_name ( std::string  nm)

Set the name added to the particle.

Definition at line 86 of file SlabWithSphericalIndent.h.

+ Here is the call graph for this function:

static SlabWithSphericalIndent IMP::npc::SlabWithSphericalIndent::setup_particle ( IMP::ParticleAdaptor  pa,
double  R,
double  h 
)
static
Returns
a SlabWithSphericalIndent object that decorates the particle specified by pa
See Also
setup_particle(m, p, R , h )

Definition at line 94 of file SlabWithSphericalIndent.h.

static SlabWithSphericalIndent IMP::npc::SlabWithSphericalIndent::setup_particle ( Model m,
ParticleIndex  pi,
double  R,
double  h 
)
static
Returns
a SlabWithSphericalIndent object that decorates particle pi

Definition at line 94 of file SlabWithSphericalIndent.h.


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