Flair
Framework Libre Air
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties
flair::filter::Ahrs Class Reference

Abstract class for AHRS. More...

#include <Ahrs.h>

+ Inheritance diagram for flair::filter::Ahrs:

Public Member Functions

 Ahrs (const sensor::Imu *parent, std::string name)
 Constructor. More...
 
 ~Ahrs ()
 Destructor. More...
 
const sensor::ImuGetImu (void) const
 Get parent Imu. More...
 
const core::AhrsDataGetDatas (void) const
 Get ahrs datas. More...
 
void LockUserInterface (void) const
 Lock the graphical user interface. More...
 
void UnlockUserInterface (void) const
 Unlock the graphical user interface. More...
 
void UseDefaultPlot (void)
 Use default plot. More...
 
void AddPlot (const core::AhrsData *ahrsData, gui::DataPlot::Color_t color)
 Add plot. More...
 
gui::DataPlot1DRollPlot (void) const
 Roll plot. More...
 
gui::DataPlot1DPitchPlot (void) const
 Pitch plot. More...
 
gui::DataPlot1DYawPlot (void) const
 Yaw plot. More...
 
gui::DataPlot1DWXPlot (void) const
 Rotation speed around x axis plot. More...
 
gui::DataPlot1DWYPlot (void) const
 Rotation speed around y axis plot. More...
 
gui::DataPlot1DWZPlot (void) const
 Rotation speed around z axis plot. More...
 
- Public Member Functions inherited from flair::core::IODevice
 IODevice (const Object *parent, std::string name)
 Constructor. More...
 
virtual ~IODevice ()
 Destructor. More...
 
void AddDeviceToLog (const IODevice *device)
 Add an IODevice to the logs. More...
 
void AddDataToLog (const io_data *data)
 Add an io_data to the log. More...
 
void OutputToShMem (bool enabled)
 Send the output to a shared memory. More...
 
virtual DataType const & GetInputDataType () const
 
virtual DataType const & GetOutputDataType () const
 
- Public Member Functions inherited from flair::core::Object
 Object (const Object *parent=NULL, std::string name="", std::string type="")
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
std::string ObjectName (void) const
 Name. More...
 
std::string ObjectType (void) const
 Type. More...
 
const ObjectParent (void) const
 Parent. More...
 
std::vector< const Object * > * TypeChilds (void) const
 Childs of the same type. More...
 
std::vector< const Object * > * Childs (void) const
 Childs. More...
 
void Information (const char *function, int line, const char *format,...) const
 Formatted information. More...
 
void Warning (const char *function, const char *format,...) const
 Formatted warning. More...
 
void Error (const char *function, const char *format,...) const
 Formatted error. More...
 
bool ErrorOccured (bool recursive=true) const
 Has an errror occured? More...
 

Protected Member Functions

void GetDatas (core::AhrsData **ahrsData) const
 Get ahrs datas. More...
 
- Protected Member Functions inherited from flair::core::IODevice
void ProcessUpdate (io_data *data)
 Process the childs of type IODevice, and log if needed. More...
 

Additional Inherited Members

- Public Types inherited from flair::core::Object
enum  color_t { Auto = 0, Red = 31, Green = 32, Orange = 33 }
 

Detailed Description

Abstract class for AHRS.

Use this class to define a custom AHRS. This class is child of an Imu class, which will provide measurements.

Constructor & Destructor Documentation

flair::filter::Ahrs::Ahrs ( const sensor::Imu parent,
std::string  name 
)

Constructor.

Construct an Ahrs.

Parameters
parentparent
namename
flair::filter::Ahrs::~Ahrs ( )

Destructor.

Member Function Documentation

const sensor::Imu* flair::filter::Ahrs::GetImu ( void  ) const

Get parent Imu.

This function is identical to (Imu*)Parent()

const core::AhrsData* flair::filter::Ahrs::GetDatas ( void  ) const

Get ahrs datas.

Returns
AhrsData
void flair::filter::Ahrs::LockUserInterface ( void  ) const

Lock the graphical user interface.

When locked, parameters cannot be modified.

void flair::filter::Ahrs::UnlockUserInterface ( void  ) const

Unlock the graphical user interface.

void flair::filter::Ahrs::UseDefaultPlot ( void  )

Use default plot.

Plot the datas defined in imudata, and datas defined in Imu::imudata.

void flair::filter::Ahrs::AddPlot ( const core::AhrsData ahrsData,
gui::DataPlot::Color_t  color 
)

Add plot.

Add plot of an AhrsData to the default plot

Parameters
ahrsDataahrs datas to plot
colorcolor to use
gui::DataPlot1D* flair::filter::Ahrs::RollPlot ( void  ) const

Roll plot.

Use this plot to add own curves.

Returns
plot
gui::DataPlot1D* flair::filter::Ahrs::PitchPlot ( void  ) const

Pitch plot.

Use this plot to add own curves.

Returns
plot
gui::DataPlot1D* flair::filter::Ahrs::YawPlot ( void  ) const

Yaw plot.

Use this plot to add own curves.

Returns
plot
gui::DataPlot1D* flair::filter::Ahrs::WXPlot ( void  ) const

Rotation speed around x axis plot.

Use this plot to add own curves.

Returns
plot
gui::DataPlot1D* flair::filter::Ahrs::WYPlot ( void  ) const

Rotation speed around y axis plot.

Use this plot to add own curves.

Returns
plot
gui::DataPlot1D* flair::filter::Ahrs::WZPlot ( void  ) const

Rotation speed around z axis plot.

Use this plot to add own curves.

Returns
plot
void flair::filter::Ahrs::GetDatas ( core::AhrsData **  ahrsData) const
protected

Get ahrs datas.

Parameters
ahrsDataahrs datas