yarp::dev::IMotor Class Reference

Control board, encoder interface. More...

#include <yarp/dev/IMotor.h>

Inheritance diagram for yarp::dev::IMotor:

Public Member Functions
virtual	~IMotor ()
	Destructor. More...
virtual bool	getNumberOfMotors (int *num)=0
	Get the number of available motors. More...
virtual bool	getTemperature (int m, double *val)=0
	Get temperature of a motor. More...
virtual bool	getTemperatures (double *vals)=0
	Get temperature of all the motors. More...
virtual bool	getTemperatureLimit (int m, double *temp)=0
	Retreives the current temperature limit for a specific motor. More...
virtual bool	setTemperatureLimit (int m, const double temp)=0
	Set the temperature limit for a specific motor. More...
virtual bool	getGearboxRatio (int m, double *val)
	Get the gearbox ratio for a specific motor. More...
virtual bool	setGearboxRatio (int m, const double val)
	Set the gearbox ratio for a specific motor. More...

Detailed Description

Control board, encoder interface.

Definition at line 98 of file IMotor.h.

Constructor & Destructor Documentation

~IMotor()

virtual yarp::dev::IMotor::~IMotor ( )

inlinevirtual

Destructor.

Definition at line 104 of file IMotor.h.

Member Function Documentation

getGearboxRatio()

virtual bool yarp::dev::IMotor::getGearboxRatio ( int  m, double *  val  )

inlinevirtual

Get the gearbox ratio for a specific motor.

Parameters

m	motor number
val	retrieved gearbox ratio

Returns

true/false

Reimplemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

Definition at line 152 of file IMotor.h.

getNumberOfMotors()

virtual bool yarp::dev::IMotor::getNumberOfMotors ( int *  num )

pure virtual

Get the number of available motors.

Parameters

num	retrieved number of available motors

Returns

true/false

Implemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

getTemperature()

virtual bool yarp::dev::IMotor::getTemperature ( int  m, double *  val  )

pure virtual

Get temperature of a motor.

Parameters

m	motor number
val	retrieved motor temperature

Returns

true/false

Implemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

getTemperatureLimit()

virtual bool yarp::dev::IMotor::getTemperatureLimit ( int  m, double *  temp  )

pure virtual

Retreives the current temperature limit for a specific motor.

The specific behavior of the motor when the temperature limit is exceeded depends on the implementation (power off recommended)

Parameters

m	motor number
temp	the current temperature limit.

Returns

true/false

Implemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

getTemperatures()

virtual bool yarp::dev::IMotor::getTemperatures ( double *  vals )

pure virtual

Get temperature of all the motors.

Parameters

vals	pointer to an array containing all motor temperatures

Returns

true/false

Implemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

setGearboxRatio()

virtual bool yarp::dev::IMotor::setGearboxRatio ( int  m, const double  val  )

inlinevirtual

Set the gearbox ratio for a specific motor.

Parameters

m	motor number
gearbox	ratio to be set

Returns

true/false

Reimplemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

Definition at line 160 of file IMotor.h.

setTemperatureLimit()

virtual bool yarp::dev::IMotor::setTemperatureLimit ( int  m, const double  temp  )

pure virtual

Set the temperature limit for a specific motor.

The specific behavior of the motor when the temperature limit is exceeded depends on the implementation (power off recommended)

Parameters

m	motor number
temp	the temperature limit to be set

Returns

true/false

Implemented in yarp::dev::ImplementMotor, RemoteControlBoard, ControlBoardWrapperMotor, and ControlBoardRemapper.

---

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

• src/libYARP_dev/src/yarp/dev/IMotor.h