FileFormats::DataFileAbstract Class Reference

Base class for file reading classes. More...

#include <DataFileAbstract.h>

Inheritance diagram for FileFormats::DataFileAbstract:

Public Member Functions
bool	isValid () const
	Validity check.
QString	error () const
	Error string.
QStringList	warnings () const
	Warnings.

Static Public Member Functions
static QSharedPointer< QFile >	openFileURL (const QString &fileName)
	Open file, file URL or Android content URL.
static bool	saveFileAtomically (const QString &path, const QByteArray &data, QString *error=nullptr, QFileDevice::Permissions permissions={})
	Write data to a file atomically.

Detailed Description

Base class for file reading classes.

This is an abstract base class for all classes that read data files, such as CUP, GeoJSON, GeoTIFF, …. Implementations should adhere to the following conventions:

• The constructor takes a file name as an argument and reads the file, which might be quite expensive.
• There is a static method 'mimeTypes' that describes the mime types of the files that can be opened with this class.

Definition at line 44 of file DataFileAbstract.h.

Member Function Documentation

error()

QString FileFormats::DataFileAbstract::error ( ) const

inlinenodiscard

Error string.

If the constructor found the file to be invalid, this method returns a human-readable, transated error string.

Returns

Error string, or an empty string if the file is valid.

Definition at line 76 of file DataFileAbstract.h.

isValid()

bool FileFormats::DataFileAbstract::isValid ( ) const

inlinenodiscard

Validity check.

Use this method to check if the file is valid. If not, then all the other getter methods will typically return undefined results. Since all the heavy lifting is done in the constructor, this method is extremely lightweight.

This method is equivalent to !error().isEmpty()

Returns

True if the data is valid.

Definition at line 67 of file DataFileAbstract.h.

openFileURL()

QSharedPointer< QFile > FileFormats::DataFileAbstract::openFileURL ( const QString & fileName )

staticnodiscard

Open file, file URL or Android content URL.

This method opens a file. It handles file URLs and Android content URLs. The latter are downloaded to a temporary file.

Parameters

fileName

A file name, a file URL or an Android content URL

Returns

A shared pointer to a file, which is already open. The file might be a QTemporaryFile. The file might have an error condition set.

saveFileAtomically()

bool FileFormats::DataFileAbstract::saveFileAtomically ( const QString & path, const QByteArray & data, QString * error = nullptr, QFileDevice::Permissions permissions = {} )

staticnodiscard

Write data to a file atomically.

The data is written through a QSaveFile, so that an existing file at the path is either replaced completely or left untouched, even if the app is killed while writing.

Parameters

path	Path of the file to write
data	Content to write
error	If non-null, receives a human-readable error message on failure
permissions	If non-empty, the permissions to set on the file before it replaces the old one (e.g. owner read/write only for files with secrets). If empty, the default permissions apply.

Returns

True on success

warnings()

QStringList FileFormats::DataFileAbstract::warnings ( ) const

inlinenodiscard

Warnings.

If the constructor found non-critical issues in the file, this method returns a list of human-readable, transated warnings.

Returns

List of warning, or an empty list if there were no warnings.

Definition at line 85 of file DataFileAbstract.h.

---

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

• /home/runner/work/enroute/enroute/src/fileFormats/DataFileAbstract.h