IMP::kinematics::PathLocalPlanner Class Reference

#include <IMP/kinematics/local_planners.h>

Inheritance diagram for IMP::kinematics::PathLocalPlanner:

Public Member Functions
	PathLocalPlanner (kernel::Model *model, DOFsSampler *dofs_sampler, DirectionalDOF *directional_dof, int save_step_interval=1)
	construct a path planner (default planning is linear) More...
Public Member Functions inherited from IMP::kinematics::LocalPlanner
	LocalPlanner (kernel::Model *model, DOFsSampler *dofs_sampler)
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.
bool	is_valid (const DOFValues &values)
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 std::vector< DOFValues >	plan (DOFValues q_from, DOFValues q_rand)
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Additional Inherited Members
Protected Attributes inherited from IMP::kinematics::LocalPlanner
DOFsSampler *	dofs_sampler_
base::PointerMember < kernel::Model >	model_
base::PointerMember < kernel::ScoringFunction >	sf_

Detailed Description

Local planner implementation that samples conformations on a path between two nodes.

Note

the default path planning is over a linear interpolation between the nodes

Definition at line 56 of file local_planners.h.

Constructor & Destructor Documentation

IMP::kinematics::PathLocalPlanner::PathLocalPlanner	(	kernel::Model *	model,
		DOFsSampler *	dofs_sampler,
		DirectionalDOF *	directional_dof,
		int	save_step_interval = 1
	)

construct a path planner

Parameters

model	the working model
dofs_sampler	an object for sampling node configurations
directional_dof	XX TODO XX
save_step_interval	the interval for recording nodes in the path. For instance, 2 would mean save every second node in the local plan.

Member Function Documentation

virtual std::vector<DOFValues> IMP::kinematics::PathLocalPlanner::plan ( DOFValues  q_from, DOFValues  q_rand  )

protectedvirtual

plan a linear path of intermediate nodes with a properly calculated step size from existing node q_from until the valid node that is found closest to q_rand (inclusive)

Implements IMP::kinematics::LocalPlanner.

---

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

• local_planners.h