See IMP.kinematics for more information.

Classes
class	BondAngleRevoluteJoint

class	CompositeJoint

class	DihedralAngleRevoluteJoint

class	DOF

class	DOFsSampler

class	Joint

class	KinematicForest

class	KinematicForestScoreState

class	KinematicNode

class	LocalPlanner

class	PathLocalPlanner

class	PrismaticJoint

class	ProteinKinematics

class	RevoluteJoint

class	RRT

class	TransformationJoint

class	UniformBackboneSampler

Typedefs
typedef IMP::base::Vector < IMP::base::Pointer < BondAngleRevoluteJoint > >	BondAngleRevolteJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < BondAngleRevoluteJoint > >	BondAngleRevolteJointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < CompositeJoint > >	CompositeJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < CompositeJoint > >	CompositeJointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < DihedralAngleRevoluteJoint > >	DihedralAngleRevoluteJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < DihedralAngleRevoluteJoint > >	DihedralAngleRevoluteJointsTemp

typedef IMP::base::Vector < DirectionalDOF >	DirectionalDOFs

typedef IMP::base::Vector < IMP::base::Pointer< DOF > >	DOFs

typedef IMP::base::Vector < IMP::base::Pointer < DOFsSampler > >	DOFsSamplers

typedef IMP::base::Vector < IMP::base::WeakPointer < DOFsSampler > >	DOFsSamplersTemp

typedef IMP::base::Vector < IMP::base::WeakPointer< DOF > >	DOFsTemp

typedef IMP::base::Vector < DOFValues >	DOFValuesList

typedef boost::adjacency_list < boost::vecS, boost::vecS, boost::undirectedS, boost::no_property, boost::property < boost::edge_color_t, boost::default_color_type > >	Graph

typedef IMP::base::Vector < IMP::base::Pointer< Joint > >	Joints

typedef IMP::base::Vector < IMP::base::WeakPointer < Joint > >	JointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < KinematicForest > >	KinematicForests

typedef IMP::base::Vector < IMP::base::WeakPointer < KinematicForest > >	KinematicForestsTemp

typedef IMP::base::Vector < KinematicNode >	KinematicNodes

typedef IMP::base::Vector < IMP::base::Pointer < LocalPlanner > >	LocalPlanners

typedef IMP::base::Vector < IMP::base::WeakPointer < LocalPlanner > >	LocalPlannersTemp

typedef IMP::base::Vector < IMP::base::Pointer < PathLocalPlanner > >	PathLocalPlanners

typedef IMP::base::Vector < IMP::base::WeakPointer < PathLocalPlanner > >	PathLocalPlannersTemp

typedef IMP::base::Vector < IMP::base::Pointer < PrismaticJoint > >	PrismaticJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < PrismaticJoint > >	PrismaticJointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < RevoluteJoint > >	RevoluteJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < RevoluteJoint > >	RevoluteJointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < TransformationJoint > >	TransformationJoints

typedef IMP::base::Vector < IMP::base::WeakPointer < TransformationJoint > >	TransformationJointsTemp

typedef IMP::base::Vector < IMP::base::Pointer < UniformBackboneSampler > >	UniformBackboneSamplers

typedef IMP::base::Vector < IMP::base::WeakPointer < UniformBackboneSampler > >	UniformBackboneSamplersTemp

Functions
std::string	get_data_path (std::string file_name)
	Return the full path to installed data. More...

std::string	get_example_path (std::string file_name)
	Return the path to installed example data for this module. More...

Standard module methods
All `IMP` modules have a set of standard methods to help get information about the module and about files associated with the module.
std::string	get_module_version ()

std::string	get_module_name ()

Typedef Documentation

typedef IMP::base::Vector<IMP::base::Pointer< BondAngleRevoluteJoint > > IMP::kinematics::BondAngleRevolteJoints

Store a set of objects.

Definition at line 326 of file revolute_joints.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< BondAngleRevoluteJoint > > IMP::kinematics::BondAngleRevolteJointsTemp

Pass a \ set of \ objects. \ See \ BondAngleRevoluteJoint

Definition at line 327 of file revolute_joints.h.

typedef IMP::base::Vector<IMP::base::Pointer< CompositeJoint > > IMP::kinematics::CompositeJoints

Store a set of objects.

Definition at line 140 of file CompositeJoint.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< CompositeJoint > > IMP::kinematics::CompositeJointsTemp

Pass a \ set of \ objects. \ See \ CompositeJoint

Definition at line 140 of file CompositeJoint.h.

typedef IMP::base::Vector<IMP::base::Pointer< DihedralAngleRevoluteJoint > > IMP::kinematics::DihedralAngleRevoluteJoints

Store a set of objects.

Definition at line 325 of file revolute_joints.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< DihedralAngleRevoluteJoint > > IMP::kinematics::DihedralAngleRevoluteJointsTemp

Pass a \ set of \ objects. \ See \ DihedralAngleRevoluteJoint

