Auterion App SDK
Auterion SDK is a library that can be used by AuterionOS apps to communicate with the system.
Loading...
Searching...
No Matches
auterion::GimbalCapabilities Struct Reference

Represents the capabilities of a gimbal. More...

#include <auterion_sdk/gimbal/gimbal.hpp>

Public Member Functions

bool meetsRequirements (const GimbalCapabilities &requirements) const
 Check if the given requirements are met by the current capabilities.
 
bool supportsMode (const GimbalMode &mode) const
 Check if a given gimbal mode is supported by the current capabilities.
 
std::string toString () const
 
GimbalCapabilities & canRetract ()
 
GimbalCapabilities & canNeutral ()
 
GimbalCapabilities & canRoll ()
 
GimbalCapabilities & canRollFollow ()
 
GimbalCapabilities & canRollLock ()
 
GimbalCapabilities & canPitch ()
 
GimbalCapabilities & canPitchFollow ()
 
GimbalCapabilities & canPitchLock ()
 
GimbalCapabilities & canYaw ()
 
GimbalCapabilities & canYawFollow ()
 
GimbalCapabilities & canYawLock ()
 
GimbalCapabilities & canInfiniteYaw ()
 
GimbalCapabilities & canPointLocationLocal ()
 
GimbalCapabilities & canPointLocationGlobal ()
 
GimbalCapabilities & RollRangeDeg (float min_deg, float max_deg)
 
GimbalCapabilities & PitchRangeDeg (float min_deg, float max_deg)
 
GimbalCapabilities & YawRangeDeg (float min_deg, float max_deg)
 

Public Attributes

bool can_retract {false}
 
bool can_neutral {false}
 
bool can_roll {false}
 
bool can_roll_follow {false}
 
bool can_roll_lock {false}
 
bool can_pitch {false}
 
bool can_pitch_follow {false}
 
bool can_pitch_lock {false}
 
bool can_yaw {false}
 
bool can_yaw_follow {false}
 
bool can_yaw_lock {false}
 
bool can_infinite_yaw {false}
 
bool can_point_location_local {false}
 
bool can_point_location_global {false}
 
float roll_min_deg {0}
 Minimal roll range (degrees)
 
float roll_max_deg {0}
 Maximal roll range (degrees)
 
float pitch_min_deg {0}
 Minimal pitch range (degrees)
 
float pitch_max_deg {0}
 Maximal pitch range (degrees)
 
float yaw_min_deg {0}
 Minimal yaw range (degrees)
 
float yaw_max_deg {0}
 Maximal yaw range (degrees)
 

Detailed Description

Represents the capabilities of a gimbal.

Member Function Documentation

◆ meetsRequirements()

bool auterion::GimbalCapabilities::meetsRequirements ( const GimbalCapabilities &  requirements) const

Check if the given requirements are met by the current capabilities.

Parameters
requirementsRequired capabilities
Returns
True if requirements are met, false otherwise

◆ supportsMode()

bool auterion::GimbalCapabilities::supportsMode ( const GimbalMode &  mode) const

Check if a given gimbal mode is supported by the current capabilities.

Parameters
modeGimbal mode
Returns
True if supported, false otherwise

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