QGCFileWriter Class Reference

#include <QGCFileWriter.h>

Inheritance diagram for QGCFileWriter:

Collaboration diagram for QGCFileWriter:

Public Types
using	FormatFunc = std::function< QByteArray()>

Signals
void	errorOccurred (const QString &message)
void	fileSizeChanged (qint64 size)

Public Member Functions
	QGCFileWriter (QObject *parent=nullptr)
	~QGCFileWriter () override
void	setFilePath (const QString &path)
QString	filePath () const
bool	isRunning () const
bool	isOpen () const
bool	hasError () const
QString	lastError () const
qint64	fileSize () const
qint64	pendingBytes () const
void	write (const QByteArray &data)
void	writeDeferred (FormatFunc formatter)
bool	flush (int timeoutMs=5000)
void	close ()
void	clearError ()
void	setMaxPendingBytes (qint64 max)
qint64	maxPendingBytes () const

Detailed Description

Definition at line 15 of file QGCFileWriter.h.

Member Typedef Documentation

FormatFunc

using QGCFileWriter::FormatFunc = std::function<QByteArray()>

Definition at line 34 of file QGCFileWriter.h.

Constructor & Destructor Documentation

QGCFileWriter()

QGCFileWriter::QGCFileWriter ( QObject *  parent = nullptr )

explicit

Definition at line 7 of file QGCFileWriter.cc.

~QGCFileWriter()

QGCFileWriter::~QGCFileWriter ( )

override

Definition at line 12 of file QGCFileWriter.cc.

Member Function Documentation

clearError()

void QGCFileWriter::clearError

(

)

Definition at line 128 of file QGCFileWriter.cc.

close()

void QGCFileWriter::close

(

)

Definition at line 123 of file QGCFileWriter.cc.

errorOccurred

void QGCFileWriter::errorOccurred ( const QString &  message )

signal

filePath()

QString QGCFileWriter::filePath

(

)

const

Definition at line 45 of file QGCFileWriter.cc.

fileSize()

qint64 QGCFileWriter::fileSize ( ) const

inline

Definition at line 31 of file QGCFileWriter.h.

fileSizeChanged

void QGCFileWriter::fileSizeChanged ( qint64  size )

signal

flush()

bool QGCFileWriter::flush

(

int

timeoutMs = 5000

)

Definition at line 103 of file QGCFileWriter.cc.

hasError()

bool QGCFileWriter::hasError ( ) const

inline

Definition at line 28 of file QGCFileWriter.h.

isOpen()

bool QGCFileWriter::isOpen ( ) const

inline

Definition at line 27 of file QGCFileWriter.h.

isRunning()

bool QGCFileWriter::isRunning

(

)

const

Definition at line 51 of file QGCFileWriter.cc.

lastError()

QString QGCFileWriter::lastError

(

)

const

Definition at line 57 of file QGCFileWriter.cc.

maxPendingBytes()

qint64 QGCFileWriter::maxPendingBytes ( ) const

inline

Definition at line 43 of file QGCFileWriter.h.

pendingBytes()

qint64 QGCFileWriter::pendingBytes ( ) const

inline

Definition at line 32 of file QGCFileWriter.h.

setFilePath()

void QGCFileWriter::setFilePath

(

const QString &

path

)

Definition at line 17 of file QGCFileWriter.cc.

setMaxPendingBytes()

void QGCFileWriter::setMaxPendingBytes ( qint64  max )

inline

Definition at line 42 of file QGCFileWriter.h.

write()

void QGCFileWriter::write

(

const QByteArray &

data

)

Definition at line 63 of file QGCFileWriter.cc.

writeDeferred()

void QGCFileWriter::writeDeferred

(

FormatFunc

formatter

)

Definition at line 87 of file QGCFileWriter.cc.

---

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

• src/Utilities/FileSystem/QGCFileWriter.h
• src/Utilities/FileSystem/QGCFileWriter.cc