IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
IMP::npctransport::ParticleTransportStatisticsOptimizerState Class Reference

#include <IMP/npctransport/ParticleTransportStatisticsOptimizerState.h>

+ Inheritance diagram for IMP::npctransport::ParticleTransportStatisticsOptimizerState:

Detailed Description

Maintains transport statistics about a particle p in a z-axis aligned channel,

Definition at line 28 of file ParticleTransportStatisticsOptimizerState.h.

Public Member Functions

 ParticleTransportStatisticsOptimizerState (Particle *p, Float bottom_z, Float top_z, WeakPointer< IMP::npctransport::Statistics > statistics_manager=nullptr, WeakPointer< IMP::atom::Simulator > owner=nullptr)
 
virtual void do_update (unsigned int call_num)
 
unsigned int get_n_transports_down () const
 
unsigned int get_n_transports_up () const
 
WeakPointer< IMP::atom::Simulatorget_owner () const
 returns the simulator that was declared in the constructor or by More...
 
unsigned int get_total_n_transports () const
 
Floats const & get_transport_time_points_in_ns () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void reset ()
 
void set_owner (WeakPointer< IMP::atom::Simulator > owner)
 
- Public Member Functions inherited from IMP::OptimizerState
 OptimizerState (Model *m, std::string name)
 Constructor. More...
 
unsigned int get_number_of_updates () const
 Return the number of times do_update() has been called. More...
 
Optimizerget_optimizer () const
 
unsigned int get_period () const
 Get the periodicity of this state. More...
 
virtual void set_is_optimizing (bool)
 Called by an Optimizer to signal begin/end of an optimize run. More...
 
void set_number_of_updates (unsigned int n)
 Set the counter of number of times do_update() has been called. More...
 
void set_period (unsigned int p)
 Set the periodicity of this state. More...
 
virtual void update ()
 Called when the Optimizer accepts a new conformation. More...
 
void update_always ()
 Force the state to perform its action now, ignoring the periodicity. More...
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::OptimizerState
virtual ModelObjectsTemp do_get_inputs () const
 
virtual ModelObjectsTemp do_get_outputs () const
 
virtual void do_set_is_optimizing (bool)
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::npctransport::ParticleTransportStatisticsOptimizerState::ParticleTransportStatisticsOptimizerState ( Particle p,
Float  bottom_z,
Float  top_z,
WeakPointer< IMP::npctransport::Statistics statistics_manager = nullptr,
WeakPointer< IMP::atom::Simulator owner = nullptr 
)

Initiates transport statistics about a particle p in a z-axis aligned channel, whose bottom and top are at z-coordinates bottom_z and top_z, respectively.

Parameters
pthe particle, assumed to be decorated as a RigidBody
bottom_zthe z coordinate of the channel bottom
top_zthe z coordinate of the channel top
statistics_managerStatistics object that can be used to communicate back pertinent information from this object, or nullptr if not managed
ownera simulator that is moving this particle and can provide it with time information, or nullptr

Member Function Documentation

virtual void IMP::npctransport::ParticleTransportStatisticsOptimizerState::do_update ( unsigned int  )
virtual

This method is called every get_period() update calls. The number of times this method has been called since the last reset or start of the optimization run is passed.

Reimplemented from IMP::OptimizerState.

unsigned int IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_n_transports_down ( ) const

Returns the number of times the particle crossed the channel from its top to its bottom

Definition at line 86 of file ParticleTransportStatisticsOptimizerState.h.

unsigned int IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_n_transports_up ( ) const

Returns the number of times the particle crossed the channel from its bottom to its top

Definition at line 81 of file ParticleTransportStatisticsOptimizerState.h.

WeakPointer<IMP::atom::Simulator> IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_owner ( ) const

returns the simulator that was declared in the constructor or by

to moves this particle, and provide simulation time information about it.

Definition at line 75 of file ParticleTransportStatisticsOptimizerState.h.

unsigned int IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_total_n_transports ( ) const

Returns the number of times the particle crossed the channel from any one side to the other

Definition at line 91 of file ParticleTransportStatisticsOptimizerState.h.

Floats const& IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_transport_time_points_in_ns ( ) const

returns a list of all the simulation time points in nanoseconds when a transport even has occurred (according to the owner of this OptimizerState). An empty list is returned if no transport events are known or if there was no owner when they occurred

Definition at line 101 of file ParticleTransportStatisticsOptimizerState.h.

virtual ::IMP::VersionInfo IMP::npctransport::ParticleTransportStatisticsOptimizerState::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 109 of file ParticleTransportStatisticsOptimizerState.h.

void IMP::npctransport::ParticleTransportStatisticsOptimizerState::reset ( )
virtual

resets the number of transports statistics to 0

Reimplemented from IMP::OptimizerState.

void IMP::npctransport::ParticleTransportStatisticsOptimizerState::set_owner ( WeakPointer< IMP::atom::Simulator owner)

sets a simulator that moves this particle and can provide simulation time information about it, or IMP::nullptr if none

Definition at line 68 of file ParticleTransportStatisticsOptimizerState.h.


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