Holds the meta data associated with a Fact. More...

#include <FactMetaData.h>

Inheritance diagram for FactMetaData:

Collaboration diagram for FactMetaData:

Public Types
enum	ValueType_t { valueTypeUint8 , valueTypeInt8 , valueTypeUint16 , valueTypeInt16 , valueTypeUint32 , valueTypeInt32 , valueTypeUint64 , valueTypeInt64 , valueTypeFloat , valueTypeDouble , valueTypeString , valueTypeBool , valueTypeElapsedTimeInSeconds , valueTypeCustom }

typedef QVariant(*	Translator) (const QVariant &from)

typedef QString(*	CustomCookedValidator) (const QVariant &cookedValue)

typedef QHash< QString, FactMetaData * >	NameToMetaDataMap_t

typedef QMap< QString, QString >	DefineMap_t

Public Member Functions
	FactMetaData (QObject *parent=nullptr)

	FactMetaData (ValueType_t type, QObject *parent=nullptr)

	FactMetaData (ValueType_t type, const QString &name, QObject *parent=nullptr)

	FactMetaData (const FactMetaData &other, QObject *parent=nullptr)

	~FactMetaData ()

const FactMetaData &	operator= (const FactMetaData &other)

int	decimalPlaces () const

QVariant	rawDefaultValue () const

QVariant	cookedDefaultValue () const

bool	defaultValueAvailable () const

QStringList	bitmaskStrings () const

QVariantList	bitmaskValues () const

QStringList	enumStrings () const

QVariantList	enumValues () const

QString	category () const

QString	group () const

QString	longDescription () const

QVariant	rawMax () const

QVariant	cookedMax () const

bool	maxIsDefaultForType () const

QVariant	rawMin () const

QVariant	cookedMin () const

bool	minIsDefaultForType () const

QVariant	rawUserMin () const

QVariant	rawUserMax () const

QVariant	cookedUserMin () const

QVariant	cookedUserMax () const

QString	name () const

QString	label () const

QString	shortDescription () const

ValueType_t	type () const

QString	rawUnits () const

QString	cookedUnits () const

bool	vehicleRebootRequired () const

bool	qgcRebootRequired () const

bool	hasControl () const

bool	readOnly () const

bool	writeOnly () const

bool	volatileValue () const

double	rawIncrement () const

double	cookedIncrement () const

Translator	rawTranslator () const

Translator	cookedTranslator () const

void	addBitmaskInfo (const QString &name, const QVariant &value)
	Used to add new values to the bitmask lists after the meta data has been loaded.

void	addEnumInfo (const QString &name, const QVariant &value)
	Used to add new values to the enum lists after the meta data has been loaded.

void	removeEnumInfo (const QVariant &value)
	Used to remove values from the enum lists after the meta data has been loaded.

void	setDecimalPlaces (int decimalPlaces)

void	setRawDefaultValue (const QVariant &rawDefaultValue)

void	setBitmaskInfo (const QStringList &strings, const QVariantList &values)

void	setEnumInfo (const QStringList &strings, const QVariantList &values)

void	setCategory (const QString &category)

void	setGroup (const QString &group)

void	setLongDescription (const QString &longDescription)

void	setRawMax (const QVariant &rawMax)

void	setRawMin (const QVariant &rawMin)

void	setRawUserMin (const QVariant &rawUserMin)

void	setRawUserMax (const QVariant &rawUserMax)

void	setName (const QString &name)

void	setLabel (const QString &label)

void	setShortDescription (const QString &shortDescription)

void	setRawUnits (const QString &rawUnits)

void	setVehicleRebootRequired (bool rebootRequired)

void	setQGCRebootRequired (bool rebootRequired)

void	setRawIncrement (double increment)

void	setHasControl (bool bValue)

void	setReadOnly (bool bValue)

void	setWriteOnly (bool bValue)

void	setVolatileValue (bool bValue)

void	setTranslators (Translator rawTranslator_, Translator cookedTranslator_)

void	setBuiltInTranslator ()
	Set the translators to the standard built in versions.

bool	convertAndValidateRaw (const QVariant &rawValue, bool convertOnly, QVariant &typedValue, QString &errorString) const

bool	convertAndValidateCooked (const QVariant &cookedValue, bool convertOnly, QVariant &typedValue, QString &errorString) const
	Same as convertAndValidateRaw except for cookedValue input.

bool	clampValue (const QVariant &cookedValue, QVariant &typedValue) const

void	setCustomCookedValidator (CustomCookedValidator customValidator)

Static Public Member Functions
static QMap< QString, FactMetaData * >	createMapFromJsonFile (const QString &jsonFilename, QObject *metaDataParent)

static QMap< QString, FactMetaData * >	createMapFromJsonArray (const QJsonArray &jsonArray, const DefineMap_t &defineMap, QObject *metaDataParent)

static FactMetaData *	createFromJsonObject (const QJsonObject &json, const QMap< QString, QString > &defineMap, QObject *metaDataParent)

static QVariant	metersToAppSettingsHorizontalDistanceUnits (const QVariant &meters)
	Converts from meters to the user specified horizontal distance unit.

