gusimplewhiteboard
guWhiteboard::SensorsBodySensors Class Reference

Provides a C++ wrapper around wb_sensors_body_sensors. More...

#include <SensorsBodySensors.hpp>

Inheritance diagram for guWhiteboard::SensorsBodySensors:
Collaboration diagram for guWhiteboard::SensorsBodySensors:

Public Member Functions

 SensorsBodySensors (signed int t_DCM_Time=0, float t_InertialSensor_AccX=0.0f, float t_InertialSensor_AccY=0.0f, float t_InertialSensor_AccZ=0.0f, float t_InertialSensor_GyrX=0.0f, float t_InertialSensor_GyrY=0.0f, float t_InertialSensor_GyrZ=0.0f, float t_InertialSensor_AngleX=0.0f, float t_InertialSensor_AngleY=0.0f, float t_InertialSensor_AngleZ=0.0f, float t_InertialSensor_AccelerometerX=0.0f, float t_InertialSensor_AccelerometerY=0.0f, float t_InertialSensor_AccelerometerZ=0.0f, float t_InertialSensor_GyroscopeX=0.0f, float t_InertialSensor_GyroscopeY=0.0f, float t_InertialSensor_GyroscopeZ=0.0f, uint8_t t_Battery_Charge=0, uint8_t t_Battery_Current=0, float t_US=0.0f, bool t_ChestBoard_Button=true)
 Create a new SensorsBodySensors. More...
 
 SensorsBodySensors (const SensorsBodySensors &t_other)
 Copy Constructor. More...
 
 SensorsBodySensors (const struct wb_sensors_body_sensors &t_other)
 Copy Constructor. More...
 
SensorsBodySensorsoperator= (const SensorsBodySensors &t_other)
 Copy Assignment Operator. More...
 
SensorsBodySensorsoperator= (const struct wb_sensors_body_sensors &t_other)
 Copy Assignment Operator. More...
 
bool operator== (const SensorsBodySensors &t_other) const
 
bool operator!= (const SensorsBodySensors &t_other) const
 
bool operator== (const wb_sensors_body_sensors &t_other) const
 
bool operator!= (const wb_sensors_body_sensors &t_other) const
 
signed int & DCM_Time ()
 
const signed int & DCM_Time () const
 
void set_DCM_Time (const signed int &t_newValue)
 
float & InertialSensor_AccX ()
 
const float & InertialSensor_AccX () const
 
void set_InertialSensor_AccX (const float &t_newValue)
 
float & InertialSensor_AccY ()
 
const float & InertialSensor_AccY () const
 
void set_InertialSensor_AccY (const float &t_newValue)
 
float & InertialSensor_AccZ ()
 
const float & InertialSensor_AccZ () const
 
void set_InertialSensor_AccZ (const float &t_newValue)
 
float & InertialSensor_GyrX ()
 
const float & InertialSensor_GyrX () const
 
void set_InertialSensor_GyrX (const float &t_newValue)
 
float & InertialSensor_GyrY ()
 
const float & InertialSensor_GyrY () const
 
void set_InertialSensor_GyrY (const float &t_newValue)
 
float & InertialSensor_GyrZ ()
 
const float & InertialSensor_GyrZ () const
 
void set_InertialSensor_GyrZ (const float &t_newValue)
 
float & InertialSensor_AngleX ()
 
const float & InertialSensor_AngleX () const
 
void set_InertialSensor_AngleX (const float &t_newValue)
 
float & InertialSensor_AngleY ()
 
const float & InertialSensor_AngleY () const
 
void set_InertialSensor_AngleY (const float &t_newValue)
 
float & InertialSensor_AngleZ ()
 
const float & InertialSensor_AngleZ () const
 
void set_InertialSensor_AngleZ (const float &t_newValue)
 
float & InertialSensor_AccelerometerX ()
 
const float & InertialSensor_AccelerometerX () const
 
void set_InertialSensor_AccelerometerX (const float &t_newValue)
 
float & InertialSensor_AccelerometerY ()
 
const float & InertialSensor_AccelerometerY () const
 
void set_InertialSensor_AccelerometerY (const float &t_newValue)
 
float & InertialSensor_AccelerometerZ ()
 
const float & InertialSensor_AccelerometerZ () const
 
