IMP logo
IMP Reference Guide  develop.d247202c1c,2019/10/23
The Integrative Modeling Platform
IMP::core::Typed Class Reference

A decorator for classifying particles in your system. More...

#include <IMP/core/Typed.h>

+ Inheritance diagram for IMP::core::Typed:

Detailed Description

A decorator for classifying particles in your system.

See Also
ParticleType

Definition at line 34 of file Typed.h.

Public Member Functions

 Typed (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Typed (const IMP::ParticleAdaptor &d)
 
ParticleType get_type () const
 
void set_type (ParticleType pt) const
 
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 (Model *m, ParticleIndex pi)
 
static IntKey get_type_key ()
 
static Typed setup_particle (Model *m, ParticleIndex pi, ParticleType t)
 
static Typed setup_particle (IMP::ParticleAdaptor decorator, ParticleType t)
 

Additional Inherited Members

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

Member Function Documentation

static Typed IMP::core::Typed::setup_particle ( IMP::ParticleAdaptor  decorator,
ParticleType  t 
)
static
See Also
setup_particle(m, pi, t )

Definition at line 44 of file Typed.h.

static Typed IMP::core::Typed::setup_particle ( Model m,
ParticleIndex  pi,
ParticleType  t 
)
static

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

Definition at line 44 of file Typed.h.


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