Class to handle individual model particles. More...

#include <IMP/kernel/declare_Particle.h>

Inheritance diagram for IMP::kernel::Particle:

Public Member Functions
	Particle (kernel::Model *m, std::string name)
	Construct a particle and add it to the Model.

	Particle (kernel::Model *m)
	Construct a particle and add it to the Model.

ParticleIndex	get_index () const

virtual std::string	get_type_name () const

virtual ::IMP::base::VersionInfo	get_version_info () const
	Get information about the module and version of the object.

Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (kernel::Model *m, std::string name)

	ModelObject (std::string name)

virtual void	do_set_model (kernel::Model *)

bool	get_has_dependencies () const
	Return whether this object has dependencies computed.

bool	get_has_required_score_states () const

ModelObjectsTemp	get_inputs () const

ModelObjectsTemps	get_interactions () const

bool	get_is_part_of_model () const

Model *	get_model () const

ModelObjectsTemp	get_outputs () const

const ScoreStatesTemp &	get_required_score_states () const

void	set_has_dependencies (bool tf)

void	set_has_required_score_states (bool tf)

virtual void	set_model (kernel::Model *m)

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

virtual void	do_destroy ()

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)

Protected Member Functions
virtual ModelObjectsTemp	do_get_inputs () const

virtual ModelObjectsTemp	do_get_outputs () const

Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps	do_get_interactions () const

virtual void	handle_set_has_required_score_states (bool)

Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

	Object ()

Detailed Description

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

Examples:: core/simple.cpp.

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

Member Function Documentation

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

protectedvirtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

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

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

protectedvirtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::kernel::ModelObject.

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

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

kernel/declare_Particle.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation