IMP::domino::ParticleStates Class Reference

---

Detailed Description

Handle the states for a particular particle (or "class" of particles. For example a state enumerator class could take a bounding box and a number,n, and generate n points in the bounding box. Then the get_number function woudld return n and update_to_state would modify the particle to have the coordiantes for state i.

Inheritance diagram for IMP::domino::ParticleStates:

List of all members.

Public Member Functions
	ParticleStates (std::string name="ParticleStates %1%")
virtual algebra::VectorKD	get_embedding (unsigned int i) const
	Return an embedding of the state.
virtual unsigned int	get_nearest_state (const algebra::VectorKD &v) const
	Return the state closest to a given embedding.
virtual unsigned int	get_number_of_particle_states () const =0
virtual void	load_particle_state (unsigned int, Particle *) const =0
Public Member Functions inherited from IMP::base::Object
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
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.
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::base::Object
	Object (std::string name)

---

Member Function Documentation

virtual algebra::VectorKD IMP::domino::ParticleStates::get_embedding ( unsigned int  i ) const

virtual

Return an embedding of the state.

By default this just returns a 1D vector containing the index. The vector needs to have the same dimension for each value of i.

Reimplemented in IMP::domino::NestedRigidBodyStates, IMP::domino::RigidBodyStates, and IMP::domino::XYZStates.

virtual unsigned int IMP::domino::ParticleStates::get_nearest_state ( const algebra::VectorKD &  v ) const

virtual

Return the state closest to a given embedding.

Reimplemented in IMP::domino::NestedRigidBodyStates, IMP::domino::RigidBodyStates, and IMP::domino::XYZStates.

---

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

• particle_states.h