static QVariant	appSettingsHorizontalDistanceUnitsToMeters (const QVariant &distance)
	Converts from user specified horizontal distance unit to meters.

static QString	appSettingsHorizontalDistanceUnitsString ()
	Returns the string for horizontal distance units which has configued by user.

static QVariant	metersToAppSettingsVerticalDistanceUnits (const QVariant &meters)
	Converts from meters to the user specified vertical distance unit.

static QVariant	appSettingsVerticalDistanceUnitsToMeters (const QVariant &distance)
	Converts from user specified vertical distance unit to meters.

static QString	appSettingsVerticalDistanceUnitsString ()
	Returns the string for vertical distance units which has configued by user.

static QVariant	gramsToAppSettingsWeightUnits (const QVariant &grams)
	Converts from grams to the user specified weight unit.

static QVariant	appSettingsWeightUnitsToGrams (const QVariant &weight)
	Converts from user specified weight unit to grams.

static QString	appSettingsWeightUnitsString ()
	Returns the string for weight units which has configued by user.

static QVariant	squareMetersToAppSettingsAreaUnits (const QVariant &squareMeters)
	Converts from meters to the user specified distance unit.

static QVariant	appSettingsAreaUnitsToSquareMeters (const QVariant &area)
	Converts from user specified distance unit to meters.

static QString	appSettingsAreaUnitsString ()
	Returns the string for distance units which has configued by user.

static QVariant	metersSecondToAppSettingsSpeedUnits (const QVariant &metersSecond)
	Converts from meters/second to the user specified speed unit.

static QVariant	appSettingsSpeedUnitsToMetersSecond (const QVariant &speed)
	Converts from user specified speed unit to meters/second.

static QString	appSettingsSpeedUnitsString ()
	Returns the string for speed units which has configued by user.

static const QString	defaultCategory ()

static const QString	defaultGroup ()

static QStringList	splitTranslatedList (const QString &translatedList)

static ValueType_t	stringToType (const QString &typeString, bool &unknownType)

static QString	typeToString (ValueType_t type)

static size_t	typeToSize (ValueType_t type)

static QVariant	minForType (ValueType_t type)

static QVariant	maxForType (ValueType_t type)

Static Public Attributes
static constexpr int	kDefaultDecimalPlaces = 3
	Default value for decimal places if not specified/known.

static constexpr int	kUnknownDecimalPlaces = -1
	Number of decimal places to specify is not known.

static constexpr const char *	kDefaultCategory = QT_TRANSLATE_NOOP("FactMetaData", "Other")

static constexpr const char *	kDefaultGroup = QT_TRANSLATE_NOOP("FactMetaData", "Misc")

static constexpr const char *	qgcFileType = "FactMetaData"

Friends
class	SettingsManager

Detailed Description

Holds the meta data associated with a Fact.

This is kept in a separate object from the Fact itself since you may have multiple instances of the same Fact. But there is only ever one FactMetaData instance for each Fact.

Definition at line 16 of file FactMetaData.h.

Member Typedef Documentation

◆ CustomCookedValidator

typedef QString(* FactMetaData::CustomCookedValidator) (const QVariant &cookedValue)

Definition at line 46 of file FactMetaData.h.

◆ DefineMap_t

typedef QMap<QString, QString> FactMetaData::DefineMap_t

Definition at line 56 of file FactMetaData.h.

◆ NameToMetaDataMap_t

typedef QHash<QString , FactMetaData*> FactMetaData::NameToMetaDataMap_t

Definition at line 48 of file FactMetaData.h.

◆ Translator

typedef QVariant(* FactMetaData::Translator) (const QVariant &from)

Definition at line 42 of file FactMetaData.h.

Member Enumeration Documentation

◆ ValueType_t

enum FactMetaData::ValueType_t

Enumerator
valueTypeUint8
valueTypeInt8
valueTypeUint16
valueTypeInt16
valueTypeUint32
valueTypeInt32
valueTypeUint64
valueTypeInt64
valueTypeFloat
valueTypeDouble
valueTypeString
valueTypeBool
valueTypeElapsedTimeInSeconds
valueTypeCustom

Definition at line 24 of file FactMetaData.h.

Constructor & Destructor Documentation

◆ FactMetaData() [1/4]

FactMetaData::FactMetaData ( QObject * parent = nullptr )

explicit

Definition at line 56 of file FactMetaData.cc.

◆ FactMetaData() [2/4]

FactMetaData::FactMetaData	(	ValueType_t	type,
		QObject *	parent = `nullptr`
	)

explicit

Definition at line 62 of file FactMetaData.cc.

◆ FactMetaData() [3/4]

FactMetaData::FactMetaData	(	ValueType_t	type,
		const QString &	name,
		QObject *	parent = `nullptr`
	)

explicit

Definition at line 76 of file FactMetaData.cc.

◆ FactMetaData() [4/4]

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

explicit

Definition at line 69 of file FactMetaData.cc.

◆ ~FactMetaData()

FactMetaData::~FactMetaData ( )

Definition at line 84 of file FactMetaData.cc.

Member Function Documentation

◆ addBitmaskInfo()

void FactMetaData::addBitmaskInfo	(	const QString &	name,
		const QVariant &	value
	)

Used to add new values to the bitmask lists after the meta data has been loaded.

