Detailed Description

Store a set of states which explicitly define the XYZ coordinates of the particle in question.

Definition at line 137 of file particle_states.h.

Public Member Functions
	XYZStates (const algebra::Vector3Ds &states)

algebra::VectorKD	get_embedding (unsigned int i) const
	Return an embedding of the state. More...

unsigned int	get_nearest_state (const algebra::VectorKD &v) const
	Return the state closest to a given embedding. More...

virtual unsigned int	get_number_of_particle_states () const

virtual std::string	get_type_name () const

algebra::Vector3D	get_vector (unsigned int i) const

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

virtual void	load_particle_state (unsigned int, Particle *) const

Public Member Functions inherited from IMP::domino::ParticleStates
	ParticleStates (std::string name="ParticleStates %1%")

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::Object
	Object (std::string name)
	Construct an object with the given name. More...

virtual void	do_destroy ()

Member Function Documentation

algebra::VectorKD IMP::domino::XYZStates::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.

Definition at line 150 of file particle_states.h.

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

virtual

Return the state closest to a given embedding.

Definition at line 154 of file particle_states.h.

virtual ::IMP::VersionInfo IMP::domino::XYZStates::get_version_info ( ) const

virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 160 of file particle_states.h.

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