QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
Signals | Public Member Functions | Protected Attributes | List of all members
PlanElementController Class Referenceabstract

#include <PlanElementController.h>

+ Inheritance diagram for PlanElementController:
+ Collaboration diagram for PlanElementController:

Signals

void supportedChanged (bool supported)
 
void containsItemsChanged ()
 
void syncInProgressChanged (bool syncInProgress)
 
void dirtyChanged (bool dirty)
 
void sendComplete (void)
 
void removeAllComplete (void)
 

Public Member Functions

 PlanElementController (PlanMasterController *masterController, QObject *parent=nullptr)
 
 ~PlanElementController ()
 
PlanMasterController *masterController READ masterController CONSTANT (bool supported READ supported NOTIFY supportedChanged) 1(bool containsItems READ containsItems NOTIFY containsItemsChanged) 1(bool syncInProgress READ syncInProgress NOTIFY syncInProgressChanged) 1(bool dirty READ dirty WRITE setDirty NOTIFY dirtyChanged) PlanMasterController *masterController(void)
 < true: Elemement is non-empty
 
virtual void start (bool flyView)
 Should be called immediately upon Component.onCompleted.
 
virtual void save (QJsonObject &json)=0
 
virtual bool load (const QJsonObject &json, QString &errorString)=0
 
virtual void loadFromVehicle (void)=0
 
virtual void removeAll (void)=0
 Removes all from controller only.
 
virtual bool showPlanFromManagerVehicle (void)=0
 
virtual bool supported (void) const =0
 true: controller is waiting for the current load to complete
 
virtual bool containsItems (void) const =0
 
virtual bool syncInProgress (void) const =0
 
virtual bool dirty (void) const =0
 
virtual void setDirty (bool dirty)=0
 
virtual void sendToVehicle (void)=0
 
virtual void removeAllFromVehicle (void)=0
 

Protected Attributes

PlanMasterController * _masterController
 
bool _flyView
 

Detailed Description

This is the abstract base clas for Plan Element controllers. Examples of plan elements are: missions (MissionController), geofence (GeoFenceController)

Definition at line 10 of file PlanElementController.h.

Constructor & Destructor Documentation

◆ PlanElementController()

PlanElementController::PlanElementController ( PlanMasterController *  masterController,
QObject *  parent = nullptr 
)

Definition at line 4 of file PlanElementController.cc.

◆ ~PlanElementController()

PlanElementController::~PlanElementController ( )

Definition at line 12 of file PlanElementController.cc.

Member Function Documentation

◆ CONSTANT()

PlanMasterController *masterController READ masterController PlanElementController::CONSTANT ( bool supported READ supported NOTIFY  supportedChanged)
inline

< true: Elemement is non-empty

< true: information is currently being saved/sent, false: no active save/send in progress < true: unsaved/sent changes are present, false: no changes since last save/send

Parameters
supportedChangedtrue: Element is supported by Vehicle

Definition at line 19 of file PlanElementController.h.

References _masterController.

◆ containsItems()

virtual bool PlanElementController::containsItems ( void  ) const
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ containsItemsChanged

void PlanElementController::containsItemsChanged ( )
signal

Referenced by GeoFenceController::GeoFenceController(), and RallyPointController::RallyPointController().

◆ dirty()

virtual bool PlanElementController::dirty ( void  ) const
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ dirtyChanged

void PlanElementController::dirtyChanged ( bool  dirty)
signal

Referenced by GeoFenceController::setDirty(), and RallyPointController::setDirty().

◆ load()

virtual bool PlanElementController::load ( const QJsonObject &  json,
QString &  errorString 
)
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ loadFromVehicle()

virtual void PlanElementController::loadFromVehicle ( void  )
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ removeAll()

virtual void PlanElementController::removeAll ( void  )
pure virtual

Removes all from controller only.

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ removeAllComplete

void PlanElementController::removeAllComplete ( void  )
signal

◆ removeAllFromVehicle()

virtual void PlanElementController::removeAllFromVehicle ( void  )
pure virtual

Removes all from vehicle and controller Signals removeAllComplete when done

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ save()

virtual void PlanElementController::save ( QJsonObject &  json)
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ sendComplete

void PlanElementController::sendComplete ( void  )
signal

◆ sendToVehicle()

virtual void PlanElementController::sendToVehicle ( void  )
pure virtual

Sends the current plan element to the vehicle Signals sendComplete when done

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ setDirty()

virtual void PlanElementController::setDirty ( bool  dirty)
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ showPlanFromManagerVehicle()

virtual bool PlanElementController::showPlanFromManagerVehicle ( void  )
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ start()

void PlanElementController::start ( bool  flyView)
virtual

Should be called immediately upon Component.onCompleted.

Reimplemented in GeoFenceController, MissionController, and RallyPointController.

Definition at line 17 of file PlanElementController.cc.

References _flyView.

Referenced by GeoFenceController::start(), MissionController::start(), and RallyPointController::start().

◆ supported()

virtual bool PlanElementController::supported ( void  ) const
pure virtual

true: controller is waiting for the current load to complete

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ supportedChanged

void PlanElementController::supportedChanged ( bool  supported)
signal

◆ syncInProgress()

virtual bool PlanElementController::syncInProgress ( void  ) const
pure virtual

Implemented in GeoFenceController, MissionController, and RallyPointController.

◆ syncInProgressChanged

void PlanElementController::syncInProgressChanged ( bool  syncInProgress)
signal

Member Data Documentation

◆ _flyView

bool PlanElementController::_flyView
protected

Definition at line 60 of file PlanElementController.h.

Referenced by MissionController::currentMissionIndex(), MissionController::insertComplexMissionItem(), MissionController::insertComplexMissionItemFromKMLOrSHP(), MissionController::insertTakeoffItem(), MissionController::resumeMissionIndex(), GeoFenceController::showPlanFromManagerVehicle(), MissionController::showPlanFromManagerVehicle(), RallyPointController::showPlanFromManagerVehicle(), and start().

◆ _masterController

PlanMasterController* PlanElementController::_masterController
protected

Definition at line 59 of file PlanElementController.h.

Referenced by CONSTANT(), MissionController::insertComplexMissionItem(), MissionController::insertComplexMissionItemFromKMLOrSHP(), MissionController::insertTakeoffItem(), GeoFenceController::loadFromVehicle(), MissionController::loadFromVehicle(), RallyPointController::loadFromVehicle(), MissionController::multipleLandPatternsAllowed(), GeoFenceController::removeAllFromVehicle(), MissionController::removeAllFromVehicle(), RallyPointController::removeAllFromVehicle(), GeoFenceController::sendToVehicle(), MissionController::sendToVehicle(), RallyPointController::sendToVehicle(), MissionController::setCurrentPlanViewSeqNum(), GeoFenceController::showPlanFromManagerVehicle(), MissionController::showPlanFromManagerVehicle(), RallyPointController::showPlanFromManagerVehicle(), GeoFenceController::start(), MissionController::start(), and RallyPointController::start().

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