IMP  2.2.1
The Integrative Modeling Platform
IMP::kinematics Namespace Reference

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

Store a set of objects.

Definition at line 131 of file CompositeJoint.h.

Pass or store a set of DirectionalDOF .

Definition at line 99 of file directional_DOFs.h.

Store a set of objects.

Definition at line 70 of file DOF.h.

Store a set of objects.

Definition at line 86 of file DOFsSampler.h.

Pass a set of objects. See DOFsSampler

Definition at line 86 of file DOFsSampler.h.

Pass a set of objects. See DOF

Definition at line 70 of file DOF.h.

Pass or store a set of DOFValues .

Definition at line 61 of file DOFValues.h.

Store a set of objects.

Definition at line 130 of file Joint.h.

Pass a set of objects. See Joint

Definition at line 130 of file Joint.h.

Store a set of objects.

Definition at line 272 of file KinematicForest.h.

Store a set of objects.

Definition at line 83 of file local_planners.h.

Store a set of objects.

Definition at line 83 of file local_planners.h.

Store a set of objects.

Definition at line 86 of file PrismaticJoint.h.

Store a set of objects.

Definition at line 306 of file revolute_joints.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

model));

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