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

#include <yarp/dev/ImplementControlCalibration.h>

+ Inheritance diagram for yarp::dev::ImplementControlCalibration:

Public Member Functions

 ImplementControlCalibration (yarp::dev::IControlCalibrationRaw *y)
 
virtual ~ImplementControlCalibration ()
 Destructor.
 
ReturnValue calibrateAxisWithParams (int axis, unsigned int type, double p1, double p2, double p3) override
 Start calibration, this method is very often platform specific.
 
ReturnValue setCalibrationParameters (int axis, const CalibrationParameters &params) override
 Start calibration, this method is very often platform specific.
 
ReturnValue calibrationDone (int j) override
 Check if the calibration is terminated, on a particular joint.
 
- Public Member Functions inherited from yarp::dev::IControlCalibration
 IControlCalibration ()
 
virtual ~IControlCalibration ()
 Destructor.
 
virtual yarp::dev::ReturnValue setCalibrator (ICalibrator *c)
 Set the calibrator object to be used to calibrate the robot.
 
virtual yarp::dev::ReturnValue calibrateRobot ()
 Calibrate robot by using an external calibrator.
 
virtual yarp::dev::ReturnValue park (bool wait=true)
 
virtual yarp::dev::ReturnValue abortCalibration ()
 
virtual yarp::dev::ReturnValue abortPark ()
 

Protected Member Functions

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

Protected Attributes

IControlCalibrationRaw * 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 18 of file ImplementControlCalibration.h.

Constructor & Destructor Documentation

◆ ImplementControlCalibration()

ImplementControlCalibration::ImplementControlCalibration ( yarp::dev::IControlCalibrationRaw *  y)

Definition at line 85 of file ImplementControlCalibration.cpp.

◆ ~ImplementControlCalibration()

ImplementControlCalibration::~ImplementControlCalibration ( )
virtual

Destructor.

Perform uninitialize if needed.

Definition at line 91 of file ImplementControlCalibration.cpp.

Member Function Documentation

◆ calibrateAxisWithParams()

ReturnValue ImplementControlCalibration::calibrateAxisWithParams ( int  axis,
unsigned int  type,
double  p1,
double  p2,
double  p3 
)
overridevirtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Implements yarp::dev::IControlCalibration.

Definition at line 136 of file ImplementControlCalibration.cpp.

◆ calibrationDone()

ReturnValue ImplementControlCalibration::calibrationDone ( int  j)
overridevirtual

Check if the calibration is terminated, on a particular joint.

Non blocking.

Returns
true/false

Implements yarp::dev::IControlCalibration.

Definition at line 126 of file ImplementControlCalibration.cpp.

◆ initialize()

bool ImplementControlCalibration::initialize ( int  size,
const int *  amap,
const double *  enc,
const double *  zos 
)
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 96 of file ImplementControlCalibration.cpp.

◆ setCalibrationParameters()

ReturnValue ImplementControlCalibration::setCalibrationParameters ( int  axis,
const CalibrationParameters &  params 
)
overridevirtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Implements yarp::dev::IControlCalibration.

Definition at line 146 of file ImplementControlCalibration.cpp.

◆ uninitialize()

bool ImplementControlCalibration::uninitialize ( )
protected

Clean up internal data and memory.

Returns
true if uninitialization is executed, false otherwise.

Definition at line 115 of file ImplementControlCalibration.cpp.

Member Data Documentation

◆ m_buffer_doubles

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

Definition at line 24 of file ImplementControlCalibration.h.

◆ m_buffer_ints

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

Definition at line 23 of file ImplementControlCalibration.h.

◆ m_helper

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

Definition at line 22 of file ImplementControlCalibration.h.

◆ m_imp_mutex

std::mutex yarp::dev::ImplementControlCalibration::m_imp_mutex
protected

Definition at line 25 of file ImplementControlCalibration.h.

◆ m_iraw

IControlCalibrationRaw* yarp::dev::ImplementControlCalibration::m_iraw =nullptr
protected

Definition at line 21 of file ImplementControlCalibration.h.


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