auterion::ModeConfiguration Class Reference

Configuration flags for specifying mode requirements and capabilities. More...

#include <auterion_sdk/control/mode.hpp>

Classes
struct	PX4Mode
	Struct storing PX4 mode IDs. More...

Public Member Functions
ModeConfiguration	merge (const ModeConfiguration &other) const
ModeConfiguration &	replacesPX4Mode (PX4Mode::ID px4_mode_id)
	Configures a Mode to replace an existing PX4 mode. More...
ModeConfiguration &	needsAngularVelocity (bool needs=true)
ModeConfiguration &	needsAttitude (bool needs=true)
ModeConfiguration &	needsLocalAltitude (bool needs=true)
ModeConfiguration &	needsLocalPosition (bool needs=true)
ModeConfiguration &	needsLocalPositionRelaxed (bool needs=true)
ModeConfiguration &	needsGlobalPosition (bool needs=true)
ModeConfiguration &	needsValidMission (bool needs=true)
ModeConfiguration &	needsValidHome (bool needs=true)
ModeConfiguration &	needsManualControlInput (bool needs=true)
ModeConfiguration &	canPreventArming (bool can=true)

Public Attributes
PX4Mode::ID	replace_px4_mode
bool	needs_angular_velocity {false}
bool	needs_attitude {false}
bool	needs_local_altitude {false}
bool	needs_local_position {false}
bool	needs_local_position_relaxed {false}
bool	needs_global_position {false}
bool	needs_valid_mission {false}
bool	needs_valid_home {false}
bool	needs_manual_control_input {false}
bool	can_prevent_arming {false}

Detailed Description

Configuration flags for specifying mode requirements and capabilities.

Member Function Documentation

replacesPX4Mode()

ModeConfiguration& auterion::ModeConfiguration::replacesPX4Mode ( PX4Mode::ID  px4_mode_id )

inline

Configures a Mode to replace an existing PX4 mode.

Parameters

px4_mode_id

The ID of the PX4 mode that the custom Mode will replace.

Returns

A reference to the current ModeConfiguration object.

Member Data Documentation

replace_px4_mode

PX4Mode::ID auterion::ModeConfiguration::replace_px4_mode

Initial value:

{
        PX4Mode::kModeIDInvalid}

If set to a valid PX4 mode, replaces flight controller's existing mode

---

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

• include/auterion_sdk/control/mode.hpp