youbot::CalibrateJoint Class Reference

calibrates the joint More...

#include <YouBotJointParameter.hpp>

Inheritance diagram for youbot::CalibrateJoint:

Public Member Functions
	CalibrateJoint ()
void	getParameter (bool &doCalibration, CalibrationDirection &calibrationDirection, quantity< si::current > &maxCurrent) const
void	setParameter (const bool doCalibration, CalibrationDirection calibrationDirection, const quantity< si::current > &maxCurrent)
void	toString (std::string &value)
virtual	~CalibrateJoint ()
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
CalibrationDirection	calibrationDirection
bool	doCalibration
quantity< si::current >	maxCurrent
std::string	name
ParameterType	parameterType

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

calibrates the joint

Definition at line 190 of file YouBotJointParameter.hpp.

Constructor & Destructor Documentation

youbot::CalibrateJoint::CalibrateJoint

(

)

Definition at line 153 of file YouBotJointParameter.cpp.

youbot::CalibrateJoint::~CalibrateJoint ( )

virtual

Definition at line 160 of file YouBotJointParameter.cpp.

Member Function Documentation

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

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 209 of file YouBotJointParameter.hpp.

void youbot::CalibrateJoint::getParameter	(	bool &	doCalibration,
		CalibrationDirection &	calibrationDirection,
		quantity< si::current > &	maxCurrent
	)		const

Definition at line 165 of file YouBotJointParameter.cpp.

ParameterType youbot::CalibrateJoint::getType ( ) const

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 211 of file YouBotJointParameter.hpp.

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

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 205 of file YouBotJointParameter.hpp.

void youbot::CalibrateJoint::setParameter	(	const bool	doCalibration,
		CalibrationDirection	calibrationDirection,
		const quantity< si::current > &	maxCurrent
	)

Definition at line 173 of file YouBotJointParameter.cpp.

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

inlineprivatevirtual

Implements youbot::YouBotApiJointParameter.

Definition at line 207 of file YouBotJointParameter.hpp.

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

virtual

Implements youbot::YouBotApiJointParameter.

Definition at line 181 of file YouBotJointParameter.cpp.

Friends And Related Function Documentation

friend class YouBotJoint

friend

Definition at line 191 of file YouBotJointParameter.hpp.

Member Data Documentation

CalibrationDirection youbot::CalibrateJoint::calibrationDirection

private

Definition at line 219 of file YouBotJointParameter.hpp.

bool youbot::CalibrateJoint::doCalibration

private

Definition at line 211 of file YouBotJointParameter.hpp.

quantity<si::current> youbot::CalibrateJoint::maxCurrent

private

Definition at line 221 of file YouBotJointParameter.hpp.

std::string youbot::CalibrateJoint::name

private

Definition at line 215 of file YouBotJointParameter.hpp.

ParameterType youbot::CalibrateJoint::parameterType

private

Definition at line 217 of file YouBotJointParameter.hpp.

---

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

• YouBotJointParameter.hpp
• YouBotJointParameter.cpp