IMP Reference Guide
2.14.0
The Integrative Modeling Platform
|
A decorator for a particle transporting through a barrier. More...
#include <IMP/npctransport/Transporting.h>
A decorator for a particle transporting through a barrier.
Definition at line 23 of file Transporting.h.
Public Member Functions | |
Transporting (::IMP::Model *m,::IMP::ParticleIndex id) | |
Transporting (const IMP::ParticleAdaptor &d) | |
bool | get_is_last_entry_from_top () const |
returns whether the particle last enetered the transport moiety from its More... | |
double | get_last_tracked_z () const |
int | get_n_entries_bottom () const |
int | get_n_entries_top () const |
void | set_is_last_entry_from_top (bool is_last_entry_from_top) |
sets whether the particle last enetered the transport moiety from its top More... | |
void | set_last_tracked_z (double last_tracked_z) |
void | set_n_entries_bottom (int n) |
void | set_n_entries_top (int n) |
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... | |
Model * | get_model () const |
Returns the Model containing the particle. More... | |
Particle * | get_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 | |
Particle * | operator-> () const |
Static Public Member Functions | |
static IntKey | get_is_last_entry_from_top_key () |
Get the decorator key for is_last_entry_from_top. More... | |
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
static bool | get_is_setup (Model *m, ParticleIndex pi) |
Return true if the particle is an instance of an Transporting. More... | |
static FloatKey | get_last_tracked_z_key () |
Get the decorator key last_tracked_z value. More... | |
static IntKey | get_n_entries_bottom_key () |
Get the decorator key n_entries_bottom value. More... | |
static IntKey | get_n_entries_top_key () |
Get the decorator key n_entries_top value. More... | |
static Transporting | setup_particle (IMP::ParticleAdaptor decorator, bool is_last_entry_from_top=false) |
static Transporting | setup_particle (Model *m, ParticleIndex pi, bool is_last_entry_from_top=false) |
Additional Inherited Members | |
Protected Member Functions inherited from IMP::Decorator | |
Decorator (Model *m, ParticleIndex pi) | |
Decorator (ParticleAdaptor p) | |
bool IMP::npctransport::Transporting::get_is_last_entry_from_top | ( | ) | const |
returns whether the particle last enetered the transport moiety from its
Definition at line 81 of file Transporting.h.
|
static |
Get the decorator key for is_last_entry_from_top.
|
static |
Return true if the particle is an instance of an Transporting.
Definition at line 66 of file Transporting.h.
double IMP::npctransport::Transporting::get_last_tracked_z | ( | ) | const |
returns the Z coordinate of the particle, the last time it was tracked for transport statistics
Definition at line 96 of file Transporting.h.
|
static |
Get the decorator key last_tracked_z value.
int IMP::npctransport::Transporting::get_n_entries_bottom | ( | ) | const |
gets the number of times the particle crossed from the bottom of the barrier into its interior
Definition at line 111 of file Transporting.h.
|
static |
Get the decorator key n_entries_bottom value.
int IMP::npctransport::Transporting::get_n_entries_top | ( | ) | const |
gets the number of times the particle crossed from the top of the barrier into its interior
Definition at line 126 of file Transporting.h.
|
static |
Get the decorator key n_entries_top value.
void IMP::npctransport::Transporting::set_is_last_entry_from_top | ( | bool | is_last_entry_from_top | ) |
sets whether the particle last enetered the transport moiety from its top
Definition at line 74 of file Transporting.h.
void IMP::npctransport::Transporting::set_last_tracked_z | ( | double | last_tracked_z | ) |
set the Z coordinate of the particle, the last time it was tracked for transport statistics
Definition at line 90 of file Transporting.h.
void IMP::npctransport::Transporting::set_n_entries_bottom | ( | int | n | ) |
sets the number of times the particle crossed from the bottom of the barrier into its interior
Definition at line 105 of file Transporting.h.
void IMP::npctransport::Transporting::set_n_entries_top | ( | int | n | ) |
sets the number of times the particle crossed from the top of the barrier into its interior
Definition at line 120 of file Transporting.h.
|
static |
Decorate a transporting particle, mainly for tracking transport statistics (number of transports, etc.). It is assumed the transport occurs along a z coordinate, and that the crossed barrier is bounded from top and bottom. The last tracked z is set to the z coordinate of p, initially, and n entries from bottom and top are set to 0
m | the model |
pi | particle index |
is_last_entry_from_top | has particle last entered from top of barrier (rather than bottom or unknown)Setup the particle so that it can be used with this decorator |
Definition at line 63 of file Transporting.h.
|
static |
Definition at line 63 of file Transporting.h.