physics::ODEMotor Class Reference

Inheritance diagram for physics::ODEMotor:

[legend]Collaboration diagram for physics::ODEMotor:

[legend]List of all members.

Public Member Functions
	ODEMotor ()
virtual	~ODEMotor ()
virtual String	className () const
virtual Object &	clone () const
virtual void	setTargetVel (Real vel)
	target linear or angular velocity
virtual void	setMaxForce (Real force)
	limit on applied force or torque
virtual ref< Joint >	getJoint ()
	Joint which Motor drives.
virtual ref< const Joint >	getJoint () const
virtual void	setParameter (const String &name, Real value)
virtual bool	isSameKindAs (const ReferencedObject &) const
virtual bool	isSameKindAs (const Object &) const
void	reference () const
bool	unreference () const
const int	referenceCount () const
void	enableOnUnreferenceCall (bool enabled)
virtual void	onUnreference () const
Protected Member Functions
void	setJoint (ref< Joint > joint, Int dof)
	called by ODEJoint::attachMotor()
void	checkAttached () const
Protected Attributes
ref< ODEJoint >	joint
	joint to which motor is attached (or 0)
Int	dof
	which of the Joint's DOF this motor controls
int	_refCount
bool	onUnreferenceEnabled
Friends
class	ODEJoint

---

Constructor & Destructor Documentation

physics::ODEMotor::ODEMotor (   )

Referenced by clone().

virtual physics::ODEMotor::~ODEMotor (   )  [virtual]

---

Member Function Documentation

void physics::ODEMotor::checkAttached (   )  const [inline, protected]

Definition at line 54 of file ODEMotor. References Assertm, and joint.

virtual String physics::ODEMotor::className (   )  const [inline, virtual]

return the name of the object's class type. Must be defined by derived classes. Implements base::Object. Definition at line 42 of file ODEMotor. Referenced by clone().

virtual Object& physics::ODEMotor::clone (   )  const [inline, virtual]

Definition at line 43 of file ODEMotor. References className(), NewNamedObj, and ODEMotor().

void base::Referenced::enableOnUnreferenceCall (  bool  enabled  )  [inline, inherited]

If enabled, each call to unreference() will also call virtual method onUnreference() Definition at line 115 of file Referenced. References base::Referenced::onUnreferenceEnabled.

virtual ref<const Joint> physics::ODEMotor::getJoint (   )  const [virtual]

virtual ref<Joint> physics::ODEMotor::getJoint (   )  [virtual]

Joint which Motor drives. Implements physics::Motor.

virtual bool base::Object::isSameKindAs (  const Object &   )  const [inline, virtual, inherited]

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs (  const ReferencedObject &   )  const [inline, virtual, inherited]

Definition at line 52 of file ReferencedObject.

virtual void base::Referenced::onUnreference (   )  const [inline, virtual, inherited]

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor. Definition at line 121 of file Referenced. Referenced by base::Referenced::unreference().

void base::Referenced::reference (   )  const [inline, inherited]

Increment the reference count by one, indicating that this object has another pointer which is referencing it. Definition at line 65 of file Referenced. References base::Referenced::_refCount.

const int base::Referenced::referenceCount (   )  const [inline, inherited]

Return the number pointers currently referencing this object. Definition at line 112 of file Referenced. References base::Referenced::_refCount. Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

void physics::ODEMotor::setJoint (  ref< Joint >  joint, Int  dof )  [protected]

called by ODEJoint::attachMotor()

virtual void physics::ODEMotor::setMaxForce (  Real  force  )  [virtual]

limit on applied force or torque Implements physics::Motor.

virtual void physics::ODEMotor::setParameter (  const String &  name, Real  value )  [virtual]

Reimplemented from physics::Motor.

virtual void physics::ODEMotor::setTargetVel (  Real  vel  )  [virtual]

target linear or angular velocity Implements physics::Motor.

bool base::Referenced::unreference (   )  const [inline, inherited]

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted. Definition at line 81 of file Referenced. References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.

---

Friends And Related Function Documentation

friend class ODEJoint [friend]

Definition at line 60 of file ODEMotor.

---

Member Data Documentation

int base::Referenced::_refCount [mutable, protected, inherited]

Definition at line 136 of file Referenced. Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

Int physics::ODEMotor::dof [protected]

which of the Joint's DOF this motor controls Definition at line 58 of file ODEMotor.

ref<ODEJoint> physics::ODEMotor::joint [protected]

joint to which motor is attached (or 0) Definition at line 57 of file ODEMotor. Referenced by checkAttached().

bool base::Referenced::onUnreferenceEnabled [protected, inherited]

Definition at line 137 of file Referenced. Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().

---

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

• physics/ODEMotor

---