IMP::kinematics::DOF Class Reference

Representation of one degree of freedom (DOF). More...

#include <IMP/kinematics/DOF.h>

Inheritance diagram for IMP::kinematics::DOF:

Detailed Description

Representation of one degree of freedom (DOF).

A general class for representing one degree of freedom (DOF) that is a double. the class holds min/max range for the DOF, as well as the step size for passing the DOFs values around. It relies on a DOFValues class that only holds DOF value for each DOF

Note

Typically, a DOF would correspond to one joint, with the exception of transformation joint that has 6 DOFs (though collective joints such as normal modes might be supported in principle)

Definition at line 31 of file DOF.h.

Public Member Functions
	DOF (double v)
	DOF (double v, double min, double max, double step_size)
int	get_number_of_steps (double value) const
	Return the number of steps between the input value and current DOF value. More...
int	get_number_of_steps (double value1, double value2) const
	Return the number of steps between between the two values. More...
std::pair< double, double >	get_range () const
double	get_step_size () const
	Set step size for going in the direction of the sampled value. More...
virtual std::string	get_type_name () const override
double	get_value () const
virtual ::IMP::VersionInfo	get_version_info () const override
	Get information about the module and version of the object. More...
void	set_range (std::pair< double, double > range)
void	set_step_size (double step_size)
void	set_value (double v)
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

int IMP::kinematics::DOF::get_number_of_steps

(

double

value

)

const

Return the number of steps between the input value and current DOF value.

int IMP::kinematics::DOF::get_number_of_steps	(	double	value1,
		double	value2
	)		const

Return the number of steps between between the two values.

double IMP::kinematics::DOF::get_step_size

(

)

const

Set step size for going in the direction of the sampled value.

Definition at line 49 of file DOF.h.

virtual ::IMP::VersionInfo IMP::kinematics::DOF::get_version_info ( ) const

overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 32 of file DOF.h.

---

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

• DOF.h