void set_InertialSensor_AccelerometerZ (const float &t_newValue)
 
float & InertialSensor_GyroscopeX ()
 
const float & InertialSensor_GyroscopeX () const
 
void set_InertialSensor_GyroscopeX (const float &t_newValue)
 
float & InertialSensor_GyroscopeY ()
 
const float & InertialSensor_GyroscopeY () const
 
void set_InertialSensor_GyroscopeY (const float &t_newValue)
 
float & InertialSensor_GyroscopeZ ()
 
const float & InertialSensor_GyroscopeZ () const
 
void set_InertialSensor_GyroscopeZ (const float &t_newValue)
 
uint8_t & Battery_Charge ()
 
const uint8_t & Battery_Charge () const
 
void set_Battery_Charge (const uint8_t &t_newValue)
 
uint8_t & Battery_Current ()
 
const uint8_t & Battery_Current () const
 
void set_Battery_Current (const uint8_t &t_newValue)
 
float & US ()
 
const float & US () const
 
void set_US (const float &t_newValue)
 
bool & ChestBoard_Button ()
 
const bool & ChestBoard_Button () const
 
void set_ChestBoard_Button (const bool &t_newValue)
 
 SensorsBodySensors (const std::string &t_str)
 String Constructor. More...
 
std::string description ()
 
std::string to_string ()
 
void from_string (const std::string &t_str)
 

Additional Inherited Members

- Public Attributes inherited from wb_sensors_body_sensors
signed int DCM_Time
 Absolute time used for all timed commands in the DCM, an integer (signed), with 1 ms precision. More...
 
float InertialSensor_AccX
 accelerometer X value More...
 
float InertialSensor_AccY
 accelerometer Y value More...
 
float InertialSensor_AccZ
 accelerometer Z value More...
 
float InertialSensor_GyrX
 gyro X value More...
 
float InertialSensor_GyrY
 gyro Y value More...
 
float InertialSensor_GyrZ
 gyro Z value (Nao V5 have a Z axis) More...
 
float InertialSensor_AngleX
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AngleY
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AngleZ
 new acc values: AL_Docs 'Theses are direct acceleration values in m.s-2 (one g is approximately 9.81 m.s-2)' More...
 
float InertialSensor_AccelerometerX
 new Accelerometer X value More...
 
float InertialSensor_AccelerometerY
 new Accelerometer Y value More...
 
float InertialSensor_AccelerometerZ
 new Accelerometer Z value More...
 
float InertialSensor_GyroscopeX
 new Gyro X value More...
 
float InertialSensor_GyroscopeY
 new Gyro Y value More...
 
float InertialSensor_GyroscopeZ
 new Gyro Z value More...
 
uint8_t Battery_Charge
 % of charge More...
 
uint8_t Battery_Current
 Amps. More...
 
float US
 unsure, check naoqi docs! Not sure about this type, might only be 1 byte More...
 
bool ChestBoard_Button
 state of the chest button, on / off. More...
 

Detailed Description

Provides a C++ wrapper around wb_sensors_body_sensors.

Definition at line 84 of file SensorsBodySensors.hpp.

Constructor & Destructor Documentation

◆ SensorsBodySensors() [1/4]

guWhiteboard::SensorsBodySensors::SensorsBodySensors ( signed int  t_DCM_Time = 0,
float  t_InertialSensor_AccX = 0.0f,
float  t_InertialSensor_AccY = 0.0f,
float  t_InertialSensor_AccZ = 0.0f,
float  t_InertialSensor_GyrX = 0.0f,
float  t_InertialSensor_GyrY = 0.0f,
float  t_InertialSensor_GyrZ = 0.0f,
float  t_InertialSensor_AngleX = 0.0f,
float  t_InertialSensor_AngleY = 0.0f,
float  t_InertialSensor_AngleZ = 0.0f,
float  t_InertialSensor_AccelerometerX = 0.0f,
float  t_InertialSensor_AccelerometerY = 0.0f,
float  t_InertialSensor_AccelerometerZ = 0.0f,
float  t_InertialSensor_GyroscopeX = 0.0f,
float  t_InertialSensor_GyroscopeY = 0.0f,
float  t_InertialSensor_GyroscopeZ = 0.0f,
uint8_t  t_Battery_Charge = 0,
uint8_t  t_Battery_Current = 0,
float  t_US = 0.0f,
bool  t_ChestBoard_Button = true 
)
inline

