Stg::ModelActuator Class Reference

ModelActuator class More...

#include <stage.hh>

Inherits Stg::Model.

List of all members.

Public Types
enum	ActuatorType { STG_ACTUATOR_TYPE_LINEAR, STG_ACTUATOR_TYPE_ROTATIONAL }
enum	ControlMode { STG_ACTUATOR_CONTROL_VELOCITY, STG_ACTUATOR_CONTROL_POSITION }
Public Member Functions
double	GetMaxPosition () const
double	GetMinPosition () const
double	GetPosition () const
double	GetSpeed () const
void	GoTo (double pose)
virtual void	Load ()
	ModelActuator (World *world, Model *parent)
void	SetSpeed (double speed)
virtual void	Shutdown ()
virtual void	Startup ()
virtual void	Update ()
	~ModelActuator ()
Static Public Member Functions
static Model *	Create (World *world, Model *parent)

---

Detailed Description

ModelActuator class

---

Member Enumeration Documentation

enum Stg::ModelActuator::ActuatorType

Define an actuator type

Enumerator:

STG_ACTUATOR_TYPE_LINEAR
STG_ACTUATOR_TYPE_ROTATIONAL

enum Stg::ModelActuator::ControlMode

Define a actuator control method

Enumerator:

STG_ACTUATOR_CONTROL_VELOCITY
STG_ACTUATOR_CONTROL_POSITION

---

Constructor & Destructor Documentation

ModelActuator::ModelActuator	(	World *	world,
		Model *	parent
	)

ModelActuator::~ModelActuator

(

void

)

---

Member Function Documentation

static Model* Stg::ModelActuator::Create	(	World *	world,
		Model *	parent
	)			[inline, static]

Every class derived from Stg::Model must provide a "named constructor" for its class, like this.

Reimplemented from Stg::Model.

double Stg::ModelActuator::GetMaxPosition

(

)

const [inline]

double Stg::ModelActuator::GetMinPosition

(

)

const [inline]

double Stg::ModelActuator::GetPosition

(

)

const [inline]

double Stg::ModelActuator::GetSpeed

(

)

const [inline]

void ModelActuator::GoTo

(

double

pose

)

Sets the control mode to STG_ACTUATOR_CONTROL_POSITION and sets the goal pose

void ModelActuator::Load

(

void

)

[virtual]

configure a model by reading from the current world file

Reimplemented from Stg::Model.

void ModelActuator::SetSpeed

(

double

speed

)

Sets the control_mode to STG_ACTUATOR_CONTROL_VELOCITY and sets the goal velocity.

void ModelActuator::Shutdown

(

void

)

[virtual]

Reimplemented from Stg::Model.

void ModelActuator::Startup

(

void

)

[virtual]

Reimplemented from Stg::Model.

void ModelActuator::Update

(

void

)

[virtual]

Reimplemented from Stg::Model.

---

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

• stage.hh
• model_actuator.cc