Definition at line 576 of file FactMetaData.cc.

References name().

Referenced by createFromJsonObject().

◆ addEnumInfo()

void FactMetaData::addEnumInfo	(	const QString &	name,
		const QVariant &	value
	)

Used to add new values to the enum lists after the meta data has been loaded.

Definition at line 594 of file FactMetaData.cc.

References name().

Referenced by createFromJsonObject(), and Fact::enumIndex().

◆ appSettingsAreaUnitsString()

QString FactMetaData::appSettingsAreaUnitsString ( )

static

Returns the string for distance units which has configued by user.

Definition at line 1070 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsAreaUnitsString().

◆ appSettingsAreaUnitsToSquareMeters()

QVariant FactMetaData::appSettingsAreaUnitsToSquareMeters ( const QVariant & area )

static

Converts from user specified distance unit to meters.

Definition at line 1060 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsAreaUnitsToSquareMeters().

◆ appSettingsHorizontalDistanceUnitsString()

QString FactMetaData::appSettingsHorizontalDistanceUnitsString ( )

static

Returns the string for horizontal distance units which has configued by user.

Definition at line 1020 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsHorizontalDistanceUnitsString(), and Vehicle::guidedModeGotoLocation().

◆ appSettingsHorizontalDistanceUnitsToMeters()

QVariant FactMetaData::appSettingsHorizontalDistanceUnitsToMeters ( const QVariant & distance )

static

Converts from user specified horizontal distance unit to meters.

Definition at line 1000 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsHorizontalDistanceUnitsToMeters().

◆ appSettingsSpeedUnitsString()

QString FactMetaData::appSettingsSpeedUnitsString ( )

static

Returns the string for speed units which has configued by user.

Definition at line 1118 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsSpeedUnitsString().

◆ appSettingsSpeedUnitsToMetersSecond()

QVariant FactMetaData::appSettingsSpeedUnitsToMetersSecond ( const QVariant & speed )

static

Converts from user specified speed unit to meters/second.

Definition at line 1108 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsSpeedUnitsToMetersSecond().

◆ appSettingsVerticalDistanceUnitsString()

QString FactMetaData::appSettingsVerticalDistanceUnitsString ( )

static

Returns the string for vertical distance units which has configued by user.

Definition at line 1030 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsVerticalDistanceUnitsString().

◆ appSettingsVerticalDistanceUnitsToMeters()

QVariant FactMetaData::appSettingsVerticalDistanceUnitsToMeters ( const QVariant & distance )

static

Converts from user specified vertical distance unit to meters.

Definition at line 1010 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsVerticalDistanceUnitsToMeters().

◆ appSettingsWeightUnitsString()

QString FactMetaData::appSettingsWeightUnitsString ( )

static

Returns the string for weight units which has configued by user.

Definition at line 1040 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsWeightUnitsString().

◆ appSettingsWeightUnitsToGrams()

QVariant FactMetaData::appSettingsWeightUnitsToGrams ( const QVariant & weight )

static

Converts from user specified weight unit to grams.

Definition at line 1089 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::appSettingsWeightUnitsToGrams().

◆ bitmaskStrings()

QStringList FactMetaData::bitmaskStrings ( ) const

inline

Definition at line 121 of file FactMetaData.h.

Referenced by Fact::bitmaskStrings(), and Fact::selectedBitmaskStrings().

◆ bitmaskValues()

QVariantList FactMetaData::bitmaskValues ( ) const

inline

Definition at line 122 of file FactMetaData.h.

Referenced by Fact::bitmaskValues(), and Fact::selectedBitmaskStrings().

◆ category()

QString FactMetaData::category ( ) const

inline

Definition at line 125 of file FactMetaData.h.

Referenced by PX4ParameterMetaData::_postProcessMetaData(), Fact::category(), and setCategory().

◆ clampValue()

bool FactMetaData::clampValue	(	const QVariant &	cookedValue,
		QVariant &	typedValue
	)		const

Converts the specified cooked value and clamps it (max/min)

Parameters

cookedValue	Value to convert, can be string
typeValue	Converted value, correctly typed and clamped

Returns: false: Convertion failed

Definition at line 501 of file FactMetaData.cc.

References type(), valueTypeBool, valueTypeCustom, valueTypeDouble, valueTypeElapsedTimeInSeconds, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeString, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

Referenced by Fact::clamp().

◆ convertAndValidateCooked()

bool FactMetaData::convertAndValidateCooked	(	const QVariant &	cookedValue,
		bool	convertOnly,
		QVariant &	typedValue,
		QString &	errorString
	)		const

Same as convertAndValidateRaw except for cookedValue input.

Definition at line 413 of file FactMetaData.cc.

References cookedMax(), cookedMin(), errorString, type(), valueTypeBool, valueTypeCustom, valueTypeDouble, valueTypeElapsedTimeInSeconds, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeString, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

Referenced by Fact::validate().

◆ convertAndValidateRaw()

bool FactMetaData::convertAndValidateRaw	(	const QVariant &	rawValue,
		bool	convertOnly,
		QVariant &	typedValue,
		QString &	errorString
	)		const

Converts the specified raw value, validating against meta data

Parameters

