opal::MotorData Class Reference

A data structure describing a Motor. More...

#include <MotorData.h>

Inheritance diagram for opal::MotorData:

List of all members.

Public Member Functions
OPAL_DECL	MotorData ()
virtual OPAL_DECL	~MotorData ()
virtual OPAL_DECL MotorType OPAL_CALL	getType () const
Public Attributes
bool	enabled
std::string	name
Protected Attributes
MotorType	mType

---

Detailed Description

A data structure describing a Motor.

Definition at line 47 of file MotorData.h.

---

Constructor & Destructor Documentation

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

Definition at line 50 of file MotorData.h. References opal::ATTRACTOR_MOTOR, opal::defaults::motor::enabled, enabled, mType, and name.

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

Definition at line 59 of file MotorData.h.

---

Member Function Documentation

virtual OPAL_DECL MotorType OPAL_CALL opal::MotorData::getType (   )  const [inline, virtual]

Returns the Motor's type. Definition at line 64 of file MotorData.h. References mType. Referenced by opal::Blueprint::addMotor(), opal::ThrusterMotor::getType(), opal::SpringMotor::getType(), opal::ServoMotor::getType(), opal::GearedMotor::getType(), and opal::AttractorMotor::getType().

---

Member Data Documentation

bool opal::MotorData::enabled

True if the Motor is enabled. Definition at line 70 of file MotorData.h. Referenced by opal::ThrusterMotor::internal_update(), opal::SpringMotor::internal_update(), opal::ServoMotor::internal_update(), opal::GearedMotor::internal_update(), opal::AttractorMotor::internal_update(), opal::VelocityMotor::isEnabled(), opal::ThrusterMotor::isEnabled(), opal::SpringMotor::isEnabled(), opal::ServoMotor::isEnabled(), opal::GearedMotor::isEnabled(), opal::AttractorMotor::isEnabled(), MotorData(), opal::VelocityMotorData::operator=(), opal::ThrusterMotorData::operator=(), opal::SpringMotorData::operator=(), opal::ServoMotorData::operator=(), opal::GearedMotorData::operator=(), opal::AttractorMotorData::operator=(), opal::VelocityMotor::setEnabled(), opal::ThrusterMotor::setEnabled(), opal::SpringMotor::setEnabled(), opal::ServoMotor::setEnabled(), opal::GearedMotor::setEnabled(), opal::AttractorMotor::setEnabled(), and opal::ServoMotor::~ServoMotor().

MotorType opal::MotorData::mType [protected]

The Motor type. Definition at line 77 of file MotorData.h. Referenced by opal::AttractorMotorData::AttractorMotorData(), opal::GearedMotorData::GearedMotorData(), getType(), MotorData(), opal::VelocityMotorData::operator=(), opal::ThrusterMotorData::operator=(), opal::SpringMotorData::operator=(), opal::ServoMotorData::operator=(), opal::GearedMotorData::operator=(), opal::AttractorMotorData::operator=(), opal::ServoMotorData::ServoMotorData(), opal::SpringMotorData::SpringMotorData(), opal::ThrusterMotorData::ThrusterMotorData(), and opal::VelocityMotorData::VelocityMotorData().

std::string opal::MotorData::name

An identifier for the Motor. Definition at line 73 of file MotorData.h. Referenced by opal::Blueprint::addMotor(), opal::VelocityMotor::getName(), opal::ThrusterMotor::getName(), opal::SpringMotor::getName(), opal::ServoMotor::getName(), opal::GearedMotor::getName(), opal::AttractorMotor::getName(), MotorData(), opal::VelocityMotorData::operator=(), opal::ThrusterMotorData::operator=(), opal::SpringMotorData::operator=(), opal::ServoMotorData::operator=(), opal::GearedMotorData::operator=(), opal::AttractorMotorData::operator=(), opal::VelocityMotor::setName(), opal::ThrusterMotor::setName(), opal::SpringMotor::setName(), opal::ServoMotor::setName(), opal::GearedMotor::setName(), and opal::AttractorMotor::setName().

---

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

• MotorData.h

---