Downloadable object. More...

#include <Downloadable_SingleFile.h>

Inheritance diagram for DataManagement::Downloadable_SingleFile:

Signals
void	aboutToChangeFile (QString localFileName)
	Warning that local file is about to change.

void	downloadProgressChanged (int percentage)
	Download progress.

void	remoteFileDateChanged ()
	Notifier signal for the properties remoteFileDate and remoteFileSize.

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_SingleFile (QUrl url, const QString &localFileName, const QGeoRectangle &bBox={}, QObject *parent=nullptr)
	Standard constructor.

	~Downloadable_SingleFile () override
	Standard destructor.

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

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

auto	downloadProgress () const -> int
	Getter function for the property with the same name.

auto	fileName () const -> QString
	Getter function for the property with the same name.

auto	fileContent () const -> QByteArray
	Getter function for the property with the same name.

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	remoteFileDate () const -> QDateTime
	Getter function for the property with the same name.

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.

auto	url () const -> QUrl
	Getter function for the property with the same name.

void	setRemoteFileDate (const QDateTime &date)
	Setter function for the property with the same name.

void	setRemoteFileSize (qint64 size)
	Setter function for the property with the same name.

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

Q_INVOKABLE void	startDownload () override
	Initiate a download.

Q_INVOKABLE void	startInfoDownload ()
	Contacts the server and downloads information about the remote file.

Q_INVOKABLE void	stopDownload () override
	Stops download process.

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
int	downloadProgress
	Download progress.

QString	fileName
	File name, as set in the constructor.

QByteArray	fileContent
	Content of the downloaded file.

QDateTime	remoteFileDate
	Modification date of the remote file.

qint64	remoteFileSize
	Size of the remote file.

QUrl	url
	URL, as set in the constructor.

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.

Additional Inherited Members
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...

Detailed Description

Downloadable object.

This class represents a downloadable item, such as an aviation map file. The class is able to do the following.

Download the file asynchronously from the server.
Check if a newer version of the file is available at the URL and update the file if desired.

The URL and the name of the local file are given in the constructor and cannot be changed. See the description of the method startDownload() to see how downloads work.

Definition at line 51 of file Downloadable_SingleFile.h.

Constructor & Destructor Documentation

◆ Downloadable_SingleFile()

DataManagement::Downloadable_SingleFile::Downloadable_SingleFile	(	QUrl	url,
		const QString &	localFileName,
		const QGeoRectangle &	bBox = {},
		QObject *	parent = nullptr )

explicit

Standard constructor.

Parameters

url	The address in the internet where the newest version of the item can always be found. This URL should be http or https because data about the remote file (such as modification time) can be retrieved with this protocol.
localFileName	Name of a local file where the download will be stored. If the file already exists, the constructor assumes that the file contains a previously downloaded version of the item, and that the modification time of the file is the download time.
bBox	Bounding box, if a meaningful notion of bounding box exists for this Downloadable.
parent	The standard QObject parent pointer.

After construction, size and modification time of the file on the server are not known and set to -1 and an invalid QDateTime, respectively. To obtain these pieces of data from the server, use the method checkForUpdate(). Alternatively, you can write to the properties remoteFileDate and remoteFileSize directly, e.g. to restore cached data when no internet connection is available.

Use the method startFileDownload() to initiate the download process.

◆ ~Downloadable_SingleFile()

DataManagement::Downloadable_SingleFile::~Downloadable_SingleFile ( )

override

Standard destructor.

This destructor will stop all running downloads and delete all temporary files. It will not delete the local file.

Member Function Documentation

◆ aboutToChangeFile

void DataManagement::Downloadable_SingleFile::aboutToChangeFile ( QString localFileName )

signal

Warning that local file is about to change.

This signal is emitted once the download finished, just before the local file is overwritten with new data. It indicates that all users should stop using the file immediately. This signal is always followed by the signal localFileChanged(), which indicates that the local file can be used again.

Parameters

localFileName Name of the local file that has will change

See also: localFileChanged()

◆ deleteFiles()

Q_INVOKABLE void DataManagement::Downloadable_SingleFile::deleteFiles ( )

overridevirtual

Implementation of pure virtual method from Downloadable_Abstract.

This method deletes the local file. The singals aboutToChangeLocalFile() and localFileChanged() are emitted appropriately, and a QLockFile is used at fileName()+".lock".

Implements DataManagement::Downloadable_Abstract.

◆ description()

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

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property description

Implements DataManagement::Downloadable_Abstract.

◆ downloading()

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

inlinenodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property downloading

Implements DataManagement::Downloadable_Abstract.

Definition at line 155 of file Downloadable_SingleFile.h.

◆ downloadProgress()

auto DataManagement::Downloadable_SingleFile::downloadProgress ( ) const -> int

inlinenodiscard

Getter function for the property with the same name.

Returns: Property downloadProgress

Definition at line 161 of file Downloadable_SingleFile.h.

◆ downloadProgressChanged

void DataManagement::Downloadable_SingleFile::downloadProgressChanged ( int percentage )

signal

Download progress.

While the download process is running, this signal is emitted at regular intervals, so the user can learn about the progress of the operation.

Parameters

percentage An integer between 0 and 100

◆ fileContent()

auto DataManagement::Downloadable_SingleFile::fileContent ( ) const -> QByteArray

nodiscard

Getter function for the property with the same name.

Returns: Property fileContent

◆ fileName()

auto DataManagement::Downloadable_SingleFile::fileName ( ) const -> QString

inlinenodiscard

Getter function for the property with the same name.

Returns: Property fileName

Definition at line 167 of file Downloadable_SingleFile.h.