rawValue	Value to convert, can be string
convertOnly	true: convert to correct type only, do not validate against meta data
typeValue	Converted value, correctly typed
errorString	Error string if convert fails, values are cooked values since user visible

Returns: false: Convert failed, errorString set

Definition at line 332 of file FactMetaData.cc.

References errorString, rawMax(), rawMin(), type(), valueTypeBool, valueTypeCustom, valueTypeDouble, valueTypeElapsedTimeInSeconds, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeString, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

Referenced by createFromJsonObject(), Fact::forceSetRawValue(), ParameterMetaData::setBitmaskFromPairs(), ParameterMetaData::setEnumFromPairs(), ParameterMetaData::setRawConvertedValue(), Fact::setRawValue(), and SettingsFact::SettingsFact().

◆ cookedDefaultValue()

QVariant FactMetaData::cookedDefaultValue ( ) const

inline

Definition at line 119 of file FactMetaData.h.

References rawDefaultValue().

Referenced by Fact::cookedDefaultValue().

◆ cookedIncrement()

double FactMetaData::cookedIncrement ( ) const

Definition at line 1128 of file FactMetaData.cc.

References rawIncrement().

Referenced by Fact::cookedIncrement().

◆ cookedMax()

QVariant FactMetaData::cookedMax ( ) const

Definition at line 1477 of file FactMetaData.cc.

Referenced by convertAndValidateCooked(), and Fact::cookedMax().

◆ cookedMin()

QVariant FactMetaData::cookedMin ( ) const

Definition at line 1483 of file FactMetaData.cc.

Referenced by convertAndValidateCooked(), and Fact::cookedMin().

◆ cookedTranslator()

Translator FactMetaData::cookedTranslator ( ) const

inline

Definition at line 157 of file FactMetaData.h.

Referenced by Fact::setCookedValue().

◆ cookedUnits()

QString FactMetaData::cookedUnits ( ) const

inline

Definition at line 143 of file FactMetaData.h.

Referenced by Fact::cookedUnits().

◆ cookedUserMax()

QVariant FactMetaData::cookedUserMax ( ) const

Definition at line 1609 of file FactMetaData.cc.

Referenced by Fact::cookedUserMax().

◆ cookedUserMin()

QVariant FactMetaData::cookedUserMin ( ) const

Definition at line 1600 of file FactMetaData.cc.

Referenced by Fact::cookedUserMin().

◆ createFromJsonObject()

FactMetaData * FactMetaData::createFromJsonObject	(	const QJsonObject &	json,
		const QMap< QString, QString > &	defineMap,
		QObject *	metaDataParent
	)

static

◆ createMapFromJsonArray()

QMap< QString, FactMetaData * > FactMetaData::createMapFromJsonArray	(	const QJsonArray &	jsonArray,
		const DefineMap_t &	defineMap,
		QObject *	metaDataParent
	)

static

Definition at line 1455 of file FactMetaData.cc.

References createFromJsonObject(), and name().

Referenced by FactGroup::_loadFromJsonArray(), and createMapFromJsonFile().

◆ createMapFromJsonFile()

QMap< QString, FactMetaData * > FactMetaData::createMapFromJsonFile	(	const QString &	jsonFilename,
		QObject *	metaDataParent
	)

static

Definition at line 1424 of file FactMetaData.cc.

References createMapFromJsonArray(), errorString, JsonParsing::openInternalQGCJsonFile(), qgcFileType, and JsonParsing::validateKeys().

Referenced by CameraSection::CameraSection(), FactGroup::FactGroup(), GeoFenceController::GeoFenceController(), MissionSettingsItem::MissionSettingsItem(), RCToParamDialogController::RCToParamDialogController(), SettingsGroup::SettingsGroup(), SpeedSection::SpeedSection(), and TransformPositionController::TransformPositionController().

◆ decimalPlaces()

int FactMetaData::decimalPlaces ( ) const

Definition at line 1133 of file FactMetaData.cc.

References kDefaultDecimalPlaces, kUnknownDecimalPlaces, and rawIncrement().

Referenced by Fact::decimalPlaces(), and setDecimalPlaces().

◆ defaultCategory()

static const QString FactMetaData::defaultCategory ( )

inlinestatic

Definition at line 110 of file FactMetaData.h.

References kDefaultCategory.

Referenced by PX4ParameterMetaData::_postProcessMetaData().

◆ defaultGroup()

static const QString FactMetaData::defaultGroup ( )

inlinestatic

Definition at line 111 of file FactMetaData.h.

References kDefaultGroup.

◆ defaultValueAvailable()

bool FactMetaData::defaultValueAvailable ( ) const

inline

Definition at line 120 of file FactMetaData.h.

Referenced by Fact::cookedDefaultValue(), Fact::defaultValueAvailable(), Fact::Fact(), Fact::rawDefaultValue(), Fact::setMetaData(), SettingsFact::SettingsFact(), and Fact::valueEqualsDefault().

◆ enumStrings()

QStringList FactMetaData::enumStrings ( ) const

inline

Definition at line 123 of file FactMetaData.h.

Referenced by Fact::enumOrValueString(), Fact::enumStrings(), Fact::enumStringValue(), and Fact::valueIndex().

