KDL::Wrench Class Reference

represents both translational and rotational acceleration. More...

#include <frames.hpp>

List of all members.

Public Member Functions

double operator() (int i) const
 index-based access to components, first force(0..2), then torque(3..5) for use with a const Wrench
double & operator() (int i)
 index-based access to components, first force(0..2), then torque(3..5)
Wrenchoperator+= (const Wrench &arg)
Wrenchoperator-= (const Wrench &arg)
double & operator[] (int index)
double operator[] (int index) const
Wrench RefPoint (const Vector &v_base_AB) const
 Changes the reference point of the wrench.
void ReverseSign ()
 Reverses the sign of the current Wrench.
 Wrench (const Vector &_force, const Vector &_torque)
 Wrench ()
 Does initialise force and torque to zero via the underlying constructor of Vector.

Static Public Member Functions

static Wrench Zero ()

Public Attributes

Vector force
 Force that is applied at the origin of the current ref frame.
Vector torque
 Torque that is applied at the origin of the current ref frame.

Friends

bool Equal (const Wrench &a, const Wrench &b, double eps=epsilon)
 do not use operator == because the definition of Equal(.,.
class Frame
bool operator!= (const Wrench &a, const Wrench &b)
 The literal inequality operator!=().
Wrench operator* (double lhs, const Wrench &rhs)
 Scalar multiplication.
Wrench operator* (const Wrench &lhs, double rhs)
 Scalar multiplication.
Wrench operator+ (const Wrench &lhs, const Wrench &rhs)
Wrench operator- (const Wrench &arg)
 An unary - operator.
Wrench operator- (const Wrench &lhs, const Wrench &rhs)
Wrench operator/ (const Wrench &lhs, double rhs)
 Scalar division.
bool operator== (const Wrench &a, const Wrench &b)
 The literal equality operator==(), also identical.
class Rotation
void SetToZero (Wrench &v)
 Sets the Wrench to Zero, to have a uniform function that sets an object or double to zero.

Detailed Description

represents both translational and rotational acceleration.

This class represents an acceleration twist. A acceleration twist is the combination of translational acceleration and rotational acceleration applied at one point. represents the combination of a force and a torque.

This class represents a Wrench. A Wrench is the force and torque applied at a point

Definition at line 826 of file frames.hpp.


Constructor & Destructor Documentation

KDL::Wrench::Wrench (  )  [inline]

Does initialise force and torque to zero via the underlying constructor of Vector.

Definition at line 834 of file frames.hpp.

Referenced by Zero().

KDL::Wrench::Wrench ( const Vector _force,
const Vector _torque 
) [inline]

Definition at line 835 of file frames.hpp.


Member Function Documentation

double KDL::Wrench::operator() ( int  i  )  const [inline]

index-based access to components, first force(0..2), then torque(3..5) for use with a const Wrench

Definition at line 227 of file frames.inl.

References force, and torque.

double & KDL::Wrench::operator() ( int  i  )  [inline]

index-based access to components, first force(0..2), then torque(3..5)

Definition at line 218 of file frames.inl.

References force, and torque.

Referenced by operator[]().

Wrench & KDL::Wrench::operator+= ( const Wrench arg  )  [inline]

Definition at line 211 of file frames.inl.

References force, and torque.

Wrench & KDL::Wrench::operator-= ( const Wrench arg  )  [inline]

Definition at line 204 of file frames.inl.

References force, and torque.

double& KDL::Wrench::operator[] ( int  index  )  [inline]

Definition at line 853 of file frames.hpp.

References operator()().

double KDL::Wrench::operator[] ( int  index  )  const [inline]

Definition at line 848 of file frames.hpp.

References operator()().

Wrench KDL::Wrench::RefPoint ( const Vector v_base_AB  )  const [inline]

Changes the reference point of the wrench.

The vector v_base_AB is expressed in the same base as the twist The vector v_base_AB is a vector from the old point to the new point.

Complexity : 6M+6A

Definition at line 192 of file frames.inl.

void KDL::Wrench::ReverseSign (  )  [inline]

Reverses the sign of the current Wrench.

Definition at line 186 of file frames.inl.

References force, KDL::Vector::ReverseSign(), and torque.

Wrench KDL::Wrench::Zero (  )  [inline, static]
Returns:
a zero Wrench

Definition at line 180 of file frames.inl.

References Wrench(), and KDL::Vector::Zero().


Friends And Related Function Documentation

bool Equal ( const Wrench a,
const Wrench b,
double  eps = epsilon 
) [friend]

do not use operator == because the definition of Equal(.,.

) is slightly different. It compares whether the 2 arguments are equal in an eps-interval

friend class Frame [friend]

Definition at line 900 of file frames.hpp.

bool operator!= ( const Wrench a,
const Wrench b 
) [friend]

The literal inequality operator!=().

Wrench operator* ( double  lhs,
const Wrench rhs 
) [friend]

Scalar multiplication.

Wrench operator* ( const Wrench lhs,
double  rhs 
) [friend]

Scalar multiplication.

Wrench operator+ ( const Wrench lhs,
const Wrench rhs 
) [friend]
Wrench operator- ( const Wrench arg  )  [friend]

An unary - operator.

Wrench operator- ( const Wrench lhs,
const Wrench rhs 
) [friend]
Wrench operator/ ( const Wrench lhs,
double  rhs 
) [friend]

Scalar division.

bool operator== ( const Wrench a,
const Wrench b 
) [friend]

The literal equality operator==(), also identical.

friend class Rotation [friend]

Definition at line 899 of file frames.hpp.

void SetToZero ( Wrench v  )  [friend]

Sets the Wrench to Zero, to have a uniform function that sets an object or double to zero.


Member Data Documentation


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

Generated on Wed Nov 23 19:02:19 2011 for FreeCAD by  doxygen 1.6.1