IMP logo
Public Member Functions | Static Public Member Functions
IMP::domino::RigidBodyStates Class Reference

Detailed Description

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

Examples: rigid body excluded volume

+ Inheritance diagram for IMP::domino::RigidBodyStates:

List of all members.

Public Member Functions

 RigidBodyStates (const algebra::ReferenceFrame3Ds &states, double scale=1)
algebra::VectorKD get_embedding (unsigned int i) const
 Return an embedding of the state.
unsigned int get_nearest_state (const algebra::VectorKD &v) const
 Return the state closest to a given embedding.
algebra::ReferenceFrame3D get_reference_frame (unsigned int i) const
- Public Member Functions inherited from IMP::domino::ParticleStates
 ParticleStates (std::string name="ParticleStates %1%")
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)

Static Public Member Functions

static RigidBodyStatesget_from (IMP::base::Object *o)

Member Function Documentation

algebra::VectorKD IMP::domino::RigidBodyStates::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 from IMP::domino::ParticleStates.

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

Return the state closest to a given embedding.

Reimplemented from IMP::domino::ParticleStates.


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

Generated on Tue May 22 2012 23:33:33 for IMP by doxygen 1.8.1