◆ enumValues()

QVariantList FactMetaData::enumValues ( ) const

inline

Definition at line 124 of file FactMetaData.h.

Referenced by Fact::enumIndex(), Fact::enumValues(), Fact::setEnumIndex(), and Fact::setEnumStringValue().

◆ gramsToAppSettingsWeightUnits()

QVariant FactMetaData::gramsToAppSettingsWeightUnits ( const QVariant & grams )

static

Converts from grams to the user specified weight unit.

Definition at line 1080 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::gramsToAppSettingsWeightUnits().

◆ group()

QString FactMetaData::group ( ) const

inline

Definition at line 126 of file FactMetaData.h.

Referenced by Fact::group(), and setGroup().

◆ hasControl()

bool FactMetaData::hasControl ( ) const

inline

Definition at line 146 of file FactMetaData.h.

Referenced by Fact::hasControl().

◆ label()

QString FactMetaData::label ( ) const

inline

Definition at line 139 of file FactMetaData.h.

Referenced by SettingsGroup::_createSettingsFact(), Fact::label(), and setLabel().

◆ longDescription()

QString FactMetaData::longDescription ( ) const

inline

Definition at line 127 of file FactMetaData.h.

Referenced by PX4ParameterMetaData::_postProcessMetaData(), Fact::longDescription(), and setLongDescription().

◆ maxForType()

QVariant FactMetaData::maxForType ( ValueType_t type )

static

Definition at line 298 of file FactMetaData.cc.

References type(), valueTypeBool, valueTypeCustom, valueTypeDouble, valueTypeElapsedTimeInSeconds, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeString, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

◆ maxIsDefaultForType()

bool FactMetaData::maxIsDefaultForType ( ) const

inline

Definition at line 130 of file FactMetaData.h.

Referenced by Fact::maxIsDefaultForType().

◆ metersSecondToAppSettingsSpeedUnits()

QVariant FactMetaData::metersSecondToAppSettingsSpeedUnits ( const QVariant & metersSecond )

static

Converts from meters/second to the user specified speed unit.

Definition at line 1098 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::metersSecondToAppSettingsSpeedUnits().

◆ metersToAppSettingsHorizontalDistanceUnits()

QVariant FactMetaData::metersToAppSettingsHorizontalDistanceUnits ( const QVariant & meters )

static

Converts from meters to the user specified horizontal distance unit.

Definition at line 980 of file FactMetaData.cc.

Referenced by Vehicle::guidedModeGotoLocation(), and QmlUnitsConversion::metersToAppSettingsHorizontalDistanceUnits().

◆ metersToAppSettingsVerticalDistanceUnits()

QVariant FactMetaData::metersToAppSettingsVerticalDistanceUnits ( const QVariant & meters )

static

Converts from meters to the user specified vertical distance unit.

Definition at line 990 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::metersToAppSettingsVerticalDistanceUnits().

◆ minForType()

QVariant FactMetaData::minForType ( ValueType_t type )

static

Definition at line 263 of file FactMetaData.cc.

References type(), valueTypeBool, valueTypeCustom, valueTypeDouble, valueTypeElapsedTimeInSeconds, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeString, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

◆ minIsDefaultForType()

bool FactMetaData::minIsDefaultForType ( ) const

inline

Definition at line 133 of file FactMetaData.h.

Referenced by Fact::minIsDefaultForType().

◆ name()

QString FactMetaData::name ( ) const

inline

◆ operator=()

const FactMetaData & FactMetaData::operator= ( const FactMetaData & other )

Definition at line 89 of file FactMetaData.cc.

◆ qgcRebootRequired()

bool FactMetaData::qgcRebootRequired ( ) const

inline

Definition at line 145 of file FactMetaData.h.

Referenced by createFromJsonObject(), and Fact::qgcRebootRequired().

◆ rawDefaultValue()

QVariant FactMetaData::rawDefaultValue ( ) const

Definition at line 123 of file FactMetaData.cc.

Referenced by cookedDefaultValue(), Fact::Fact(), Fact::rawDefaultValue(), setRawDefaultValue(), SettingsFact::SettingsFact(), and Fact::valueEqualsDefault().

◆ rawIncrement()

double FactMetaData::rawIncrement ( ) const

inline

Amount to increment value when used in controls such as spin button or slider with detents. NaN for no increment available.

Definition at line 153 of file FactMetaData.h.

Referenced by cookedIncrement(), decimalPlaces(), and Fact::rawIncrement().

◆ rawMax()

QVariant FactMetaData::rawMax ( ) const

inline

Definition at line 128 of file FactMetaData.h.

Referenced by convertAndValidateRaw(), Fact::rawMax(), and setRawMax().

◆ rawMin()

QVariant FactMetaData::rawMin ( ) const

inline

Definition at line 131 of file FactMetaData.h.

Referenced by convertAndValidateRaw(), Fact::rawMin(), setRawMin(), and VTOLLandingComplexItem::VTOLLandingComplexItem().

◆ rawTranslator()

Translator FactMetaData::rawTranslator ( ) const

inline

Definition at line 156 of file FactMetaData.h.

