#include <visp3/robot/vpRobot.h>

Inheritance diagram for vpRobot:

Public Types
enum	vpRobotStateType { STATE_STOP, STATE_VELOCITY_CONTROL, STATE_POSITION_CONTROL, STATE_ACCELERATION_CONTROL }

enum	vpControlFrameType { REFERENCE_FRAME, ARTICULAR_FRAME, CAMERA_FRAME, MIXT_FRAME }

Public Member Functions
	vpRobot (void)

	vpRobot (const vpRobot &robot)

virtual	~vpRobot ()

virtual void	get_eJe (vpMatrix &_eJe)=0

virtual void	get_fJe (vpMatrix &_fJe)=0

virtual void	getDisplacement (const vpRobot::vpControlFrameType frame, vpColVector &q)=0

double	getMaxTranslationVelocity (void) const

double	getMaxRotationVelocity (void) const

virtual void	getPosition (const vpRobot::vpControlFrameType frame, vpColVector &q)=0

vpColVector	getPosition (const vpRobot::vpControlFrameType frame)

virtual vpRobotStateType	getRobotState (void) const

virtual void	init ()=0

vpRobot &	operator= (const vpRobot &robot)

void	setMaxRotationVelocity (const double maxVr)

void	setMaxTranslationVelocity (const double maxVt)

virtual void	setPosition (const vpRobot::vpControlFrameType frame, const vpColVector &q)=0

virtual vpRobotStateType	setRobotState (const vpRobot::vpRobotStateType newState)

virtual void	setVelocity (const vpRobot::vpControlFrameType frame, const vpColVector &vel)=0

void	setVerbose (bool verbose)

Static Public Member Functions
static vpColVector	saturateVelocities (const vpColVector &v_in, const vpColVector &v_max, bool verbose=false)

Protected Member Functions
vpControlFrameType	setRobotFrame (vpRobot::vpControlFrameType newFrame)

vpControlFrameType	getRobotFrame (void) const

Protected Attributes
double	maxTranslationVelocity

double	maxRotationVelocity

int	nDof

vpMatrix	eJe

int	eJeAvailable

vpMatrix	fJe

int	fJeAvailable

int	areJointLimitsAvailable

double *	qmin

double *	qmax

bool	verbose_

Static Protected Attributes
static const double	maxTranslationVelocityDefault = 0.2

static const double	maxRotationVelocityDefault = 0.7

Detailed Description

class that defines a generic virtual robot

Definition at line 58 of file vpRobot.h.

Member Enumeration Documentation

enum vpRobot::vpControlFrameType

Robot control frames.

Enumerator
REFERENCE_FRAME	Corresponds to a fixed reference frame attached to the robot structure.
ARTICULAR_FRAME	Corresponds to the joint space.
CAMERA_FRAME	Corresponds to a frame attached to the camera mounted on the robot end-effector.
MIXT_FRAME	Corresponds to a "virtual" frame where translations are expressed in the reference frame, and rotations in the camera frame.

Definition at line 76 of file vpRobot.h.

enum vpRobot::vpRobotStateType

Robot control states.

Enumerator
STATE_STOP	Stops robot motion especially in velocity and acceleration control.
STATE_VELOCITY_CONTROL	Initialize the velocity controller.
STATE_POSITION_CONTROL	Initialize the position controller.
STATE_ACCELERATION_CONTROL	Initialize the acceleration controller.

Definition at line 64 of file vpRobot.h.

Constructor & Destructor Documentation

vpRobot::vpRobot ( void )

Definition at line 50 of file vpRobot.cpp.

vpRobot::vpRobot ( const vpRobot & robot )

Definition at line 61 of file vpRobot.cpp.

vpRobot::~vpRobot ( )

virtual

Destructor that free allocated memory.

Definition at line 76 of file vpRobot.cpp.

References qmax, and qmin.

Member Function Documentation

virtual void vpRobot::get_eJe ( vpMatrix & _eJe )

