mc_rbdyn::JointSensor Struct Reference

#include <mc_rbdyn/JointSensor.h>

Public Member Functions
	JointSensor ()
	JointSensor (const std::string &jointName)
	JointSensor (const JointSensor &)=default
JointSensor &	operator= (const JointSensor &)=default
	JointSensor (JointSensor &&)=default
JointSensor &	operator= (JointSensor &&)=default
	~JointSensor () noexcept=default
const std::string &	joint () const noexcept
double	motorTemperature () const noexcept
void	motorTemperature (double motor_temperature) noexcept
double	driverTemperature () const noexcept
void	driverTemperature (double driver_temperature) noexcept
double	motorCurrent () const noexcept
void	motorCurrent (double motor_current) noexcept
bool	motorStatus () const noexcept
void	motorStatus (bool motor_status) noexcept

Protected Attributes
std::string	joint_

Detailed Description

This structure defines a joint sensor that provides temperature and current information for a specfic joint.

Constructor & Destructor Documentation

JointSensor() [1/4]

mc_rbdyn::JointSensor::JointSensor ( )

inline

Default constructor, does not represent a valid joint sensor

JointSensor() [2/4]

mc_rbdyn::JointSensor::JointSensor ( const std::string &  jointName )

inline

Constructor

Parameters

jointName

Name of the joint to which the sensor is attached

JointSensor() [3/4]

mc_rbdyn::JointSensor::JointSensor ( const JointSensor &  )

default

JointSensor() [4/4]

mc_rbdyn::JointSensor::JointSensor ( JointSensor &&  )

default

~JointSensor()

mc_rbdyn::JointSensor::~JointSensor ( )

defaultnoexcept

Member Function Documentation

driverTemperature() [1/2]

double mc_rbdyn::JointSensor::driverTemperature ( ) const

inlinenoexcept

Return the sensor's driver temperature reading (Celcius), NaN if not provided

driverTemperature() [2/2]

void mc_rbdyn::JointSensor::driverTemperature ( double  driver_temperature )

inlinenoexcept

Set the sensor's driver temperature reading (Celcius)

joint()

const std::string& mc_rbdyn::JointSensor::joint ( ) const

inlinenoexcept

Returns the sensor's joint name

motorCurrent() [1/2]

double mc_rbdyn::JointSensor::motorCurrent ( ) const

inlinenoexcept

Return the sensor's current reading (Ampere), NaN if not provided

motorCurrent() [2/2]

void mc_rbdyn::JointSensor::motorCurrent ( double  motor_current )

inlinenoexcept

Set the sensor's current reading (Ampere)

motorStatus() [1/2]

bool mc_rbdyn::JointSensor::motorStatus ( ) const

inlinenoexcept

Return the sensor's motor ON/OFF reading, ON (true) if not provided

motorStatus() [2/2]

void mc_rbdyn::JointSensor::motorStatus ( bool  motor_status )

inlinenoexcept

Set the sensor's motor ON/OFF reading

motorTemperature() [1/2]

double mc_rbdyn::JointSensor::motorTemperature ( ) const

inlinenoexcept

Return the sensor's motor temperature reading (Celcius), NaN if not provided

motorTemperature() [2/2]

void mc_rbdyn::JointSensor::motorTemperature ( double  motor_temperature )

inlinenoexcept

Set the sensor's motor temperature reading (Celcius)

operator=() [1/2]

JointSensor& mc_rbdyn::JointSensor::operator= ( const JointSensor &  )

default

operator=() [2/2]

JointSensor& mc_rbdyn::JointSensor::operator= ( JointSensor &&  )

default

Member Data Documentation

joint_

std::string mc_rbdyn::JointSensor::joint_

protected

Name of joint to which sensor is attached

---

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

• include/mc_rbdyn/JointSensor.h