CompInfo Class Reference

Base class for all CompInfo types. More...

#include <CompInfo.h>

Inheritance diagram for CompInfo:

Collaboration diagram for CompInfo:

Public Member Functions
	CompInfo (COMP_METADATA_TYPE type_, uint8_t compId_, Vehicle *vehicle_, QObject *parent=nullptr)
const QString &	uriMetaData () const
const QString &	uriMetaDataFallback () const
const QString &	uriTranslation () const
uint32_t	crcMetaData () const
uint32_t	crcMetaDataFallback () const
bool	crcMetaDataValid () const
bool	crcMetaDataFallbackValid () const
void	setUriMetaData (const QString &uri, uint32_t crc)
virtual void	setJson (const QString &metaDataJsonFileName)=0
bool	available () const

Public Attributes
const COMP_METADATA_TYPE	type
Vehicle *const	vehicle = nullptr
const uint8_t	compId = MAV_COMP_ID_ALL

Friends
class	CompInfoGeneral

Detailed Description

Base class for all CompInfo types.

Definition at line 13 of file CompInfo.h.

Constructor & Destructor Documentation

CompInfo()

CompInfo::CompInfo	(	COMP_METADATA_TYPE	type_,
		uint8_t	compId_,
		Vehicle *	vehicle_,
		QObject *	parent = nullptr
	)

Definition at line 3 of file CompInfo.cc.

Member Function Documentation

available()

bool CompInfo::available ( ) const

inline

Definition at line 33 of file CompInfo.h.

crcMetaData()

uint32_t CompInfo::crcMetaData ( ) const

inline

Definition at line 24 of file CompInfo.h.

crcMetaDataFallback()

uint32_t CompInfo::crcMetaDataFallback ( ) const

inline

Definition at line 25 of file CompInfo.h.

crcMetaDataFallbackValid()

bool CompInfo::crcMetaDataFallbackValid ( ) const

inline

Definition at line 27 of file CompInfo.h.

crcMetaDataValid()

bool CompInfo::crcMetaDataValid ( ) const

inline

Definition at line 26 of file CompInfo.h.

setJson()

virtual void CompInfo::setJson ( const QString &  metaDataJsonFileName )

pure virtual

Implemented in CompInfoActuators, CompInfoEvents, CompInfoGeneral, and CompInfoParam.

setUriMetaData()

void CompInfo::setUriMetaData	(	const QString &	uri,
		uint32_t	crc
	)

Definition at line 12 of file CompInfo.cc.

uriMetaData()

const QString & CompInfo::uriMetaData ( ) const

inline

Definition at line 20 of file CompInfo.h.

uriMetaDataFallback()

const QString & CompInfo::uriMetaDataFallback ( ) const

inline

Definition at line 21 of file CompInfo.h.

uriTranslation()

const QString & CompInfo::uriTranslation ( ) const

inline

Definition at line 22 of file CompInfo.h.

Friends And Related Symbol Documentation

CompInfoGeneral

friend class CompInfoGeneral

friend

Definition at line 40 of file CompInfo.h.

Member Data Documentation

compId

const uint8_t CompInfo::compId = MAV_COMP_ID_ALL

Definition at line 37 of file CompInfo.h.

Referenced by CompInfoParam::factMetaDataForName(), CompInfoActuators::setJson(), CompInfoEvents::setJson(), CompInfoGeneral::setJson(), and CompInfoParam::setJson().

type

const COMP_METADATA_TYPE CompInfo::type

Definition at line 35 of file CompInfo.h.

Referenced by CompInfoGeneral::setUris(), and RequestMetaDataTypeStateMachine::typeToString().

vehicle

Vehicle* const CompInfo::vehicle = nullptr

Definition at line 36 of file CompInfo.h.

Referenced by CompInfoParam::factMetaDataForName(), CompInfoActuators::setJson(), and CompInfoEvents::setJson().

---

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

• src/Vehicle/ComponentInformation/CompInfo.h
• src/Vehicle/ComponentInformation/CompInfo.cc