ANYdrive SDK
The SDK for interfacing ANYdrive.
anydrive::calibration Namespace Reference

Namespaces

 parameter
 
 routine
 

Classes

union  CalibrationState
 Calibration state union. More...
 
struct  CalibrationStateBits
 

Enumerations

enum  CalibrationModeEnum {
  CalibrationModeEnum::FrictionEstimation, CalibrationModeEnum::GearAndJointEncoderHoming, CalibrationModeEnum::GearJointEncoderOffset, CalibrationModeEnum::GravityCompensation,
  CalibrationModeEnum::ImuGyroscopeDcBias, CalibrationModeEnum::MotorEncoderOffset, CalibrationModeEnum::MotorEncoderParameters, CalibrationModeEnum::NA,
  CalibrationModeEnum::SafeJointVelocity, CalibrationModeEnum::SpringStiffness
}
 Calibration mode enumerators for type safe usage. More...
 
enum  CalibrationTypeEnum { CalibrationTypeEnum::Custom, CalibrationTypeEnum::Factory, CalibrationTypeEnum::NA }
 Calibration type enumerators for type safe usage. More...
 

Functions

uint16_t calibrationModeEnumToId (const CalibrationModeEnum calibrationModeEnum)
 
CalibrationModeEnum calibrationModeIdToEnum (const uint16_t calibrationModeId)
 
std::string calibrationModeEnumToName (const CalibrationModeEnum calibrationModeEnum)
 
CalibrationModeEnum calibrationModeNameToEnum (const std::string &calibrationModeName)
 
std::ostream & operator<< (std::ostream &out, const CalibrationModeEnum calibrationModeEnum)
 
uint16_t calibrationTypeEnumToId (const CalibrationTypeEnum calibrationTypeEnum)
 
CalibrationTypeEnum calibrationTypeIdToEnum (const uint16_t calibrationTypeId)
 
std::string calibrationTypeEnumToName (const CalibrationTypeEnum calibrationTypeEnum)
 
CalibrationTypeEnum calibrationTypeNameToEnum (const std::string &calibrationTypeName)
 

Enumeration Type Documentation

◆ CalibrationModeEnum

Calibration mode enumerators for type safe usage.

Enumerator
FrictionEstimation 
GearAndJointEncoderHoming 
GearJointEncoderOffset 
GravityCompensation 
ImuGyroscopeDcBias 
MotorEncoderOffset 
MotorEncoderParameters 
NA 
SafeJointVelocity 
SpringStiffness 

◆ CalibrationTypeEnum

Calibration type enumerators for type safe usage.

Enumerator
Custom 
Factory 
NA 

Function Documentation

◆ calibrationModeEnumToId()

uint16_t anydrive::calibration::calibrationModeEnumToId ( const CalibrationModeEnum  calibrationModeEnum)

Convert a calibration mode enumerator to an ID.

Parameters
calibrationModeEnumCalibration mode enumerator.
Returns
Calibration mode ID.

◆ calibrationModeEnumToName()

std::string anydrive::calibration::calibrationModeEnumToName ( const CalibrationModeEnum  calibrationModeEnum)

Convert a calibration mode enumerator to a human readable string (GUI, etc.).

Parameters
calibrationModeEnumCalibration mode enumerator.
Returns
Human readable string.

◆ calibrationModeIdToEnum()

CalibrationModeEnum anydrive::calibration::calibrationModeIdToEnum ( const uint16_t  calibrationModeId)

Convert a calibration mode ID to an enumerator.

Parameters
calibrationModeIdCalibration mode ID.
Returns
Calibration mode enumerator.

◆ calibrationModeNameToEnum()

CalibrationModeEnum anydrive::calibration::calibrationModeNameToEnum ( const std::string &  calibrationModeName)

Convert a human readable string (GUI, etc.) to a calibration mode enumerator.

Parameters
calibrationModeNameHuman readable string.
Returns
Calibration mode enumerator.

◆ calibrationTypeEnumToId()

uint16_t anydrive::calibration::calibrationTypeEnumToId ( const CalibrationTypeEnum  calibrationTypeEnum)

Convert a calibration type enumerator to an ID.

Parameters
calibrationTypeEnumCalibration type enumerator.
Returns
Calibration type ID.

◆ calibrationTypeEnumToName()

std::string anydrive::calibration::calibrationTypeEnumToName ( const CalibrationTypeEnum  calibrationTypeEnum)

Convert a calibration type enumerator to a human readable string (GUI, etc.).

Parameters
calibrationTypeEnumCalibration type enumerator.
Returns
Human readable string.

◆ calibrationTypeIdToEnum()

CalibrationTypeEnum anydrive::calibration::calibrationTypeIdToEnum ( const uint16_t  calibrationTypeId)

Convert a calibration type ID to an enumerator.

Parameters
calibrationTypeIdCalibration type ID.
Returns
Calibration type enumerator.

◆ calibrationTypeNameToEnum()

CalibrationTypeEnum anydrive::calibration::calibrationTypeNameToEnum ( const std::string &  calibrationTypeName)

Convert a human readable string (GUI, etc.) to a calibration type enumerator.

Parameters
calibrationTypeNameHuman readable string.
Returns
Calibration type enumerator.

◆ operator<<()

std::ostream & anydrive::calibration::operator<< ( std::ostream &  out,
const CalibrationModeEnum  calibrationModeEnum 
)