Magnetometer_sim Class Reference

Simulated magnetometers. More...

#include <magnetometer_sim.hpp>

Inheritance diagram for Magnetometer_sim:

Collaboration diagram for Magnetometer_sim:

List of all members.

Public Member Functions
	Magnetometer_sim (Dynamic_model &dynamic_model)
	Constructor.
bool	init (void)
	Initialise the sensor.
bool	update (void)
	Main update function Reads new values from sensor.
const float &	last_update_us (void) const
	Get last update time in microseconds.
const std::array< float, 3 > &	mag (void) const
	Get X, Y and Z components of magnetic field.
const float &	mag_X (void) const
	Get X component of magnetic field.
const float &	mag_Y (void) const
	Get Y component of magnetic field.
const float &	mag_Z (void) const
	Get Z component of magnetic field.
const float &	temperature (void) const
	Get sensor temperature.

---

Detailed Description

Simulated magnetometers.

---

Constructor & Destructor Documentation

Magnetometer_sim::Magnetometer_sim

(

Dynamic_model &

dynamic_model

)

Constructor.

Parameters:

dynamic_model

Reference to dynamic model

---

Member Function Documentation

bool Magnetometer_sim::init

(

void

)

[virtual]

Initialise the sensor.

Returns:

Success

Implements Magnetometer.

const float & Magnetometer_sim::last_update_us

(

void

)

const [virtual]

Get last update time in microseconds.

Returns:

Update time

Implements Magnetometer.

Here is the call graph for this function:

const std::array< float, 3 > & Magnetometer_sim::mag

(

void

)

const [virtual]

Get X, Y and Z components of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Magnetometer_sim::mag_X

(

void

)

const [virtual]

Get X component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Magnetometer_sim::mag_Y

(

void

)

const [virtual]

Get Y component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Magnetometer_sim::mag_Z

(

void

)

const [virtual]

Get Z component of magnetic field.

This is raw data, so X, Y and Z components are biased, not scaled, and given in the sensor frame (not in the UAV frame). Use an Imu object to handle bias removal, scaling and axis rotations

Returns:

Value

Implements Magnetometer.

const float & Magnetometer_sim::temperature

(

void

)

const [virtual]

Get sensor temperature.

Returns:

Value

Implements Magnetometer.

bool Magnetometer_sim::update

(

void

)

[virtual]

Main update function Reads new values from sensor.

Returns:

Success

Implements Magnetometer.

Here is the call graph for this function:

---

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

• /home/travis/build/lis-epfl/MAVRIC_Library/simulation/magnetometer_sim.hpp
• /home/travis/build/lis-epfl/MAVRIC_Library/simulation/magnetometer_sim.cpp