Referenced by Fact::containerSetRawValue(), Fact::cookedValue(), Fact::forceSetRawValue(), and Fact::setRawValue().

◆ rawUnits()

QString FactMetaData::rawUnits ( ) const

inline

Definition at line 142 of file FactMetaData.h.

Referenced by Fact::rawUnits(), and setRawUnits().

◆ rawUserMax()

QVariant FactMetaData::rawUserMax ( ) const

inline

Definition at line 135 of file FactMetaData.h.

Referenced by Fact::rawUserMax(), and setRawUserMax().

◆ rawUserMin()

QVariant FactMetaData::rawUserMin ( ) const

inline

Definition at line 134 of file FactMetaData.h.

Referenced by Fact::rawUserMin(), and setRawUserMin().

◆ readOnly()

bool FactMetaData::readOnly ( ) const

inline

Definition at line 147 of file FactMetaData.h.

Referenced by createFromJsonObject(), and Fact::readOnly().

◆ removeEnumInfo()

void FactMetaData::removeEnumInfo ( const QVariant & value )

Used to remove values from the enum lists after the meta data has been loaded.

Definition at line 600 of file FactMetaData.cc.

◆ setBitmaskInfo()

void FactMetaData::setBitmaskInfo	(	const QStringList &	strings,
		const QVariantList &	values
	)

Definition at line 564 of file FactMetaData.cc.

References setBuiltInTranslator().

Referenced by SettingsManager::adjustSettingMetaData(), and ParameterMetaData::setBitmaskFromPairs().

◆ setBuiltInTranslator()

void FactMetaData::setBuiltInTranslator ( )

Set the translators to the standard built in versions.

Definition at line 618 of file FactMetaData.cc.

References setTranslators().

Referenced by setBitmaskInfo(), setEnumInfo(), and setRawUnits().

◆ setCategory()

void FactMetaData::setCategory ( const QString & category )

inline

Definition at line 172 of file FactMetaData.h.

References category().

Referenced by APMParameterMetaData::_createDefaultMetaData(), PX4ParameterMetaData::_postProcessMetaData(), and createFromJsonObject().

◆ setCustomCookedValidator()

void FactMetaData::setCustomCookedValidator ( CustomCookedValidator customValidator )

inline

Sets a custom cooked validator function for this metadata. The custom validator will be called prior to the standard validator when convertAndValidateCooked is called.

Definition at line 215 of file FactMetaData.h.

◆ setDecimalPlaces()

void FactMetaData::setDecimalPlaces ( int decimalPlaces )

inline

Definition at line 168 of file FactMetaData.h.

References decimalPlaces().

Referenced by APMParameterMetaData::_postProcessMetaData(), SettingsManager::adjustSettingMetaData(), createFromJsonObject(), and Mixer::ChannelConfig::instantiate().

◆ setEnumInfo()

void FactMetaData::setEnumInfo	(	const QStringList &	strings,
		const QVariantList &	values
	)

Definition at line 582 of file FactMetaData.cc.

References setBuiltInTranslator().

Referenced by SettingsManager::adjustSettingMetaData(), Mixer::ChannelConfigInstanceVirtualAxis::allInstancesInitialized(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), ParameterMetaData::setEnumFromPairs(), and Fact::setEnumInfo().

◆ setGroup()

void FactMetaData::setGroup ( const QString & group )

inline

Definition at line 173 of file FactMetaData.h.

References group().

Referenced by APMParameterMetaData::_createDefaultMetaData(), and createFromJsonObject().

◆ setHasControl()

void FactMetaData::setHasControl ( bool bValue )

inline

Definition at line 186 of file FactMetaData.h.

Referenced by createFromJsonObject().

◆ setLabel()

void FactMetaData::setLabel ( const QString & label )

inline

Definition at line 180 of file FactMetaData.h.

References label().

Referenced by createFromJsonObject(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), and DECLARE_SETTINGSFACT_NO_FUNC().

◆ setLongDescription()

void FactMetaData::setLongDescription ( const QString & longDescription )

inline

Definition at line 174 of file FactMetaData.h.

References longDescription().

Referenced by PX4ParameterMetaData::_postProcessMetaData(), SettingsManager::adjustSettingMetaData(), and createFromJsonObject().

◆ setName()

void FactMetaData::setName ( const QString & name )

inline

Definition at line 179 of file FactMetaData.h.

References name().

Referenced by DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), and DECLARE_SETTINGSFACT_NO_FUNC().

◆ setQGCRebootRequired()

void FactMetaData::setQGCRebootRequired ( bool rebootRequired )

inline

Definition at line 184 of file FactMetaData.h.

Referenced by createFromJsonObject(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), and DECLARE_SETTINGSFACT_NO_FUNC().

◆ setRawDefaultValue()

void FactMetaData::setRawDefaultValue ( const QVariant & rawDefaultValue )

Definition at line 133 of file FactMetaData.cc.

References name(), rawDefaultValue(), type(), and valueTypeString.

Referenced by QGCCorePlugin::adjustSettingMetaData(), SettingsManager::adjustSettingMetaData(), createFromJsonObject(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), and DECLARE_SETTINGSFACT_NO_FUNC().

◆ setRawIncrement()

void FactMetaData::setRawIncrement ( double increment )

