Group of closely related downloadable items. More...

#include <Downloadable_MultiFile.h>

Inheritance diagram for DataManagement::Downloadable_MultiFile:

Public Types
enum	UpdatePolicy : quint8 { SingleUpdate , MultiUpdate }
	Update Policy. More...

Public Types inherited from DataManagement::Downloadable_Abstract
enum	ContentType : quint8 { VAC , AviationMap , BaseMapVector , BaseMapRaster , Data , MapSet , TerrainMap }
	Type of content managed by this instance. More...

Signals
void	downloadablesChanged ()
	Notifier signal.

Signals inherited from DataManagement::Downloadable_Abstract
void	boundingBoxChanged ()
	Notifier signal.

void	contentTypeChanged ()
	Notifier signal.

void	descriptionChanged ()
	Notifier signal.

void	downloadingChanged ()
	Notifier signal.

void	error (QString objectName, QString message)
	Download error.

void	fileContentChanged ()
	Indicates that the content of a local file (or several local files) has changed.

void	fileContentChanged_delayed ()
	Emitted some time after the content of one of the local files changes.

void	filesChanged ()
	Notifier signal.

void	hasFileChanged ()
	Notifier signal.

void	infoTextChanged ()
	Notifier signal.

void	remoteFileSizeChanged ()
	Notifier signal.

void	sectionChanged ()
	Notifier signal.

void	updateSizeChanged ()
	Notifier signal.

Public Member Functions
	Downloadable_MultiFile (DataManagement::Downloadable_MultiFile::UpdatePolicy updatePolicy, QObject *parent=nullptr)
	Standard constructor.

auto	description () -> QString override
	Implementation of pure virtual getter method from Downloadable_Abstract.

QVector< DataManagement::Downloadable_Abstract * >	downloadables ()
	Getter function for the property with the same name.

auto	downloading () -> bool override
	Implementation of pure virtual getter method from Downloadable_Abstract.

auto	files () -> QStringList override
	Implementation of pure virtual getter method from Downloadable_Abstract.

auto	infoText () -> QString override
	Implementation of pure virtual getter method from Downloadable_Abstract.

auto	remoteFileSize () -> qint64 override
	Getter function for the property with the same name.

auto	updateSize () -> Units::ByteSize override
	Implementation of pure virtual getter method from Downloadable_Abstract.

Q_INVOKABLE void	add (DataManagement::Downloadable_Abstract *map)
	Add a Downloadable_SingleFile to this Downloadable_MultiFile.

Q_INVOKABLE void	add (const QVector< DataManagement::Downloadable_Abstract * > &maps)
	Add 'Downloadable_SingleFile's to this Downloadable_MultiFile.

Q_INVOKABLE void	clear ()
	Removes all children.

Q_INVOKABLE void	deleteFiles () override
	Implementation of pure virtual method from Downloadable_Abstract.

Q_INVOKABLE QList< DataManagement::Downloadable_Abstract * >	downloadables4Location (const QGeoCoordinate &location)
	Downloadables for a given location.

Q_INVOKABLE QList< DataManagement::Downloadable_Abstract * >	downloadablesByDistance (const QGeoCoordinate &location)
	Downloadables, sorted by distance to a given location.

Q_INVOKABLE void	remove (DataManagement::Downloadable_Abstract *map)
	Remove a Downloadable_SingleFile from this Downloadable_MultiFile.

Q_INVOKABLE void	startDownload () override
	Implementation of pure virtual method from Downloadable_Abstract.

Q_INVOKABLE void	stopDownload () override
	Implementation of pure virtual method from Downloadable_Abstract.

Q_INVOKABLE void	update () override
	Implementation of pure virtual method from Downloadable_Abstract.

Public Member Functions inherited from DataManagement::Downloadable_Abstract
	Downloadable_Abstract (QObject *parent=nullptr)
	Standard constructor.

QGeoRectangle	boundingBox () const
	Getter method for the property with the same name.

DataManagement::Downloadable_Abstract::ContentType	contentType () const
	Getter method for the property with the same name.

bool	hasFile () const
	Getter method for the property with the same name.

QBindable< bool >	bindableHasFile () const
	Getter method for the property with the same name.

QString	section () const
	Getter function for the property with the same name.

QBindable< QString >	bindableSection () const
	Getter function for the property with the same name.

virtual auto	updateSizeString () -> QString
	Getter function for the property with the same name.

void	setBoundingBox (const QGeoRectangle &boundingBox)
	Setter function for the property with the same name.

void	setContentType (DataManagement::Downloadable_Abstract::ContentType contentType)
	Setter function for the property with the same name.

void	setSection (const QString &sectionName)
	Setter function for the property with the same name.

Q_INVOKABLE void	killFileContentChanged_delayed ()
	Kill pending emission of signal fileContentChanged_delayed.

Properties
QVector< DataManagement::Downloadable_Abstract * >	downloadables
	List of Downloadables in this group.

Properties inherited from DataManagement::Downloadable_Abstract
QGeoRectangle	boundingBox
	Geographic bounding box.

DataManagement::Downloadable_Abstract::ContentType	contentType
	Most probable content of file(s) managed by this object.

QString	description
	Describe installed file(s)

bool	downloading
	Indicates whether a download process is currently running.

QStringList	files
	Names of all files that have been downloaded by any of the Downloadble objects in this group (and their children)

bool	hasFile
	Indicates if (at least one) local file exists.

QString	infoText
	Short info text describing the state of the downloadable(s)