pure virtual

Get the robot Jacobian expressed in the end-effector frame.

Implemented in vpRobotViper650, vpRobotViper850, vpRobotAfma6, vpRobotAfma4, vpSimulatorViper850, vpSimulatorAfma6, vpRobotBiclops, vpSimulatorPioneerPan, vpRobotCamera, vpSimulatorPioneer, vpSimulatorCamera, vpRobotPtu46, vpRobotPioneer, and vpRobotTemplate.

virtual void vpRobot::get_fJe ( vpMatrix & _fJe )

pure virtual

Get the robot Jacobian expressed in the robot reference (or world) frame.

Implemented in vpRobotViper650, vpRobotViper850, vpRobotAfma6, vpRobotAfma4, vpSimulatorViper850, vpSimulatorAfma6, vpRobotBiclops, vpRobotPtu46, and vpRobotTemplate.

virtual void vpRobot::getDisplacement	(	const vpRobot::vpControlFrameType	frame,
		vpColVector &	q
	)

pure virtual

Get a displacement (frame as to ve specified) between two successive position control.

Implemented in vpRobotViper650, vpRobotViper850, vpRobotAfma6, vpSimulatorViper850, vpRobotAfma4, vpSimulatorAfma6, vpRobotBiclops, vpRobotPtu46, and vpRobotTemplate.

double vpRobot::getMaxRotationVelocity ( void ) const

Get the maximal rotation velocity that can be sent to the robot during a velocity control.

Returns: Maximum rotation velocity expressed in rad/s.

Definition at line 275 of file vpRobot.cpp.

Referenced by vpSimulatorAfma6::computeArticularVelocity(), vpSimulatorViper850::computeArticularVelocity(), vpSimulatorAfma6::findHighestPositioningSpeed(), vpSimulatorViper850::findHighestPositioningSpeed(), vpSimulatorAfma6::setPosition(), vpSimulatorCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpRobotPioneer::setVelocity(), vpSimulatorAfma6::setVelocity(), vpSimulatorViper850::setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotViper850::setVelocity(), and vpRobotViper650::setVelocity().

double vpRobot::getMaxTranslationVelocity ( void ) const

Get the maximal translation velocity that can be sent to the robot during a velocity control.

Returns: Maximum translation velocity expressed in m/s.

Definition at line 250 of file vpRobot.cpp.

Referenced by vpSimulatorAfma6::setPosition(), vpSimulatorCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpRobotPioneer::setVelocity(), vpSimulatorAfma6::setVelocity(), vpSimulatorViper850::setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotViper850::setVelocity(), and vpRobotViper650::setVelocity().

virtual void vpRobot::getPosition	(	const vpRobot::vpControlFrameType	frame,
		vpColVector &	q
	)

pure virtual

Get the robot position (frame has to be specified).

Implemented in vpRobotViper850, vpRobotViper650, vpRobotAfma6, vpSimulatorViper850, vpRobotAfma4, vpSimulatorAfma6, vpRobotBiclops, vpSimulatorPioneerPan, vpRobotCamera, vpSimulatorPioneer, vpSimulatorCamera, vpRobotPtu46, and vpRobotTemplate.

vpColVector vpRobot::getPosition ( const vpRobot::vpControlFrameType frame )

Return the current robot position in the specified frame.

Definition at line 218 of file vpRobot.cpp.

vpControlFrameType vpRobot::getRobotFrame ( void ) const

inlineprotected

Definition at line 160 of file vpRobot.h.

Referenced by vpSimulatorAfma6::computeArticularVelocity(), and vpSimulatorViper850::computeArticularVelocity().

virtual vpRobotStateType vpRobot::getRobotState ( void ) const

inlinevirtual

Definition at line 138 of file vpRobot.h.