inline

Definition at line 185 of file FactMetaData.h.

Referenced by createFromJsonObject().

◆ setRawMax()

void FactMetaData::setRawMax ( const QVariant & rawMax )

Definition at line 164 of file FactMetaData.cc.

References name(), rawMax(), and type().

Referenced by APMParameterMetaData::_lookupMetaData(), SettingsManager::adjustSettingMetaData(), and createFromJsonObject().

◆ setRawMin()

void FactMetaData::setRawMin ( const QVariant & rawMin )

Definition at line 147 of file FactMetaData.cc.

References name(), rawMin(), and type().

Referenced by APMParameterMetaData::_lookupMetaData(), SettingsManager::adjustSettingMetaData(), and createFromJsonObject().

◆ setRawUnits()

void FactMetaData::setRawUnits ( const QString & rawUnits )

Definition at line 835 of file FactMetaData.cc.

References rawUnits(), and setBuiltInTranslator().

Referenced by createFromJsonObject().

◆ setRawUserMax()

void FactMetaData::setRawUserMax ( const QVariant & rawUserMax )

Definition at line 194 of file FactMetaData.cc.

References name(), rawUserMax(), and type().

Referenced by APMParameterMetaData::_lookupMetaData(), and createFromJsonObject().

◆ setRawUserMin()

void FactMetaData::setRawUserMin ( const QVariant & rawUserMin )

Definition at line 181 of file FactMetaData.cc.

References name(), rawUserMin(), and type().

Referenced by APMParameterMetaData::_lookupMetaData(), and createFromJsonObject().

◆ setReadOnly()

void FactMetaData::setReadOnly ( bool bValue )

inline

Definition at line 187 of file FactMetaData.h.

Referenced by PX4ParameterMetaData::_postProcessMetaData(), createFromJsonObject(), and Mixer::ChannelConfig::instantiate().

◆ setShortDescription()

void FactMetaData::setShortDescription ( const QString & shortDescription )

inline

Definition at line 181 of file FactMetaData.h.

References shortDescription().

Referenced by PX4ParameterMetaData::_postProcessMetaData(), ArduSubFirmwarePlugin::adjustMetaData(), SettingsManager::adjustSettingMetaData(), createFromJsonObject(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), DECLARE_SETTINGSFACT_NO_FUNC(), and DECLARE_SETTINGSFACT_NO_FUNC().

◆ setTranslators()

void FactMetaData::setTranslators	(	Translator	rawTranslator_,
		Translator	cookedTranslator_
	)

Definition at line 612 of file FactMetaData.cc.

Referenced by setBuiltInTranslator().

◆ setVehicleRebootRequired()

void FactMetaData::setVehicleRebootRequired ( bool rebootRequired )

inline

Definition at line 183 of file FactMetaData.h.

Referenced by ParameterEditorController::buildDiffFromFile(), and createFromJsonObject().

◆ setVolatileValue()

void FactMetaData::setVolatileValue ( bool bValue )

Definition at line 1489 of file FactMetaData.cc.

Referenced by createFromJsonObject().

◆ setWriteOnly()

void FactMetaData::setWriteOnly ( bool bValue )

inline

Definition at line 188 of file FactMetaData.h.

◆ shortDescription()

QString FactMetaData::shortDescription ( ) const

inline

Definition at line 140 of file FactMetaData.h.

Referenced by PX4ParameterMetaData::_postProcessMetaData(), setShortDescription(), and Fact::shortDescription().

◆ splitTranslatedList()

QStringList FactMetaData::splitTranslatedList ( const QString & translatedList )

static

Definition at line 1494 of file FactMetaData.cc.

Referenced by MissionCommandUIInfo::loadJsonInfo().

◆ squareMetersToAppSettingsAreaUnits()

QVariant FactMetaData::squareMetersToAppSettingsAreaUnits ( const QVariant & squareMeters )

static

Converts from meters to the user specified distance unit.

Definition at line 1050 of file FactMetaData.cc.

Referenced by QmlUnitsConversion::squareMetersToAppSettingsAreaUnits().

◆ stringToType()

FactMetaData::ValueType_t FactMetaData::stringToType	(	const QString &	typeString,
		bool &	unknownType
	)

static

Definition at line 843 of file FactMetaData.cc.

References valueTypeDouble.

Referenced by createFromJsonObject().

◆ type()

ValueType_t FactMetaData::type ( ) const

inline

Definition at line 141 of file FactMetaData.h.

Referenced by APMParameterMetaData::_postProcessMetaData(), SettingsManager::adjustSettingMetaData(), clampValue(), convertAndValidateCooked(), convertAndValidateRaw(), createFromJsonObject(), maxForType(), minForType(), setRawDefaultValue(), setRawMax(), setRawMin(), setRawUserMax(), setRawUserMin(), typeToSize(), and typeToString().

◆ typeToSize()

size_t FactMetaData::typeToSize ( ValueType_t type )

static

Definition at line 869 of file FactMetaData.cc.

References MAVLINK_MSG_PARAM_EXT_SET_FIELD_PARAM_VALUE_LEN, type(), valueTypeCustom, valueTypeDouble, valueTypeFloat, valueTypeInt16, valueTypeInt32, valueTypeInt64, valueTypeInt8, valueTypeUint16, valueTypeUint32, valueTypeUint64, and valueTypeUint8.

