Interface for control boards implementing current control. More...
#include <yarp/dev/ICurrentControl.h>
Inheritance diagram for yarp::dev::ICurrentControl:Public Member Functions | |
| virtual | ~ICurrentControl () |
| Destructor. | |
| virtual yarp::dev::ReturnValue | getNumberOfMotors (int *ax)=0 |
| Retrieves the number of controlled axes from the current physical interface. | |
| virtual yarp::dev::ReturnValue | getCurrent (int m, double *curr)=0 |
| Get the instantaneous current measurement for a single motor. | |
| virtual yarp::dev::ReturnValue | getCurrents (double *currs)=0 |
| Get the instantaneous current measurement for all motors. | |
| virtual yarp::dev::ReturnValue | getCurrentRange (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 | getCurrentRanges (double *min, double *max)=0 |
| Get the full scale of the current measurements for all motors motor (e.g. | |
| virtual yarp::dev::ReturnValue | setRefCurrents (const double *currs)=0 |
| Set the reference value of the currents for all motors. | |
| virtual yarp::dev::ReturnValue | setRefCurrent (int m, double curr)=0 |
| Set the reference value of the current for a single motor. | |
| virtual yarp::dev::ReturnValue | setRefCurrents (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 | getRefCurrents (double *currs)=0 |
| Get the reference value of the currents for all motors. | |
| virtual yarp::dev::ReturnValue | getRefCurrent (int m, double *curr)=0 |
| Get the reference value of the current for a single motor. | |
Interface for control boards implementing current control.
Definition at line 23 of file ICurrentControl.h.
|
inlinevirtual |
Destructor.
Definition at line 29 of file ICurrentControl.h.
|
pure virtual |
Get the instantaneous current measurement for a single motor.
| m | motor number |
| curr | pointer to the result value. Value is expressed in amperes. |
Implemented in yarp::dev::ImplementCurrentControl, ControlBoard_nwc_yarp, yarp::dev::xHandControlBoard, and ControlBoardRemappingEngine.
|
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.
| m | motor number |
| min | minimum current of the motor m |
| max | maximum current of the motor m |
Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementCurrentControl, yarp::dev::xHandControlBoard, and ControlBoardRemappingEngine.
|
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.
| min | pointer to the array that will store minimum currents |
| max | pointer to the array that will store maximum currents |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, ControlBoard_nwc_yarp, and yarp::dev::ImplementCurrentControl.
|
pure virtual |
Get the instantaneous current measurement for all motors.
| currs | pointer to the array that will store the output. Values are expressed in amperes. |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, yarp::dev::ImplementCurrentControl, and ControlBoard_nwc_yarp.
|
pure virtual |
Retrieves the number of controlled axes from the current physical interface.
| ax | returns the number of controlled axes. |
Implemented in yarp::dev::ImplementCurrentControl, yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, and ControlBoard_nwc_yarp.
|
pure virtual |
Get the reference value of the current for a single motor.
| m | motor number |
| curr | the current reference value for motor m. Value is expressed in amperes. |
Implemented in yarp::dev::ImplementCurrentControl, ControlBoard_nwc_yarp, yarp::dev::xHandControlBoard, and ControlBoardRemappingEngine.
|
pure virtual |
Get the reference value of the currents for all motors.
| currs | pointer to the array to be filled with reference current values. Values are expressed in amperes. |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, ControlBoard_nwc_yarp, and yarp::dev::ImplementCurrentControl.
|
pure virtual |
Set the reference value of the current for a single motor.
| m | motor number |
| curr | the current reference value for motor m. Value is expressed in amperes. |
Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementCurrentControl, yarp::dev::xHandControlBoard, and ControlBoardRemappingEngine.
|
pure virtual |
Set the reference value of the currents for all motors.
| currs | the array containing the reference current values. Values are expressed in amperes. |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, ControlBoard_nwc_yarp, and yarp::dev::ImplementCurrentControl.
|
pure virtual |
Set the reference value of the current for a group of motors.
| n_motor | size of motors ans currs arrays |
| motors | pointer to the array containing the list of motor numbers |
| currs | pointer to the array specifying the new current references |
Implemented in ControlBoard_nwc_yarp, yarp::dev::ImplementCurrentControl, yarp::dev::xHandControlBoard, and ControlBoardRemappingEngine.