Abstract base class for Downloadable_SingleFile and Downloadable_MultiFile. More...

#include <Downloadable_Abstract.h>

Inheritance diagram for DataManagement::Downloadable_Abstract:

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

Signals
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_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.

virtual auto	description () -> QString=0
	Getter method for the property with the same name.

virtual auto	downloading () -> bool=0
	Getter method for the property with the same name.

virtual auto	files () -> QStringList=0
	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.

virtual auto	infoText () -> QString=0
	Getter method for the property with the same name.

virtual auto	remoteFileSize () -> qint64=0
	Getter function 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	updateSize () -> Units::ByteSize=0
	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.

virtual Q_INVOKABLE void	deleteFiles ()=0
	Deletes all local file(s)

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

virtual Q_INVOKABLE void	startDownload ()=0
	Initiate download(s)

virtual Q_INVOKABLE void	stopDownload ()=0
	Stops download process(es)

virtual Q_INVOKABLE void	update ()=0
	Starts download(s) if updatable.

Properties
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

Abstract base class for Downloadable_SingleFile and Downloadable_MultiFile.

This is an abstract base class for Downloadable_SingleFile and Downloadable_MultiFile, ensuring that the two classes share a common API.

Note: Subclasses need to set the protected member m_contentType in their constructors.

Definition at line 43 of file Downloadable_Abstract.h.

Member Enumeration Documentation

◆ ContentType

enum DataManagement::Downloadable_Abstract::ContentType : quint8

Type of content managed by this instance.

Enumerator
VAC	Visual Approach Chart.
AviationMap	Aviation Map.
BaseMapVector	Base Map, in vector format.
BaseMapRaster	Base Map, in raster format.
Data	Data.
MapSet	Set of maps.
TerrainMap	Terrain Map.

Definition at line 50 of file Downloadable_Abstract.h.

Constructor & Destructor Documentation

◆ Downloadable_Abstract()

DataManagement::Downloadable_Abstract::Downloadable_Abstract ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent The standard QObject parent pointer.

Member Function Documentation

◆ bindableHasFile()

QBindable< bool > DataManagement::Downloadable_Abstract::bindableHasFile ( ) const

inlinenodiscard

Getter method for the property with the same name.

Returns: Property hasFile

Definition at line 188 of file Downloadable_Abstract.h.

◆ bindableSection()

QBindable< QString > DataManagement::Downloadable_Abstract::bindableSection ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property section

Definition at line 212 of file Downloadable_Abstract.h.

◆ boundingBox()

QGeoRectangle DataManagement::Downloadable_Abstract::boundingBox ( ) const

inlinenodiscard

Getter method for the property with the same name.

Returns: Property boundingBox

Definition at line 152 of file Downloadable_Abstract.h.

◆ contentType()

DataManagement::Downloadable_Abstract::ContentType DataManagement::Downloadable_Abstract::contentType ( ) const

inlinenodiscard

Getter method for the property with the same name.

Returns: Property contentType

Definition at line 158 of file Downloadable_Abstract.h.

◆ description()

virtual auto DataManagement::Downloadable_Abstract::description ( ) -> QString

nodiscardpure virtual

Getter method for the property with the same name.

Returns: Property description

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ downloading()

virtual auto DataManagement::Downloadable_Abstract::downloading ( ) -> bool

nodiscardpure virtual

Getter method for the property with the same name.

Returns: Property downloading

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ error

void DataManagement::Downloadable_Abstract::error	(	QString	objectName,
		QString	message )

signal

Download error.

This signal is emitted if the download process fails for whatever reason. Once the signal is emitted, the download process is deleted and no further actions will take place. The local file will not be touched.

Parameters

objectName	Name of this QObject, as obtained by the method objectName()
message	A brief error message of the form "the requested resource is no longer available at the server", possibly translated.

◆ fileContentChanged_delayed

void DataManagement::Downloadable_Abstract::fileContentChanged_delayed ( )

signal

Emitted some time after the content of one of the local files changes.

This signal is in principle identical to fileContentChanged(), but is emitted with a delay of two seconds. In addition it waits until there are no running download processes anymore.

◆ files()

virtual auto DataManagement::Downloadable_Abstract::files ( ) -> QStringList

nodiscardpure virtual

