Public Member Functions | List of all members
shadowrobot::VirtualShadowhandLibrary Class Reference

#include <virtual_shadowhand_library.h>

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

Public Member Functions

virtual JointsMap getAllJointsData ()
 
virtual void getConfig (std::string joint_name)
 
virtual JointControllerData getContrl (std::string ctrlr_name)
 
virtual std::vector< DiagnosticDatagetDiagnostics ()
 
virtual JointData getJointData (std::string joint_name)
 
virtual int16_t sendupdate (std::string joint_name, double target)
 
virtual int16_t setConfig (std::vector< std::string > myConfig)
 
virtual int16_t setContrl (std::string contrlr_name, JointControllerData ctrlr_data)
 
 VirtualShadowhandLibrary ()
 
virtual ~VirtualShadowhandLibrary ()
 
- Public Member Functions inherited from shadowrobot::SRArticulatedRobot
 SRArticulatedRobot ()
 
virtual ~SRArticulatedRobot ()
 

Additional Inherited Members

- Public Types inherited from shadowrobot::SRArticulatedRobot
typedef std::map< std::string, JointDataJointsMap
 
typedef std::map< std::string, enum controller_parametersParametersMap
 
- Public Attributes inherited from shadowrobot::SRArticulatedRobot
boost::mutex controllers_map_mutex
 
JointsMap joints_map
 A mapping between the joint names and the information regarding those joints. More...
 
boost::mutex joints_map_mutex
 
ParametersMap parameters_map
 A mapping between the parameter names and their values. More...
 
boost::mutex parameters_map_mutex
 
- Protected Attributes inherited from shadowrobot::SRArticulatedRobot
boost::shared_ptr< self_test::TestRunnerself_test
 this is the handle for the self tests. More...
 

Detailed Description

Definition at line 36 of file virtual_shadowhand_library.h.

Constructor & Destructor Documentation

shadowrobot::VirtualShadowhandLibrary::VirtualShadowhandLibrary ( )

Definition at line 36 of file virtual_shadowhand_library.cpp.

virtual shadowrobot::VirtualShadowhandLibrary::~VirtualShadowhandLibrary ( )
inlinevirtual

Definition at line 42 of file virtual_shadowhand_library.h.

Member Function Documentation

std::map< std::string, JointData > shadowrobot::VirtualShadowhandLibrary::getAllJointsData ( )
virtual

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 125 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 149 of file virtual_shadowhand_library.cpp.

JointControllerData shadowrobot::VirtualShadowhandLibrary::getContrl ( std::string  contrlr_name)
virtual

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 138 of file virtual_shadowhand_library.cpp.

std::vector< DiagnosticData > shadowrobot::VirtualShadowhandLibrary::getDiagnostics ( )
virtual

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 153 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 119 of file virtual_shadowhand_library.cpp.

int16_t 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 114 of file virtual_shadowhand_library.cpp.

int16_t 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 144 of file virtual_shadowhand_library.cpp.

int16_t 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 133 of file virtual_shadowhand_library.cpp.


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


sr_hand
Author(s): Ugo Cupcic
autogenerated on Tue Oct 13 2020 03:55:53