◆ typeToString()

QString FactMetaData::typeToString ( ValueType_t type )

static

Definition at line 858 of file FactMetaData.cc.

References type().

Referenced by SettingsManager::adjustSettingMetaData().

◆ vehicleRebootRequired()

bool FactMetaData::vehicleRebootRequired ( ) const

inline

Definition at line 144 of file FactMetaData.h.

Referenced by ParameterEditorController::buildDiffFromFile(), and Fact::vehicleRebootRequired().

◆ volatileValue()

bool FactMetaData::volatileValue ( ) const

inline

Definition at line 149 of file FactMetaData.h.

Referenced by PX4ParameterMetaData::_postProcessMetaData(), createFromJsonObject(), and Fact::volatileValue().

◆ writeOnly()

bool FactMetaData::writeOnly ( ) const

inline

Definition at line 148 of file FactMetaData.h.

Referenced by Fact::writeOnly().

Friends And Related Symbol Documentation

◆ SettingsManager

friend class SettingsManager

friend

Definition at line 21 of file FactMetaData.h.

Member Data Documentation

◆ kDefaultCategory

constexpr const char* FactMetaData::kDefaultCategory = QT_TRANSLATE_NOOP("FactMetaData", "Other")

staticconstexpr

Definition at line 227 of file FactMetaData.h.

Referenced by defaultCategory().

◆ kDefaultDecimalPlaces

constexpr int FactMetaData::kDefaultDecimalPlaces = 3

staticconstexpr

Default value for decimal places if not specified/known.

Definition at line 217 of file FactMetaData.h.

Referenced by Fact::decimalPlaces(), and decimalPlaces().

◆ kDefaultGroup

constexpr const char* FactMetaData::kDefaultGroup = QT_TRANSLATE_NOOP("FactMetaData", "Misc")

staticconstexpr

Definition at line 228 of file FactMetaData.h.

Referenced by defaultGroup().

◆ kUnknownDecimalPlaces

constexpr int FactMetaData::kUnknownDecimalPlaces = -1

staticconstexpr

Number of decimal places to specify is not known.

Definition at line 218 of file FactMetaData.h.

Referenced by createFromJsonObject(), decimalPlaces(), and MissionCommandUIInfo::loadJsonInfo().

◆ qgcFileType

constexpr const char* FactMetaData::qgcFileType = "FactMetaData"

staticconstexpr

Definition at line 229 of file FactMetaData.h.

Referenced by createMapFromJsonFile().

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

src/FactSystem/FactMetaData.h
src/FactSystem/FactMetaData.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CustomCookedValidator

◆ DefineMap_t

◆ NameToMetaDataMap_t

◆ Translator

Member Enumeration Documentation

◆ ValueType_t

Constructor & Destructor Documentation

◆ FactMetaData() [1/4]

◆ FactMetaData() [2/4]

◆ FactMetaData() [3/4]

◆ FactMetaData() [4/4]

◆ ~FactMetaData()

Member Function Documentation

◆ addBitmaskInfo()

◆ addEnumInfo()

◆ appSettingsAreaUnitsString()

◆ appSettingsAreaUnitsToSquareMeters()

◆ appSettingsHorizontalDistanceUnitsString()

◆ appSettingsHorizontalDistanceUnitsToMeters()

◆ appSettingsSpeedUnitsString()

◆ appSettingsSpeedUnitsToMetersSecond()

◆ appSettingsVerticalDistanceUnitsString()

◆ appSettingsVerticalDistanceUnitsToMeters()

◆ appSettingsWeightUnitsString()

◆ appSettingsWeightUnitsToGrams()

◆ bitmaskStrings()

◆ bitmaskValues()

◆ category()

◆ clampValue()

◆ convertAndValidateCooked()

◆ convertAndValidateRaw()

◆ cookedDefaultValue()

◆ cookedIncrement()

◆ cookedMax()

◆ cookedMin()

◆ cookedTranslator()

◆ cookedUnits()

◆ cookedUserMax()

◆ cookedUserMin()

◆ createFromJsonObject()

◆ createMapFromJsonArray()

◆ createMapFromJsonFile()

◆ decimalPlaces()

◆ defaultCategory()

◆ defaultGroup()

◆ defaultValueAvailable()

◆ enumStrings()

◆ enumValues()

◆ gramsToAppSettingsWeightUnits()

◆ group()

◆ hasControl()

◆ label()

◆ longDescription()

◆ maxForType()

◆ maxIsDefaultForType()

◆ metersSecondToAppSettingsSpeedUnits()

◆ metersToAppSettingsHorizontalDistanceUnits()

◆ metersToAppSettingsVerticalDistanceUnits()

◆ minForType()

◆ minIsDefaultForType()

◆ name()

◆ operator=()

◆ qgcRebootRequired()

◆ rawDefaultValue()

◆ rawIncrement()

◆ rawMax()

◆ rawMin()

◆ rawTranslator()

◆ rawUnits()

◆ rawUserMax()

◆ rawUserMin()

◆ readOnly()

◆ removeEnumInfo()