IMP::kernel::Particle Class Reference

Class to handle individual model particles. More...

#include <IMP/kernel/declare_Particle.h>

Inheritance diagram for IMP::kernel::Particle:

Public Member Functions
	Particle (Model *m, std::string name)
	Construct a particle and add it to the Model.
	Particle (Model *m)
	Construct a particle and add it to the Model.
virtual void	do_show (std::ostream &out) const
ParticleIndex	get_index () const
Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (Model *m, std::string name)
ModelObjectsTemp	get_inputs () const
ModelObjectsTemps	get_interactions () const
Model *	get_model () const
ModelObjectsTemp	get_outputs () const
Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()
virtual IMP::base::VersionInfo	get_version_info () const =0
	Get information about the module and version of the object.
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)

Protected Member Functions
virtual ModelObjectsTemp	do_get_inputs () const
virtual ModelObjectsTemp	do_get_outputs () const
virtual void	do_update_dependencies ()
Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps	do_get_interactions () const
virtual void	update_dependencies ()
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Additional Inherited Members
Related Functions inherited from IMP::kernel::ModelObject
typedef IMP::base::Vector < IMP::base::WeakPointer < ModelObject > >	ModelObjectsTemp

Detailed Description

At this point a Particle should only be considered as a placeholder for the ParticleIndex, accessed through the get_index() method.

Definition at line 79 of file kernel/declare_Particle.h.

Member Function Documentation

virtual ModelObjectsTemp IMP::kernel::Particle::do_get_inputs ( ) const

protectedvirtual

Override if this reads other objects during evaluate.

Implements IMP::kernel::ModelObject.

Definition at line 159 of file kernel/declare_Particle.h.

virtual ModelObjectsTemp IMP::kernel::Particle::do_get_outputs ( ) const

protectedvirtual

Override if this writes other objects during evaluate.

Implements IMP::kernel::ModelObject.

Definition at line 162 of file kernel/declare_Particle.h.

virtual void IMP::kernel::Particle::do_update_dependencies ( )

protectedvirtual

This method is called when the dependencies in the model have changed and model evaluate is called (or Model::ensure_dependencies()). The object can use this to update anything that is needed for efficient computation.

Reimplemented from IMP::kernel::ModelObject.

Definition at line 165 of file kernel/declare_Particle.h.

---

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

• kernel/declare_Particle.h