qint64	remoteFileSize
	Size of the remote file.

QString	section
	Headline name for the Downloadable.

Units::ByteSize	updateSize
	Update size.

QString	updateSizeString
	Update size as a localized string.

Detailed Description

Group of closely related downloadable items.

This class implements a group of Downloadable_Abstract objects.

Definition at line 35 of file Downloadable_MultiFile.h.

Member Enumeration Documentation

◆ UpdatePolicy

enum DataManagement::Downloadable_MultiFile::UpdatePolicy : quint8

Update Policy.

Enumerator
SingleUpdate	Update children that are updatable.
MultiUpdate	Update children that are updatable. If one local file exist, download all other files on update.

Definition at line 42 of file Downloadable_MultiFile.h.

Constructor & Destructor Documentation

◆ Downloadable_MultiFile()

DataManagement::Downloadable_MultiFile::Downloadable_MultiFile	(	DataManagement::Downloadable_MultiFile::UpdatePolicy	updatePolicy,
		QObject *	parent = nullptr )

explicit

Standard constructor.

Parameters

updatePolicy	Update policy of this instance
parent	The standard QObject parent pointer.

Member Function Documentation

◆ add() [1/2]

Q_INVOKABLE void DataManagement::Downloadable_MultiFile::add ( const QVector< DataManagement::Downloadable_Abstract * > & maps )

Add 'Downloadable_SingleFile's to this Downloadable_MultiFile.

This method differs from add(DataManagement::Downloadable_Abstract* map) only in that it adds several maps, but emits notifier signals only once.

Parameters

maps	Maps to be added

◆ add() [2/2]

Q_INVOKABLE void DataManagement::Downloadable_MultiFile::add ( DataManagement::Downloadable_Abstract * map )

Add a Downloadable_SingleFile to this Downloadable_MultiFile.

This method copies the values of map->objectName and map->section into *this object. As a result, these properties are always set to match those of the last map added. This instance does not take ownership of the map.

It is perfectly possible that a map is a child of more than one Downloadable_MultiFile.

Parameters

map	Map to be added

◆ description()

auto DataManagement::Downloadable_MultiFile::description ( ) -> QString

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property description

Implements DataManagement::Downloadable_Abstract.

◆ downloadables()

QVector< DataManagement::Downloadable_Abstract * > DataManagement::Downloadable_MultiFile::downloadables ( )

nodiscard

Getter function for the property with the same name.

Returns: Property downloadables

◆ downloadables4Location()

Q_INVOKABLE QList< DataManagement::Downloadable_Abstract * > DataManagement::Downloadable_MultiFile::downloadables4Location ( const QGeoCoordinate & location )

nodiscard

Downloadables for a given location.

Parameters

location QGeoCoordinate with a location

Returns: list of downloadables whose bounding box contains the given location

◆ downloadablesByDistance()

Q_INVOKABLE QList< DataManagement::Downloadable_Abstract * > DataManagement::Downloadable_MultiFile::downloadablesByDistance ( const QGeoCoordinate & location )

nodiscard

Downloadables, sorted by distance to a given location.

Parameters

location QGeoCoordinate with a location

Returns: list of downloadables whose bounding box contains the given location

◆ downloading()

auto DataManagement::Downloadable_MultiFile::downloading ( ) -> bool

inlinenodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property downloading

Implements DataManagement::Downloadable_Abstract.

Definition at line 94 of file Downloadable_MultiFile.h.

◆ files()

auto DataManagement::Downloadable_MultiFile::files ( ) -> QStringList

inlinenodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property files

Implements DataManagement::Downloadable_Abstract.

Definition at line 100 of file Downloadable_MultiFile.h.

◆ infoText()

auto DataManagement::Downloadable_MultiFile::infoText ( ) -> QString

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property infoText

Implements DataManagement::Downloadable_Abstract.

◆ remoteFileSize()

auto DataManagement::Downloadable_MultiFile::remoteFileSize ( ) -> qint64

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property remoteFileSize

Implements DataManagement::Downloadable_Abstract.

Definition at line 112 of file Downloadable_MultiFile.h.

◆ remove()

Q_INVOKABLE void DataManagement::Downloadable_MultiFile::remove ( DataManagement::Downloadable_Abstract * map )

Remove a Downloadable_SingleFile from this Downloadable_MultiFile.

Parameters

map	Map to be removed

◆ updateSize()

auto DataManagement::Downloadable_MultiFile::updateSize ( ) -> Units::ByteSize

inlinenodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property updateSize

Implements DataManagement::Downloadable_Abstract.

Definition at line 118 of file Downloadable_MultiFile.h.

Property Documentation

◆ downloadables

QVector<DataManagement::Downloadable_Abstract*> DataManagement::Downloadable_MultiFile::downloadables

read

List of Downloadables in this group.

This property holds a list of direct children of the instance. The list is sorted by section and object name, and never contains a zero pointer.

Definition at line 71 of file Downloadable_MultiFile.h.

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

/home/runner/work/enroute/enroute/src/dataManagement/Downloadable_MultiFile.h

Public Types

Signals

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ UpdatePolicy

Constructor & Destructor Documentation

◆ Downloadable_MultiFile()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ description()

◆ downloadables()

◆ downloadables4Location()

◆ downloadablesByDistance()

◆ downloading()

◆ files()

◆ infoText()

◆ remoteFileSize()

◆ remove()

◆ updateSize()

Property Documentation

◆ downloadables