Stg::ModelActuator Class Reference

ModelActuator class More...

#include <stage.hh>

Inheritance diagram for Stg::ModelActuator:

List of all members.

Public Types

enum  ActuatorType { TYPE_LINEAR, TYPE_ROTATIONAL }
enum  ControlMode { CONTROL_VELOCITY, CONTROL_POSITION }

Public Member Functions

point3_t GetAxis () const
double GetMaxPosition () const
double GetMinPosition () const
double GetPosition () const
double GetSpeed () const
ActuatorType GetType () const
void GoTo (double pose)
virtual void Load ()
 ModelActuator (World *world, Model *parent, const std::string &type)
void SetSpeed (double speed)
virtual void Shutdown ()
virtual void Startup ()
virtual void Update ()
 ~ModelActuator ()

Detailed Description

ModelActuator class


Member Enumeration Documentation

Define an actuator type

Enumerator:
TYPE_LINEAR 
TYPE_ROTATIONAL 

Define a actuator control method

Enumerator:
CONTROL_VELOCITY 
CONTROL_POSITION 

Constructor & Destructor Documentation

ModelActuator::ModelActuator ( World world,
Model parent,
const std::string &  type 
)
ModelActuator::~ModelActuator ( void  )

Member Function Documentation

point3_t Stg::ModelActuator::GetAxis ( ) const [inline]
double Stg::ModelActuator::GetMaxPosition ( ) const [inline]
double Stg::ModelActuator::GetMinPosition ( ) const [inline]
double Stg::ModelActuator::GetPosition ( ) const [inline]
double Stg::ModelActuator::GetSpeed ( ) const [inline]
ActuatorType Stg::ModelActuator::GetType ( ) const [inline]
void ModelActuator::GoTo ( double  pose)

Sets the control mode to 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 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: