YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::ImplementAmplifierControl Class Reference

#include <yarp/dev/ImplementAmplifierControl.h>

+ Inheritance diagram for yarp::dev::ImplementAmplifierControl:

Public Member Functions

 ImplementAmplifierControl (yarp::dev::IAmplifierControlRaw *y)
 
virtual ~ImplementAmplifierControl ()
 Destructor.
 
yarp::dev::ReturnValue enableAmp (int j) override
 Enable the amplifier on a specific joint.
 
yarp::dev::ReturnValue disableAmp (int j) override
 Disable the amplifier on a specific joint.
 
yarp::dev::ReturnValue getAmpStatus (int *st) override
 
yarp::dev::ReturnValue getAmpStatus (int j, int *st) override
 
yarp::dev::ReturnValue getCurrents (double *vals) override
 
yarp::dev::ReturnValue getCurrent (int j, double *val) override
 
yarp::dev::ReturnValue setMaxCurrent (int j, double v) override
 
yarp::dev::ReturnValue getMaxCurrent (int j, double *v) override
 Returns the maximum electric current allowed for a given motor.
 
yarp::dev::ReturnValue getNominalCurrent (int m, double *val) override
 
yarp::dev::ReturnValue setNominalCurrent (int m, const double val) override
 
yarp::dev::ReturnValue getPeakCurrent (int m, double *val) override
 
yarp::dev::ReturnValue setPeakCurrent (int m, const double val) override
 
yarp::dev::ReturnValue getPWM (int j, double *val) override
 
yarp::dev::ReturnValue getPWMLimit (int j, double *val) override
 
yarp::dev::ReturnValue setPWMLimit (int j, const double val) override
 
yarp::dev::ReturnValue getPowerSupplyVoltage (int j, double *val) override
 
- Public Member Functions inherited from yarp::dev::IAmplifierControl
virtual ~IAmplifierControl ()
 Destructor.
 

Protected Member Functions

bool initialize (int size, const int *amap, const double *enc, const double *zos, const double *ampereFactor=NULL, const double *voltFactor=NULL)
 Initialize the internal data and alloc memory.
 
bool uninitialize ()
 Clean up internal data and memory.
 

Protected Attributes

IAmplifierControlRaw * m_iraw =nullptr
 
void * m_helper =nullptr
 
std::vector< int > m_buffer_ints
 
std::vector< double > m_buffer_doubles
 
std::mutex m_imp_mutex
 

Detailed Description

Definition at line 16 of file ImplementAmplifierControl.h.

Constructor & Destructor Documentation

◆ ImplementAmplifierControl()

ImplementAmplifierControl::ImplementAmplifierControl ( yarp::dev::IAmplifierControlRaw *  y)

Definition at line 23 of file ImplementAmplifierControl.cpp.

◆ ~ImplementAmplifierControl()

ImplementAmplifierControl::~ImplementAmplifierControl ( )
virtual

Destructor.

Perform uninitialize if needed.

Definition at line 29 of file ImplementAmplifierControl.cpp.

Member Function Documentation

◆ disableAmp()

ReturnValue ImplementAmplifierControl::disableAmp ( int  j)
overridevirtual

Disable the amplifier on a specific joint.

All computations within the board will be carried out normally, but the output will be disabled.

Returns
true/false on success/failure

Implements yarp::dev::IAmplifierControl.

Definition at line 73 of file ImplementAmplifierControl.cpp.

◆ enableAmp()

ReturnValue ImplementAmplifierControl::enableAmp ( int  j)
overridevirtual

Enable the amplifier on a specific joint.

Be careful, check that the output of the controller is appropriate (usually zero), to avoid generating abrupt movements.

Returns
true/false on success/failure

Implements yarp::dev::IAmplifierControl.

Definition at line 63 of file ImplementAmplifierControl.cpp.

◆ getAmpStatus() [1/2]

ReturnValue ImplementAmplifierControl::getAmpStatus ( int *  st)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 106 of file ImplementAmplifierControl.cpp.

◆ getAmpStatus() [2/2]

ReturnValue ImplementAmplifierControl::getAmpStatus ( int  j,
int *  st 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 117 of file ImplementAmplifierControl.cpp.

◆ getCurrent()

ReturnValue ImplementAmplifierControl::getCurrent ( int  j,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 93 of file ImplementAmplifierControl.cpp.

◆ getCurrents()

ReturnValue ImplementAmplifierControl::getCurrents ( double *  vals)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 83 of file ImplementAmplifierControl.cpp.

◆ getMaxCurrent()

ReturnValue ImplementAmplifierControl::getMaxCurrent ( int  j,
double *  v 
)
overridevirtual

Returns the maximum electric current allowed for a given motor.

The behavior of the board/amplifier when this limit is reached depends on the implementation.

Parameters
jmotor number
vthe return value
Returns
probably true, might return false in bad times

Implements yarp::dev::IAmplifierControl.

Definition at line 140 of file ImplementAmplifierControl.cpp.

◆ getNominalCurrent()

ReturnValue ImplementAmplifierControl::getNominalCurrent ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 153 of file ImplementAmplifierControl.cpp.

◆ getPeakCurrent()

ReturnValue ImplementAmplifierControl::getPeakCurrent ( int  m,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 169 of file ImplementAmplifierControl.cpp.

◆ getPowerSupplyVoltage()

ReturnValue ImplementAmplifierControl::getPowerSupplyVoltage ( int  j,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 239 of file ImplementAmplifierControl.cpp.

◆ getPWM()

ReturnValue ImplementAmplifierControl::getPWM ( int  j,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 207 of file ImplementAmplifierControl.cpp.

◆ getPWMLimit()

ReturnValue ImplementAmplifierControl::getPWMLimit ( int  j,
double *  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 218 of file ImplementAmplifierControl.cpp.

◆ initialize()

bool ImplementAmplifierControl::initialize ( int  size,
const int *  amap,
const double *  enc,
const double *  zos,
const double *  ampereFactor = NULL,
const double *  voltFactor = NULL 
)
protected

Initialize the internal data and alloc memory.

Parameters
sizeis the number of controlled axes the driver deals with.
amapis a lookup table mapping axes onto physical drivers.
encis an array containing the encoder to angles conversion factors.
zosis an array containing the zeros of the encoders.
Returns
true if initialized succeeded, false if it wasn't executed, or assert.

Definition at line 34 of file ImplementAmplifierControl.cpp.

◆ setMaxCurrent()

ReturnValue ImplementAmplifierControl::setMaxCurrent ( int  j,
double  v 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 129 of file ImplementAmplifierControl.cpp.

◆ setNominalCurrent()

ReturnValue ImplementAmplifierControl::setNominalCurrent ( int  m,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 196 of file ImplementAmplifierControl.cpp.

◆ setPeakCurrent()

ReturnValue ImplementAmplifierControl::setPeakCurrent ( int  m,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 185 of file ImplementAmplifierControl.cpp.

◆ setPWMLimit()

ReturnValue ImplementAmplifierControl::setPWMLimit ( int  j,
const double  val 
)
overridevirtual

Implements yarp::dev::IAmplifierControl.

Definition at line 229 of file ImplementAmplifierControl.cpp.

◆ uninitialize()

bool ImplementAmplifierControl::uninitialize ( )
protected

Clean up internal data and memory.

Returns
true if uninitialization is executed, false otherwise.

Definition at line 53 of file ImplementAmplifierControl.cpp.

Member Data Documentation

◆ m_buffer_doubles

std::vector<double> yarp::dev::ImplementAmplifierControl::m_buffer_doubles
protected

Definition at line 22 of file ImplementAmplifierControl.h.

◆ m_buffer_ints

std::vector<int> yarp::dev::ImplementAmplifierControl::m_buffer_ints
protected

Definition at line 21 of file ImplementAmplifierControl.h.

◆ m_helper

void* yarp::dev::ImplementAmplifierControl::m_helper =nullptr
protected

Definition at line 20 of file ImplementAmplifierControl.h.

◆ m_imp_mutex

std::mutex yarp::dev::ImplementAmplifierControl::m_imp_mutex
protected

Definition at line 23 of file ImplementAmplifierControl.h.

◆ m_iraw

IAmplifierControlRaw* yarp::dev::ImplementAmplifierControl::m_iraw =nullptr
protected

Definition at line 19 of file ImplementAmplifierControl.h.


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