Definition at line 326 of file revolute_joints.h.

typedef IMP::base::Vector< DirectionalDOF > IMP::kinematics::DirectionalDOFs

Pass or store a set of DirectionalDOF .

Definition at line 102 of file directional_DOFs.h.

typedef IMP::base::Vector<IMP::base::Pointer< DOF > > IMP::kinematics::DOFs

Store a set of objects.

Definition at line 73 of file DOF.h.

typedef IMP::base::Vector<IMP::base::Pointer< DOFsSampler > > IMP::kinematics::DOFsSamplers

Store a set of objects.

Definition at line 94 of file DOFsSampler.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< DOFsSampler > > IMP::kinematics::DOFsSamplersTemp

Pass a \ set of \ objects. \ See \ DOFsSampler

Definition at line 94 of file DOFsSampler.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< DOF > > IMP::kinematics::DOFsTemp

Pass a \ set of \ objects. \ See \ DOF

Definition at line 73 of file DOF.h.

typedef IMP::base::Vector< DOFValues > IMP::kinematics::DOFValuesList

Pass or store a set of DOFValues .

Definition at line 64 of file DOFValues.h.

typedef IMP::base::Vector<IMP::base::Pointer< Joint > > IMP::kinematics::Joints

Store a set of objects.

Definition at line 145 of file Joint.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< Joint > > IMP::kinematics::JointsTemp

Pass a \ set of \ objects. \ See \ Joint

Definition at line 145 of file Joint.h.

typedef IMP::base::Vector<IMP::base::Pointer< KinematicForest > > IMP::kinematics::KinematicForests

Store a set of objects.

Definition at line 279 of file KinematicForest.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< KinematicForest > > IMP::kinematics::KinematicForestsTemp

Pass a \ set of \ objects. \ See \ KinematicForest

Definition at line 279 of file KinematicForest.h.

typedef IMP::base::Vector<IMP::base::Pointer< LocalPlanner > > IMP::kinematics::LocalPlanners

Store a set of objects.

Definition at line 91 of file local_planners.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< LocalPlanner > > IMP::kinematics::LocalPlannersTemp

Pass a \ set of \ objects. \ See \ LocalPlanner

Definition at line 91 of file local_planners.h.

typedef IMP::base::Vector<IMP::base::Pointer< PathLocalPlanner > > IMP::kinematics::PathLocalPlanners

Store a set of objects.

Definition at line 91 of file local_planners.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< PathLocalPlanner > > IMP::kinematics::PathLocalPlannersTemp

Pass a \ set of \ objects. \ See \ PathLocalPlanner

Definition at line 92 of file local_planners.h.

typedef IMP::base::Vector<IMP::base::Pointer< PrismaticJoint > > IMP::kinematics::PrismaticJoints

Store a set of objects.

Definition at line 89 of file PrismaticJoint.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< PrismaticJoint > > IMP::kinematics::PrismaticJointsTemp

Pass a \ set of \ objects. \ See \ PrismaticJoint

Definition at line 89 of file PrismaticJoint.h.

typedef IMP::base::Vector<IMP::base::Pointer< RevoluteJoint > > IMP::kinematics::RevoluteJoints

Store a set of objects.

Definition at line 325 of file revolute_joints.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< RevoluteJoint > > IMP::kinematics::RevoluteJointsTemp

Pass a \ set of \ objects. \ See \ RevoluteJoint

Definition at line 325 of file revolute_joints.h.

typedef IMP::base::Vector<IMP::base::Pointer< TransformationJoint > > IMP::kinematics::TransformationJoints

Store a set of objects.

Definition at line 52 of file TransformationJoint.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< TransformationJoint > > IMP::kinematics::TransformationJointsTemp

Pass a \ set of \ objects. \ See \ TransformationJoint

Definition at line 52 of file TransformationJoint.h.

typedef IMP::base::Vector<IMP::base::Pointer< UniformBackboneSampler > > IMP::kinematics::UniformBackboneSamplers

Store a set of objects.

Definition at line 48 of file UniformBackboneSampler.h.

typedef IMP::base::Vector<IMP::base::WeakPointer< UniformBackboneSampler > > IMP::kinematics::UniformBackboneSamplersTemp

Pass a \ set of \ objects. \ See \ UniformBackboneSampler

Definition at line 48 of file UniformBackboneSampler.h.

Function Documentation

std::string IMP::kinematics::get_data_path ( std::string file_name )

Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data directory of module "mymodule", do something like

std::ifstream in(IMP::mymodule::get_data_path("data_library"));

This will ensure that the code works when IMP is installed or used via the setup_environment.sh script.

std::string IMP::kinematics::get_example_path ( std::string file_name )

Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb located in the examples directory of the IMP::atom module, do

IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",

model));

This will ensure that the code works when IMP is installed or used via the setup_environment.sh script.

Classes

Typedefs

Functions

Standard module methods

Typedef Documentation

Function Documentation