MissionCmdParamInfo Class Reference

UI Information associated with a mission command (MAV_CMD) parameter. More...

#include <MissionCommandUIInfo.h>

Inheritance diagram for MissionCmdParamInfo:

Collaboration diagram for MissionCmdParamInfo:

Public Member Functions
	MissionCmdParamInfo (QObject *parent=nullptr)
	MissionCmdParamInfo (const MissionCmdParamInfo &other, QObject *parent=nullptr)
const MissionCmdParamInfo &	operator= (const MissionCmdParamInfo &other)
int	decimalPlaces (void) const
double	defaultValue (void) const
QStringList	enumStrings (void) const
QVariantList	enumValues (void) const
QString	label (void) const
int	param (void) const
QString	units (void) const
bool	nanUnchanged (void) const
double	min (void) const
double	max (void) const
double	userMin (void) const
double	userMax (void) const
bool	advanced (void) const

Friends
class	MissionCommandTree
class	MissionCommandUIInfo

Detailed Description

UI Information associated with a mission command (MAV_CMD) parameter.

MissionCommandParamInfo is used to automatically generate editing ui for a parameter associated with a MAV_CMD.

The json format for a MissionCmdParamInfo object is:

Key Type Default QJsonValue::Type Description label string required String Label for text field units string String Units for value, should use FactMetaData units strings in order to get automatic translation default double 0.0/NaN Null Default value for param. If no default value specified and nanUnchanged == true, then defaultValue is NaN. decimalPlaces int 7 Double Number of decimal places to show for value min double unbounded Double Minimum value for param max double unbounded Double Maximum value for param userMin double NaN Null Lower bound for user editing (NaN means not set) userMax double NaN Null Upper bound for user editing (NaN means not set) enumStrings string String Strings to show in combo box for selection enumValues string String Values associated with each enum string nanUnchanged bool false Bool True: value can be set to NaN to signal unchanged advanced bool false Bool True: mark parameter as advanced-only for UI selection

Note on NaN usage: To indicate a NaN as a value in the json file use the value 'null' (with no quotes) Internally, these null values are converted to NaN when the json is read

Definition at line 38 of file MissionCommandUIInfo.h.

Constructor & Destructor Documentation

MissionCmdParamInfo() [1/2]

MissionCmdParamInfo::MissionCmdParamInfo

(

QObject *

parent = nullptr

)

Definition at line 10 of file MissionCommandUIInfo.cc.

MissionCmdParamInfo() [2/2]

MissionCmdParamInfo::MissionCmdParamInfo	(	const MissionCmdParamInfo &	other,
		QObject *	parent = nullptr
	)

Definition at line 21 of file MissionCommandUIInfo.cc.

Member Function Documentation

advanced()

bool MissionCmdParamInfo::advanced ( void  ) const

inline

Definition at line 74 of file MissionCommandUIInfo.h.

decimalPlaces()

int MissionCmdParamInfo::decimalPlaces ( void  ) const

inline

Definition at line 62 of file MissionCommandUIInfo.h.

defaultValue()

double MissionCmdParamInfo::defaultValue ( void  ) const

inline

Definition at line 63 of file MissionCommandUIInfo.h.

enumStrings()

QStringList MissionCmdParamInfo::enumStrings ( void  ) const

inline

Definition at line 64 of file MissionCommandUIInfo.h.

enumValues()

QVariantList MissionCmdParamInfo::enumValues ( void  ) const

inline

Definition at line 65 of file MissionCommandUIInfo.h.

label()

QString MissionCmdParamInfo::label ( void  ) const

inline

Definition at line 66 of file MissionCommandUIInfo.h.

max()

double MissionCmdParamInfo::max ( void  ) const

inline

Definition at line 71 of file MissionCommandUIInfo.h.

min()

double MissionCmdParamInfo::min ( void  ) const

inline

Definition at line 70 of file MissionCommandUIInfo.h.

nanUnchanged()

bool MissionCmdParamInfo::nanUnchanged ( void  ) const

inline

Definition at line 69 of file MissionCommandUIInfo.h.

operator=()

const MissionCmdParamInfo & MissionCmdParamInfo::operator=

(

const MissionCmdParamInfo &

other

)

Definition at line 27 of file MissionCommandUIInfo.cc.

param()

int MissionCmdParamInfo::param ( void  ) const

inline

Definition at line 67 of file MissionCommandUIInfo.h.

units()

QString MissionCmdParamInfo::units ( void  ) const

inline

Definition at line 68 of file MissionCommandUIInfo.h.

userMax()

double MissionCmdParamInfo::userMax ( void  ) const

inline

Definition at line 73 of file MissionCommandUIInfo.h.

userMin()

double MissionCmdParamInfo::userMin ( void  ) const

inline

Definition at line 72 of file MissionCommandUIInfo.h.

Friends And Related Symbol Documentation

MissionCommandTree

friend class MissionCommandTree

friend

Definition at line 91 of file MissionCommandUIInfo.h.

MissionCommandUIInfo

friend class MissionCommandUIInfo

friend

Definition at line 92 of file MissionCommandUIInfo.h.

---

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

• src/MissionManager/MissionCommandUIInfo.h
• src/MissionManager/MissionCommandUIInfo.cc