Create a new SensorsBodySensors.

Definition at line 119 of file SensorsBodySensors.hpp.

Referenced by operator==().

◆ SensorsBodySensors() [2/4]

◆ SensorsBodySensors() [3/4]

◆ SensorsBodySensors() [4/4]

guWhiteboard::SensorsBodySensors::SensorsBodySensors ( const std::string &  t_str)
inline

String Constructor.

Definition at line 496 of file SensorsBodySensors.hpp.

References from_string().

Member Function Documentation

◆ Battery_Charge() [1/2]

uint8_t & guWhiteboard::SensorsBodySensors::Battery_Charge ( )
inline

◆ Battery_Charge() [2/2]

const uint8_t & guWhiteboard::SensorsBodySensors::Battery_Charge ( ) const
inline

Definition at line 437 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::Battery_Charge.

◆ Battery_Current() [1/2]

uint8_t & guWhiteboard::SensorsBodySensors::Battery_Current ( )
inline

◆ Battery_Current() [2/2]

const uint8_t & guWhiteboard::SensorsBodySensors::Battery_Current ( ) const
inline

Definition at line 452 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::Battery_Current.

◆ ChestBoard_Button() [1/2]

bool & guWhiteboard::SensorsBodySensors::ChestBoard_Button ( )
inline

◆ ChestBoard_Button() [2/2]

const bool & guWhiteboard::SensorsBodySensors::ChestBoard_Button ( ) const
inline

◆ DCM_Time() [1/2]

signed int & guWhiteboard::SensorsBodySensors::DCM_Time ( )
inline

◆ DCM_Time() [2/2]

const signed int & guWhiteboard::SensorsBodySensors::DCM_Time ( ) const
inline

Definition at line 197 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::DCM_Time.

◆ description()

◆ from_string()

◆ InertialSensor_AccelerometerX() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerX ( )
inline

◆ InertialSensor_AccelerometerX() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerX ( ) const
inline

◆ InertialSensor_AccelerometerY() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerY ( )
inline

◆ InertialSensor_AccelerometerY() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerY ( ) const
inline

◆ InertialSensor_AccelerometerZ() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerZ ( )
inline

◆ InertialSensor_AccelerometerZ() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccelerometerZ ( ) const
inline

◆ InertialSensor_AccX() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccX ( )
inline

◆ InertialSensor_AccX() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccX ( ) const
inline

◆ InertialSensor_AccY() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccY ( )
inline

◆ InertialSensor_AccY() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccY ( ) const
inline

◆ InertialSensor_AccZ() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AccZ ( )
inline

◆ InertialSensor_AccZ() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AccZ ( ) const
inline

◆ InertialSensor_AngleX() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleX ( )
inline

◆ InertialSensor_AngleX() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleX ( ) const
inline

◆ InertialSensor_AngleY() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleY ( )
inline

◆ InertialSensor_AngleY() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleY ( ) const
inline

◆ InertialSensor_AngleZ() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleZ ( )
inline

◆ InertialSensor_AngleZ() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_AngleZ ( ) const
inline

◆ InertialSensor_GyroscopeX() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeX ( )
inline

◆ InertialSensor_GyroscopeX() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeX ( ) const
inline

◆ InertialSensor_GyroscopeY() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeY ( )
inline

◆ InertialSensor_GyroscopeY() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeY ( ) const
inline

◆ InertialSensor_GyroscopeZ() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeZ ( )
inline

◆ InertialSensor_GyroscopeZ() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyroscopeZ ( ) const
inline

◆ InertialSensor_GyrX() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrX ( )
inline

◆ InertialSensor_GyrX() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrX ( ) const
inline

◆ InertialSensor_GyrY() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrY ( )
inline

◆ InertialSensor_GyrY() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrY ( ) const
inline

◆ InertialSensor_GyrZ() [1/2]

float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrZ ( )
inline

◆ InertialSensor_GyrZ() [2/2]

const float & guWhiteboard::SensorsBodySensors::InertialSensor_GyrZ ( ) const
inline

◆ operator!=() [1/2]

bool guWhiteboard::SensorsBodySensors::operator!= ( const SensorsBodySensors t_other) const
inline

