YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::ICurrentControlRaw Class Referenceabstract

Interface for control boards implementing current control. More...

#include <yarp/dev/ICurrentControl.h>

+ Inheritance diagram for yarp::dev::ICurrentControlRaw:

Public Member Functions

virtual ~ICurrentControlRaw ()
 Destructor.
 
virtual yarp::dev::ReturnValue getNumberOfMotorsRaw (int *number)=0
 Retrieves the number of controlled motors from the current physical interface.
 
virtual yarp::dev::ReturnValue getCurrentRaw (int m, double *curr)=0
 Get the instantaneous current measurement for a single motor.
 
virtual yarp::dev::ReturnValue getCurrentsRaw (double *currs)=0
 Get the instantaneous current measurement for all motors.
 
virtual yarp::dev::ReturnValue getCurrentRangeRaw (int m, double *min, double *max)=0
 Get the full scale of the current measurement for a given motor (e.g.
 
virtual yarp::dev::ReturnValue getCurrentRangesRaw (double *min, double *max)=0
 Get the full scale of the current measurements for all motors motor (e.g.
 
virtual yarp::dev::ReturnValue setRefCurrentsRaw (const double *currs)=0
 Set the reference value of the currents for all motors.
 
virtual yarp::dev::ReturnValue setRefCurrentRaw (int m, double curr)=0
 Set the reference value of the current for a single motor.
 
virtual yarp::dev::ReturnValue setRefCurrentsRaw (const int n_motor, const int *motors, const double *currs)=0
 Set the reference value of the current for a group of motors.
 
virtual yarp::dev::ReturnValue getRefCurrentsRaw (double *currs)=0
 Get the reference value of the currents for all motors.
 
virtual yarp::dev::ReturnValue getRefCurrentRaw (int m, double *curr)=0
 Get the reference value of the current for a single motor.
 

Detailed Description

Interface for control boards implementing current control.

Definition at line 110 of file ICurrentControl.h.

Constructor & Destructor Documentation

◆ ~ICurrentControlRaw()

virtual yarp::dev::ICurrentControlRaw::~ICurrentControlRaw ( )
inlinevirtual

Destructor.

Definition at line 116 of file ICurrentControl.h.

Member Function Documentation

◆ getCurrentRangeRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getCurrentRangeRaw ( int  m,
double *  min,
double *  max 
)
pure virtual

Get the full scale of the current measurement for a given motor (e.g.

-20A +20A) Reference values set by user with methods such as setRefCurrent() should be in this range. This method is not related to the current overload protection methods belonging to the iAmplifierControl interface.

Parameters
mmotor number
minminimum current of the motor m
maxmaximum current of the motor m
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getCurrentRangesRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getCurrentRangesRaw ( double *  min,
double *  max 
)
pure virtual

Get the full scale of the current measurements for all motors motor (e.g.

-20A +20A) Reference values set by user with methods such as setRefCurrent() should be in this range. This method is not related to the current overload protection methods belonging to the iAmplifierControl interface.

Parameters
minpointer to the array that will store minimum currents
maxpointer to the array that will store maximum currents
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getCurrentRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getCurrentRaw ( int  m,
double *  curr 
)
pure virtual

Get the instantaneous current measurement for a single motor.

Parameters
mmotor number
currpointer to the result value
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getCurrentsRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getCurrentsRaw ( double *  currs)
pure virtual

Get the instantaneous current measurement for all motors.

Parameters
currspointer to the array that will store the output
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getNumberOfMotorsRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getNumberOfMotorsRaw ( int *  number)
pure virtual

Retrieves the number of controlled motors from the current physical interface.

Parameters
numberreturns the number of controlled motors.
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getRefCurrentRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getRefCurrentRaw ( int  m,
double *  curr 
)
pure virtual

Get the reference value of the current for a single motor.

Parameters
mmotor number
currthe current reference value for motor m
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ getRefCurrentsRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::getRefCurrentsRaw ( double *  currs)
pure virtual

Get the reference value of the currents for all motors.

Parameters
currspointer to the array to be filled with reference current values.
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ setRefCurrentRaw()

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::setRefCurrentRaw ( int  m,
double  curr 
)
pure virtual

Set the reference value of the current for a single motor.

Parameters
mmotor number
currthe current reference value for motor m
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ setRefCurrentsRaw() [1/2]

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::setRefCurrentsRaw ( const double *  currs)
pure virtual

Set the reference value of the currents for all motors.

Parameters
currsthe array containt the reference current values
Returns
true/false on success/failure

Implemented in FakeMotionControl.

◆ setRefCurrentsRaw() [2/2]

virtual yarp::dev::ReturnValue yarp::dev::ICurrentControlRaw::setRefCurrentsRaw ( const int  n_motor,
const int *  motors,
const double *  currs 
)
pure virtual

Set the reference value of the current for a group of motors.

Parameters
n_motorsize of motors ans currs arrays
motorspointer to the array of motor numbers
refspointer to the array specifying the new current reference
Returns
true/false on success/failure

Implemented in FakeMotionControl.


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