opal::GearedMotorData Class Reference

A data structure describing a GearedMotor. More...

#include <GearedMotorData.h>

Inheritance diagram for opal::GearedMotorData:

List of all members.

Public Member Functions
OPAL_DECL	GearedMotorData ()
OPAL_DECL	GearedMotorData (const GearedMotorData &data)
virtual OPAL_DECL	~GearedMotorData ()
virtual OPAL_DECL void OPAL_CALL	operator= (const GearedMotorData &data)
Public Attributes
Joint *	joint
int	internal_jointIndex
std::string	jointBlueprintRefName
int	jointAxisNum
real	maxTorque
real	maxVelocity
real	throttle

---

Detailed Description

A data structure describing a GearedMotor.

Definition at line 37 of file GearedMotorData.h.

---

Constructor & Destructor Documentation

OPAL_DECL opal::GearedMotorData::GearedMotorData (   )  [inline]

Definition at line 40 of file GearedMotorData.h. References opal::GEARED_MOTOR, internal_jointIndex, joint, jointAxisNum, jointBlueprintRefName, opal::defaults::motor::geared::maxTorque, maxTorque, opal::defaults::motor::geared::maxVelocity, maxVelocity, opal::MotorData::mType, and throttle.

OPAL_DECL opal::GearedMotorData::GearedMotorData (  const GearedMotorData &  data  )  [inline]

Copy constructor. Definition at line 54 of file GearedMotorData.h.

virtual OPAL_DECL opal::GearedMotorData::~GearedMotorData (   )  [inline, virtual]

Definition at line 59 of file GearedMotorData.h.

---

Member Function Documentation

virtual OPAL_DECL void OPAL_CALL opal::GearedMotorData::operator= (  const GearedMotorData &  data  )  [inline, virtual]

Makes a deep copy. Definition at line 64 of file GearedMotorData.h. References opal::MotorData::enabled, internal_jointIndex, joint, jointAxisNum, jointBlueprintRefName, maxTorque, maxVelocity, opal::MotorData::mType, opal::MotorData::name, and throttle.

---

Member Data Documentation

int opal::GearedMotorData::internal_jointIndex

Internal data used for Blueprint instantiation. Definition at line 83 of file GearedMotorData.h. Referenced by GearedMotorData(), and operator=().

Joint* opal::GearedMotorData::joint

Pointer to the Joint affected by this Motor. Definition at line 80 of file GearedMotorData.h. Referenced by GearedMotorData(), opal::GearedMotor::init(), opal::GearedMotor::internal_dependsOnJoint(), opal::GearedMotor::internal_update(), and operator=().

int opal::GearedMotorData::jointAxisNum

The index of the specific Joint axis affected by this Motor. Definition at line 89 of file GearedMotorData.h. Referenced by GearedMotorData(), opal::GearedMotor::init(), opal::GearedMotor::internal_update(), and operator=().

std::string opal::GearedMotorData::jointBlueprintRefName

String used for for intra-Blueprint references. Definition at line 86 of file GearedMotorData.h. Referenced by GearedMotorData(), and operator=().

real opal::GearedMotorData::maxTorque

The maximum amount of torque that can be applied to the Joint axis. Definition at line 93 of file GearedMotorData.h. Referenced by GearedMotorData(), opal::GearedMotor::getMaxTorque(), opal::GearedMotor::internal_update(), operator=(), and opal::GearedMotor::setMaxTorque().

real opal::GearedMotorData::maxVelocity

The maximum angular velocity that can be achieved by the Motor. Definition at line 96 of file GearedMotorData.h. Referenced by GearedMotorData(), opal::GearedMotor::getMaxVelocity(), opal::GearedMotor::internal_update(), operator=(), and opal::GearedMotor::setMaxVelocity().

real opal::GearedMotorData::throttle

The throttle (i.e. the "gas") affects how much of the available torque is applied to the Joint axis. Definition at line 100 of file GearedMotorData.h. Referenced by GearedMotorData(), opal::GearedMotor::getThrottle(), opal::GearedMotor::internal_update(), operator=(), and opal::GearedMotor::setThrottle().

---

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

• GearedMotorData.h

---