Definition at line 177 of file SensorsBodySensors.hpp.

◆ operator!=() [2/2]

bool guWhiteboard::SensorsBodySensors::operator!= ( const wb_sensors_body_sensors t_other) const
inline

Definition at line 187 of file SensorsBodySensors.hpp.

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

bool guWhiteboard::SensorsBodySensors::operator== ( const wb_sensors_body_sensors t_other) const
inline

Definition at line 182 of file SensorsBodySensors.hpp.

References SensorsBodySensors().

◆ set_Battery_Charge()

void guWhiteboard::SensorsBodySensors::set_Battery_Charge ( const uint8_t &  t_newValue)
inline

Definition at line 442 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::Battery_Charge.

Referenced by from_string().

◆ set_Battery_Current()

void guWhiteboard::SensorsBodySensors::set_Battery_Current ( const uint8_t &  t_newValue)
inline

Definition at line 457 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::Battery_Current.

Referenced by from_string().

◆ set_ChestBoard_Button()

void guWhiteboard::SensorsBodySensors::set_ChestBoard_Button ( const bool &  t_newValue)
inline

Definition at line 487 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::ChestBoard_Button.

Referenced by from_string().

◆ set_DCM_Time()

void guWhiteboard::SensorsBodySensors::set_DCM_Time ( const signed int &  t_newValue)
inline

Definition at line 202 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::DCM_Time.

Referenced by from_string().

◆ set_InertialSensor_AccelerometerX()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerX ( const float &  t_newValue)
inline

◆ set_InertialSensor_AccelerometerY()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerY ( const float &  t_newValue)
inline

◆ set_InertialSensor_AccelerometerZ()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccelerometerZ ( const float &  t_newValue)
inline

◆ set_InertialSensor_AccX()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccX ( const float &  t_newValue)
inline

Definition at line 217 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AccX.

Referenced by from_string().

◆ set_InertialSensor_AccY()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccY ( const float &  t_newValue)
inline

Definition at line 232 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AccY.

Referenced by from_string().

◆ set_InertialSensor_AccZ()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AccZ ( const float &  t_newValue)
inline

Definition at line 247 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AccZ.

Referenced by from_string().

◆ set_InertialSensor_AngleX()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleX ( const float &  t_newValue)
inline

Definition at line 307 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AngleX.

Referenced by from_string().

◆ set_InertialSensor_AngleY()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleY ( const float &  t_newValue)
inline

Definition at line 322 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AngleY.

Referenced by from_string().

◆ set_InertialSensor_AngleZ()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_AngleZ ( const float &  t_newValue)
inline

Definition at line 337 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_AngleZ.

Referenced by from_string().

◆ set_InertialSensor_GyroscopeX()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeX ( const float &  t_newValue)
inline

Definition at line 397 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyroscopeX.

Referenced by from_string().

◆ set_InertialSensor_GyroscopeY()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeY ( const float &  t_newValue)
inline

Definition at line 412 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyroscopeY.

Referenced by from_string().

◆ set_InertialSensor_GyroscopeZ()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyroscopeZ ( const float &  t_newValue)
inline

Definition at line 427 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyroscopeZ.

Referenced by from_string().

◆ set_InertialSensor_GyrX()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrX ( const float &  t_newValue)
inline

Definition at line 262 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyrX.

Referenced by from_string().

◆ set_InertialSensor_GyrY()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrY ( const float &  t_newValue)
inline

Definition at line 277 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyrY.

Referenced by from_string().

◆ set_InertialSensor_GyrZ()

void guWhiteboard::SensorsBodySensors::set_InertialSensor_GyrZ ( const float &  t_newValue)
inline

Definition at line 292 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::InertialSensor_GyrZ.

Referenced by from_string().

◆ set_US()

void guWhiteboard::SensorsBodySensors::set_US ( const float &  t_newValue)
inline

Definition at line 472 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::US.

Referenced by from_string().

◆ to_string()

◆ US() [1/2]

float & guWhiteboard::SensorsBodySensors::US ( )
inline

◆ US() [2/2]

const float & guWhiteboard::SensorsBodySensors::US ( ) const
inline

Definition at line 467 of file SensorsBodySensors.hpp.

References wb_sensors_body_sensors::US.


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