Referenced by vpRobotBiclops::getPosition(), vpRobotBiclops::getVelocity(), vpSimulatorCamera::setPosition(), vpRobotCamera::setPosition(), vpRobotPtu46::setPosition(), vpRobotBiclops::setPosition(), vpSimulatorAfma6::setPosition(), vpSimulatorViper850::setPosition(), vpRobotAfma4::setPosition(), vpRobotAfma6::setPosition(), vpRobotViper850::setPosition(), vpRobotViper650::setPosition(), vpRobotPtu46::setRobotState(), vpRobotBiclops::setRobotState(), vpSimulatorAfma6::setRobotState(), vpSimulatorViper850::setRobotState(), vpRobotAfma4::setRobotState(), vpRobotAfma6::setRobotState(), vpRobotViper850::setRobotState(), vpRobotViper650::setRobotState(), vpSimulatorCamera::setVelocity(), vpSimulatorPioneer::setVelocity(), vpRobotCamera::setVelocity(), vpSimulatorPioneerPan::setVelocity(), vpRobotPtu46::setVelocity(), vpRobotBiclops::setVelocity(), vpSimulatorAfma6::setVelocity(), vpSimulatorViper850::setVelocity(), vpRobotAfma4::setVelocity(), vpRobotAfma6::setVelocity(), vpRobotViper850::setVelocity(), vpRobotViper650::setVelocity(), vpSimulatorAfma6::stopMotion(), vpSimulatorViper850::stopMotion(), vpRobotViper850::stopMotion(), and vpRobotViper650::stopMotion().

virtual void vpRobot::init ( )

pure virtual

Implemented in vpRobotViper650, vpRobotViper850, vpRobotWireFrameSimulator, vpRobotAfma6, vpSimulatorViper850, vpSimulatorAfma6, vpRobotAfma4, vpRobotBiclops, vpRobotPioneer, vpRobotPtu46, and vpRobotTemplate.

vpRobot & vpRobot::operator= ( const vpRobot & robot )

Copy operator.

Definition at line 89 of file vpRobot.cpp.

References areJointLimitsAvailable, eJe, eJeAvailable, fJe, fJeAvailable, maxRotationVelocity, maxTranslationVelocity, nDof, qmax, qmin, and verbose_.

vpColVector vpRobot::saturateVelocities	(	const vpColVector &	v_in,
		const vpColVector &	v_max,
		bool	verbose = `false`
	)

static

Saturate velocities.

Parameters

v_in	: Vector of input velocities to saturate. Translation velocities should be expressed in m/s while rotation velocities in rad/s.
v_max	: Vector of maximal allowed velocities. Maximal translation velocities should be expressed in m/s while maximal rotation velocities in rad/s.
verbose	: Print a message indicating which axis causes the saturation.

Returns: Saturated velocities.

Exceptions

vpRobotException::dimensionError : If the input vectors have different dimensions.

The code below shows how to use this static method in order to saturate a velocity skew vector.

#include <iostream>
#include <visp3/robot/vpRobot.h>
int main()
{
  // Set a velocity skew vector
  vpColVector v(6);
  v[0] = 0.1;               // vx in m/s
  v[1] = 0.2;               // vy
  v[2] = 0.3;               // vz
  v[3] = vpMath::rad(10);   // wx in rad/s
  v[4] = vpMath::rad(-10);  // wy
  v[5] = vpMath::rad(20);   // wz
  // Set the maximal allowed velocities
  vpColVector v_max(6);
  for (int i=0; i<3; i++)
    v_max[i] = 0.3;             // in translation (m/s)
  for (int i=3; i<6; i++)
    v_max[i] = vpMath::rad(10); // in rotation (rad/s)
  // Compute the saturated velocity skew vector
  vpColVector v_sat = vpRobot::saturateVelocities(v, v_max, true);
  std::cout << "v    : " << v.t() << std::endl;
  std::cout << "v max: " << v_max.t() << std::endl;
  std::cout << "v sat: " << v_sat.t() << std::endl;
  return 0;
}