cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
robModifiedDH Class Reference

Modified DH (Craig's) parameters of a link. More...

#include <robModifiedDH.h>

Inheritance diagram for robModifiedDH:
robKinematics robJoint

Public Member Functions

 robModifiedDH ()
 Default constructor. More...
 
 robModifiedDH (double alpha, double a, double theta, double d, const robJoint &joint)
 Overloaded constructor. More...
 
 ~robModifiedDH ()
 Default destructor. More...
 
vctFrame4x4< double > ForwardKinematics (double q) const
 Get the position and orientation of the coordinate frame. More...
 
vctMatrixRotation3< double > Orientation (double q) const
 Get the orientation of the link. More...
 
vctFixedSizeVector< double, 3 > PStar () const
 Return the position of the next (distal) link coordinate frame. More...
 
robKinematicsClone () const
 Clone. More...
 
double GetRotationX () const
 
double GetRotationZ () const
 
double GetTranslationX () const
 
double GetTranslationZ () const
 
void SetRotationX (double x)
 
void SetRotationZ (double x)
 
void SetTranslationX (double x)
 
void SetTranslationZ (double x)
 
- Public Member Functions inherited from robKinematics
 robKinematics (robKinematics::Convention convention)
 Default constructor. More...
 
 robKinematics (const robJoint &joint, robKinematics::Convention convention)
 Overloaded constructor. More...
 
virtual ~robKinematics ()
 
robKinematics::Convention GetConvention () const
 Return the kinematics convention. More...
 
robKinematics::Errno Read (std::istream &is)
 Read the kinematics parameters and joints parameters. More...
 
robKinematics::Errno Write (std::ostream &os) const
 Write the kinematics parameters and joints parameters. More...
 
- Public Member Functions inherited from robJoint
 robJoint ()
 Default constructor. More...
 
 robJoint (robJoint::Type type, robJoint::Mode mode, double offset, double min, double max, double ftmax)
 
robJoint::Type GetType () const
 Return the type of the joint. More...
 
robJoint::Mode GetMode () const
 Return the mode of the joint. More...
 
double GetPosition () const
 Return the joint position. More...
 
double GetVelocity () const
 Return the joint velocity. More...
 
double GetForceTorque () const
 Return the joint force or torque. More...
 
void SetPosition (double q)
 Set the joint position. More...
 
void SetVelocity (double qd)
 Set the joint velocity. More...
 
void SetForceTorque (double ft)
 Set the force/torque. More...
 
double PositionOffset () const
 Return the offset position. More...
 
double PositionMin () const
 Return the minimum position. More...
 
double PositionMax () const
 Return the maximum position. More...
 
double ForceTorqueMax () const
 Return the maximum force/torque. More...
 

Protected Member Functions

void ReadParameters (std::istream &is)
 Read the parameters from an input stream. More...
 
void WriteParameters (std::ostream &os) const
 Write the parameters to an output stream. More...
 

Additional Inherited Members

- Public Types inherited from robKinematics
enum  Convention {
  UNDEFINED, STANDARD_DH, MODIFIED_DH, HAYATI,
  MODIFIED_HAYATI
}
 Kinematics convention. More...
 
- Public Types inherited from robJoint
enum  Type {
  UNDEFINED, HINGE, SLIDER, UNIVERSAL,
  BALLSOCKET
}
 
enum  Mode { ACTIVE, PASSIVE }
 Joint modes. More...
 
enum  Errno { ESUCCESS, EFAILURE }
 
- Static Public Member Functions inherited from robKinematics
static robKinematicsInstantiate (const std::string &type)
 Instantiate a kinematic convention by name. More...
 

Detailed Description

Modified DH (Craig's) parameters of a link.

The modified DH class is used for kinematics parameters.

Constructor & Destructor Documentation

robModifiedDH::robModifiedDH ( )

Default constructor.

robModifiedDH::robModifiedDH ( double  alpha,
double  a,
double  theta,
double  d,
const robJoint joint 
)

Overloaded constructor.

Parameters
alpha
a
theta
d
joint
robModifiedDH::~robModifiedDH ( )

Default destructor.

Member Function Documentation

robKinematics* robModifiedDH::Clone ( ) const
virtual

Clone.

Implements robKinematics.

vctFrame4x4<double> robModifiedDH::ForwardKinematics ( double  q) const
virtual

Get the position and orientation of the coordinate frame.

Returns the position and orientation of the coordinate frame.

Parameters
jointThe joint value
Returns
The position and orientation of the coordinate frame

Implements robKinematics.

double robModifiedDH::GetRotationX ( ) const
inline
double robModifiedDH::GetRotationZ ( ) const
inline
double robModifiedDH::GetTranslationX ( ) const
inline
double robModifiedDH::GetTranslationZ ( ) const
inline
vctMatrixRotation3<double> robModifiedDH::Orientation ( double  q) const
virtual

Get the orientation of the link.

Returns the orientation of the link with respect to the proximal link for a given joint vale.

Parameters
jointThe joint associated with the link
Returns
The orientation associated with the DH parameters

Implements robKinematics.

vctFixedSizeVector<double,3> robModifiedDH::PStar ( ) const
virtual

Return the position of the next (distal) link coordinate frame.

This method returns the $XYZ$ coordinates of the origin of the distal link in the coordinate frame of the proximal link. "PStar" is not a good name for this but the literature uses $ {p}^* $ to denote this value.

Returns
The position of the next coordinate frame wrt to the current frame

Implements robKinematics.

void robModifiedDH::ReadParameters ( std::istream &  is)
protectedvirtual

Read the parameters from an input stream.

Read the parameters from an input stream. The parameters are in the following order: convention, $\alpha$, a, $\theta$, d, <joint>

Parameters
isThe input stream

Implements robKinematics.

void robModifiedDH::SetRotationX ( double  x)
inline
void robModifiedDH::SetRotationZ ( double  x)
inline
void robModifiedDH::SetTranslationX ( double  x)
inline
void robModifiedDH::SetTranslationZ ( double  x)
inline
void robModifiedDH::WriteParameters ( std::ostream &  os) const
protectedvirtual

Write the parameters to an output stream.

Write the parameters to an output stream. The parameters are in the following order: $\alpha$, a, $\theta$, d

Parameters
osThe output stream

Implements robKinematics.


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