Public Member Functions
shadowrobot::VirtualShadowhandLibrary Class Reference

#include <virtual_shadowhand_library.h>

Inheritance diagram for shadowrobot::VirtualShadowhandLibrary:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual JointsMap getAllJointsData ()
virtual void getConfig (std::string joint_name)
virtual JointControllerData getContrl (std::string ctrlr_name)
virtual std::vector
< DiagnosticData
getDiagnostics ()
virtual JointData getJointData (std::string joint_name)
virtual short sendupdate (std::string joint_name, double target)
virtual short setConfig (std::vector< std::string > myConfig)
virtual short setContrl (std::string contrlr_name, JointControllerData ctrlr_data)
 VirtualShadowhandLibrary ()
 ~VirtualShadowhandLibrary ()

Detailed Description

Definition at line 19 of file virtual_shadowhand_library.h.


Constructor & Destructor Documentation

Definition at line 18 of file virtual_shadowhand_library.cpp.

Definition at line 23 of file virtual_shadowhand_library.h.


Member Function Documentation

Get the data for all the joints.

Returns:
a mapping between the joints names and the information for each joint.

Implements shadowrobot::SRArticulatedRobot.

Definition at line 106 of file virtual_shadowhand_library.cpp.

void shadowrobot::VirtualShadowhandLibrary::getConfig ( std::string  joint_name) [virtual]

Get the config of the palm

Todo:
Not implemented yet
Parameters:
joint_name

Implements shadowrobot::SRArticulatedRobot.

Definition at line 126 of file virtual_shadowhand_library.cpp.

Get the controller parameters for a given controller name.

Parameters:
contrlr_namethe name of the controller.
Returns:
The parameters of this controller

Implements shadowrobot::SRArticulatedRobot.

Definition at line 117 of file virtual_shadowhand_library.cpp.

Get the diagnostics for the whole articulated robot.

Returns:
A vector containing all the diagnostics for the robot (motor information, etc...)

Implements shadowrobot::SRArticulatedRobot.

Definition at line 129 of file virtual_shadowhand_library.cpp.

JointData shadowrobot::VirtualShadowhandLibrary::getJointData ( std::string  joint_name) [virtual]

Get the joint data for a specific joint.

See also:
JointData
Parameters:
joint_nameThe name of the joint, as specified in joints_map.
Returns:
The information regarding this joint.

Implements shadowrobot::SRArticulatedRobot.

Definition at line 101 of file virtual_shadowhand_library.cpp.

short shadowrobot::VirtualShadowhandLibrary::sendupdate ( std::string  joint_name,
double  target 
) [virtual]

Generic method called to pass a new target to an articulated robot.

Parameters:
joint_nameThe Joint in joints_map you wish to send the target to.
targetThe target in degree
Returns:
0 if success ; -1 if error

Implements shadowrobot::SRArticulatedRobot.

Definition at line 96 of file virtual_shadowhand_library.cpp.

short shadowrobot::VirtualShadowhandLibrary::setConfig ( std::vector< std::string >  myConfig) [virtual]

Set the config of the palm

Todo:
Not implemented yet
Parameters:
myConfig
Returns:

Implements shadowrobot::SRArticulatedRobot.

Definition at line 122 of file virtual_shadowhand_library.cpp.

short shadowrobot::VirtualShadowhandLibrary::setContrl ( std::string  contrlr_name,
JointControllerData  ctrlr_data 
) [virtual]

Set the controller parameters for a given controller name.

Parameters:
contrlr_nameThe name of the controller to setup.
ctrlr_dataThe data to pass to this controller.
Returns:
0 if success.

Implements shadowrobot::SRArticulatedRobot.

Definition at line 113 of file virtual_shadowhand_library.cpp.


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


sr_hand
Author(s): Ugo Cupcic / ugo@shadowrobot.com, contact@shadowrobot.com
autogenerated on Fri Jan 3 2014 12:03:25