Getter method for the property with the same name.

Returns: Property files

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ hasFile()

bool DataManagement::Downloadable_Abstract::hasFile ( ) const

inlinenodiscard

Getter method for the property with the same name.

Returns: Property hasFile

Definition at line 182 of file Downloadable_Abstract.h.

◆ infoText()

virtual auto DataManagement::Downloadable_Abstract::infoText ( ) -> QString

nodiscardpure virtual

Getter method for the property with the same name.

Returns: Property infoText

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ remoteFileSize()

virtual auto DataManagement::Downloadable_Abstract::remoteFileSize ( ) -> qint64

nodiscardpure virtual

Getter function for the property with the same name.

Returns: Property remoteFileSize

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ section()

QString DataManagement::Downloadable_Abstract::section ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property section

Definition at line 206 of file Downloadable_Abstract.h.

◆ setBoundingBox()

void DataManagement::Downloadable_Abstract::setBoundingBox ( const QGeoRectangle & boundingBox )

Setter function for the property with the same name.

Parameters

boundingBox Property boundingBox

◆ setContentType()

void DataManagement::Downloadable_Abstract::setContentType ( DataManagement::Downloadable_Abstract::ContentType contentType )

Setter function for the property with the same name.

Parameters

contentType Property contentType

◆ setSection()

void DataManagement::Downloadable_Abstract::setSection ( const QString & sectionName )

inline

Setter function for the property with the same name.

Parameters

sectionName Property section

Definition at line 248 of file Downloadable_Abstract.h.

◆ updateSize()

virtual auto DataManagement::Downloadable_Abstract::updateSize ( ) -> Units::ByteSize

nodiscardpure virtual

Getter function for the property with the same name.

Returns: Property updateSize

Implemented in DataManagement::Downloadable_MultiFile, and DataManagement::Downloadable_SingleFile.

◆ updateSizeString()

virtual auto DataManagement::Downloadable_Abstract::updateSizeString ( ) -> QString

nodiscardvirtual

Getter function for the property with the same name.

Returns: Property updateSizeString

Property Documentation

◆ description

QString DataManagement::Downloadable_Abstract::description

read

Describe installed file(s)

This property contains a description of the locally installed file(s), localized and in HTML format. If no description is available, then the property contains an empty string.

Definition at line 88 of file Downloadable_Abstract.h.

◆ infoText

QString DataManagement::Downloadable_Abstract::infoText

read

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

The text is typically one or more lines of the form

"downloading … 47% complete"
"installed • 203 kB • update available"

It might be translated to the local language.

Definition at line 111 of file Downloadable_Abstract.h.

◆ remoteFileSize

qint64 DataManagement::Downloadable_Abstract::remoteFileSize

read

Size of the remote file.

This property holds the size of the remote files. If the sizes are not known, the property holds the number -1.

Definition at line 118 of file Downloadable_Abstract.h.

◆ section

QString DataManagement::Downloadable_Abstract::section

readwrite

Headline name for the Downloadable.

This property is a convenience storing one string along with the Downloadable. This property holds the string stored in the downloadable, or a translated version of 'Installed' when hasFile is true.

The enroute app uses this to store the continent name for a Dowloadable that represents a geographic map. The GUI then generate section headings in the list of downloadable aviation maps.

Definition at line 130 of file Downloadable_Abstract.h.

◆ updateSize

Units::ByteSize DataManagement::Downloadable_Abstract::updateSize

read

Update size.

If local files exist and update(s) are available, this property holds the size of the update. If no updates are available, this property holds 0.

Definition at line 138 of file Downloadable_Abstract.h.

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

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

Public Types

Signals

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ContentType

Constructor & Destructor Documentation

◆ Downloadable_Abstract()

Member Function Documentation

◆ bindableHasFile()

◆ bindableSection()

◆ boundingBox()

◆ contentType()

◆ description()

◆ downloading()

◆ error

◆ fileContentChanged_delayed

◆ files()

◆ hasFile()

◆ infoText()

◆ remoteFileSize()

◆ section()

◆ setBoundingBox()

◆ setContentType()

◆ setSection()

◆ updateSize()

◆ updateSizeString()

Property Documentation

◆ description

◆ infoText

◆ remoteFileSize

◆ section

◆ updateSize