◆ files()

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

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property files

Implements DataManagement::Downloadable_Abstract.

◆ infoText()

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

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property infoText

Implements DataManagement::Downloadable_Abstract.

◆ remoteFileDate()

auto DataManagement::Downloadable_SingleFile::remoteFileDate ( ) const -> QDateTime

inlinenodiscard

Getter function for the property with the same name.

Returns: Property remoteFileDate

Definition at line 191 of file Downloadable_SingleFile.h.

◆ remoteFileDateChanged

void DataManagement::Downloadable_SingleFile::remoteFileDateChanged ( )

signal

Notifier signal for the properties remoteFileDate and remoteFileSize.

This signal is emitted once one of the property remoteFileDate changes, either in response to a use of the setter methods, or because downloadRemoteFileData() has been called and data has been retrieved from the server.

◆ remoteFileSize()

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

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property remoteFileSize

Implements DataManagement::Downloadable_Abstract.

Definition at line 197 of file Downloadable_SingleFile.h.

◆ setRemoteFileDate()

void DataManagement::Downloadable_SingleFile::setRemoteFileDate ( const QDateTime & date )

Setter function for the property with the same name.

Parameters

date	Property remoteFileDate

◆ setRemoteFileSize()

void DataManagement::Downloadable_SingleFile::setRemoteFileSize ( qint64 size )

Setter function for the property with the same name.

Parameters

size	Property remoteFileSize

◆ startDownload()

Q_INVOKABLE void DataManagement::Downloadable_SingleFile::startDownload ( )

overridevirtual

Initiate a download.

Initiate an asynchronous download of the remote file. If a download is already in progress, nothing will happen. Otherwise, the following will take place.

Data is retrieved from the remote server and stored in a temporary file. The signal downloadProgress() will be emitted regularly.
In case of an error, the signal error() is emitted and the download stops.
Optionally, the download can be stopped using the method stopFileDownload().

Once all data has been downloaded successfully to the temporary file, the process continues as follows.

The signal aboutToChangeLocalFile() is emitted. As the name suggests, this indicates that the local file is about to change and that it should not be used anymore.
A QLockFile is created at fileName()+".lock"
The local file is overwritten by the newly downloaded data.
The QLockFile is removed
The signal fileChanged() is emitted to indicate that the file is again ready to be used.

Implements DataManagement::Downloadable_Abstract.

◆ startInfoDownload()

Q_INVOKABLE void DataManagement::Downloadable_SingleFile::startInfoDownload ( )

Contacts the server and downloads information about the remote file.

This method contacts the remote server, retrieves information about the remote file and updates the properties remoteFileDate and remoteFileSize accordingly. This method runs asynchronously, and emits the signal remoteFileInfoChanged() if the data really changes. If a request is already running, this method does nothing.

Warning: This method fails silently if the server cannot be contacted or if the server is unable to provide the requested data.

◆ stopDownload()

Q_INVOKABLE void DataManagement::Downloadable_SingleFile::stopDownload ( )

overridevirtual

Stops download process.

This method stops the currenly running download process gracefully and deletes any partially downloaded data. No signal will be emitted. If no download is in progress, nothing will happen.

Implements DataManagement::Downloadable_Abstract.

◆ updateSize()

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

nodiscardoverridevirtual

Implementation of pure virtual getter method from Downloadable_Abstract.

Returns: Property updateSize

Implements DataManagement::Downloadable_Abstract.

◆ url()

auto DataManagement::Downloadable_SingleFile::url ( ) const -> QUrl

inlinenodiscard

Getter function for the property with the same name.

Returns: Property url

Definition at line 209 of file Downloadable_SingleFile.h.

Property Documentation

◆ downloadProgress

int DataManagement::Downloadable_SingleFile::downloadProgress

read

Download progress.

This property holds the download progress in percent, if a download is ongoing. If no download is taking place, this property is undefined.

Definition at line 108 of file Downloadable_SingleFile.h.

◆ fileContent

QByteArray DataManagement::Downloadable_SingleFile::fileContent

read

Content of the downloaded file.

This convenience property holds the content of the downloaded file, or a null QByteArray, if nothing has been downloaded

Definition at line 118 of file Downloadable_SingleFile.h.

◆ remoteFileDate

QDateTime DataManagement::Downloadable_SingleFile::remoteFileDate

readwrite

Modification date of the remote file.

If the modification date of the remote file is not known, the property holds an invalid QDateTime. The property can be set with the method checkForUpdate(), or directly written to.

Definition at line 126 of file Downloadable_SingleFile.h.

◆ remoteFileSize

qint64 DataManagement::Downloadable_SingleFile::remoteFileSize

readwrite

Size of the remote file.

This property holds the size of the remote file. If the size date of the remote file is not known, the property holds an -1. The property can be set with the method checkForUpdate(), or directly written to.

Definition at line 134 of file Downloadable_SingleFile.h.

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

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

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Downloadable_SingleFile()

◆ ~Downloadable_SingleFile()

Member Function Documentation

◆ aboutToChangeFile

◆ deleteFiles()

◆ description()

◆ downloading()

◆ downloadProgress()

◆ downloadProgressChanged

◆ fileContent()

◆ fileName()

◆ files()

◆ infoText()

◆ remoteFileDate()

◆ remoteFileDateChanged

◆ remoteFileSize()

◆ setRemoteFileDate()

◆ setRemoteFileSize()

◆ startDownload()

◆ startInfoDownload()

◆ stopDownload()

◆ updateSize()

◆ url()

Property Documentation

◆ downloadProgress

◆ fileContent

◆ remoteFileDate

◆ remoteFileSize