flyby::Gimbal Class Reference

The base gimbal class. More...

#include <gimbal.h>

Inheritance diagram for flyby::Gimbal:

Collaboration diagram for flyby::Gimbal:

Public Member Functions
	Gimbal ()=default
	The default constructor.
GimbalMode	get_gimbal_mode () override
	Gets the gimbal mode.
void	set_gimbal_mode (GimbalMode mode) override
	Sets the gimbal mode.
void	set_roll_pitch_yaw_angle (double roll, double pitch, double yaw) override
	Sets the angle of the roll, pitch, and yaw.
void	set_roll_pitch_yaw_speed (double roll, double pitch, double yaw) override
	Sets the speed of rotation of the roll, pitch, and yaw.
double	get_roll () const override
	Returns current roll angle.
double	get_pitch () const override
	Returns current pitch angle.
double	get_yaw () const override
	Returns current yaw angle.

Detailed Description

The base gimbal class.

This class should be extended by overriding functions that correspond to available functionality. For example, gimbals that have angle controls for roll/pitch/yaw should override the set_roll_pitch_yaw_angle function.

Member Function Documentation

get_gimbal_mode()

GimbalMode flyby::Gimbal::get_gimbal_mode ( )

inlineoverride

Gets the gimbal mode.

Should be overridden if a gimbal should implement this capability.

Returns

The gimbal mode

get_pitch()

double flyby::Gimbal::get_pitch ( ) const

inlinenodiscardoverride

Returns current pitch angle.

Should be overridden if a gimbal should implement this capability.

Returns

The pitch angle

get_roll()

double flyby::Gimbal::get_roll ( ) const

inlinenodiscardoverride

Returns current roll angle.

Should be overridden if a gimbal should implement this capability.

Returns

The roll angle

get_yaw()

double flyby::Gimbal::get_yaw ( ) const

inlinenodiscardoverride

Returns current yaw angle.

Should be overridden if a gimbal should implement this capability.

Returns

The yaw angle

set_gimbal_mode()

void flyby::Gimbal::set_gimbal_mode ( GimbalMode mode )

inlineoverride

Sets the gimbal mode.

Should be overridden if a gimbal should implement this capability.

Parameters

mode	- The gimbal mode

set_roll_pitch_yaw_angle()

void flyby::Gimbal::set_roll_pitch_yaw_angle ( double roll, double pitch, double yaw )

inlineoverride

Sets the angle of the roll, pitch, and yaw.

Should be overridden if a gimbal should implement this capability.

Parameters

roll	- The roll angle
pitch	- The pitch angle
yaw	- The yaw angle

set_roll_pitch_yaw_speed()

void flyby::Gimbal::set_roll_pitch_yaw_speed ( double roll, double pitch, double yaw )

inlineoverride

Sets the speed of rotation of the roll, pitch, and yaw.

Should be overridden if a gimbal should implement this capability.

Parameters

roll	- The roll angle
pitch	- The pitch angle
yaw	- The yaw angle

---

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

• include/flyby/payload/component/gimbal.h