youbot::GearRatio Class Reference

the gear ratio which is needed for the calculations in the youBot driver More...

#include <YouBotJointParameter.hpp>

Inheritance diagram for youbot::GearRatio:

Public Member Functions
	GearRatio ()
void	getParameter (double &parameter) const
void	setParameter (const double parameter)
void	toString (std::string &value)
virtual	~GearRatio ()
Public Member Functions inherited from youbot::YouBotApiJointParameter
virtual	~YouBotApiJointParameter ()

Private Member Functions
std::string	getName () const
ParameterType	getType () const
void	getYouBotMailboxMsg (YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
void	setYouBotMailboxMsg (const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)

Private Attributes
std::string	name
ParameterType	parameterType
double	value

Friends
class	YouBotJoint

Additional Inherited Members
Protected Member Functions inherited from youbot::YouBotApiJointParameter
	YouBotApiJointParameter ()
Protected Attributes inherited from youbot::YouBotApiJointParameter
std::string	name
ParameterType	parameterType

Detailed Description

the gear ratio which is needed for the calculations in the youBot driver

Definition at line 262 of file YouBotJointParameter.hpp.

Constructor & Destructor Documentation

youbot::GearRatio::GearRatio

(

)

Definition at line 237 of file YouBotJointParameter.cpp.

youbot::GearRatio::~GearRatio ( )

virtual

Definition at line 244 of file YouBotJointParameter.cpp.

Member Function Documentation

std::string youbot::GearRatio::getName ( ) const

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 281 of file YouBotJointParameter.hpp.

void youbot::GearRatio::getParameter

(

double &

parameter

)

const

Definition at line 249 of file YouBotJointParameter.cpp.

ParameterType youbot::GearRatio::getType ( ) const

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 283 of file YouBotJointParameter.hpp.

void youbot::GearRatio::getYouBotMailboxMsg ( YouBotSlaveMailboxMsg &  message, TMCLCommandNumber  msgType, const YouBotJointStorage &  storage  ) const

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 277 of file YouBotJointParameter.hpp.

void youbot::GearRatio::setParameter

(

const double

parameter

)

Definition at line 255 of file YouBotJointParameter.cpp.

void youbot::GearRatio::setYouBotMailboxMsg ( const YouBotSlaveMailboxMsg &  message, const YouBotJointStorage &  storage  )

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 279 of file YouBotJointParameter.hpp.

void youbot::GearRatio::toString ( std::string &  value )

virtual

Implements youbot::YouBotApiJointParameter.

Definition at line 264 of file YouBotJointParameter.cpp.

Friends And Related Function Documentation

friend class YouBotJoint

friend

Definition at line 263 of file YouBotJointParameter.hpp.

Member Data Documentation

std::string youbot::GearRatio::name

private

Definition at line 287 of file YouBotJointParameter.hpp.

ParameterType youbot::GearRatio::parameterType

private

Definition at line 289 of file YouBotJointParameter.hpp.

double youbot::GearRatio::value

private

Definition at line 283 of file YouBotJointParameter.hpp.

---

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

• YouBotJointParameter.hpp
• YouBotJointParameter.cpp