QEpromFileBase Class Reference

QEpromFileBase Class. More...

#include <qepromfilebase.hpp>

Inheritance diagram for QEpromFileBase:

Public Types
enum	QEpromFileType { EpromFileBin , EpromFileSRec , EpromFileHex , EpromFileAtmel }
	Eprom File Types. More...

Public Member Functions
	QEpromFileBase (QObject *parent=nullptr)
	Constructor. More...
virtual QByteArray	read (const QString &filename, qint32 size)=0
	Reads data from a file. More...
virtual bool	write (QEpromFileType type, const QString &filename, const QByteArray &data)=0
	Writes data to a file. More...
virtual QString	getFilename (void) const
	Gets the filename used to read or write the file. More...
virtual QEpromFileType	getType (void) const
	Gets the type of the file opened/saved. More...

Static Public Member Functions
static bool	isReadable (const QString &filename)
	Returns if file is readable in this format. More...

Detailed Description

QEpromFileBase Class.

The purpose of this class is to be an interface to all the EPROM File Manipulator classes.

Member Enumeration Documentation

QEpromFileType

enum QEpromFileType

Eprom File Types.

Enumerator
EpromFileBin	Binary file (raw).
EpromFileSRec	Motorola S-REC file.
EpromFileHex	Intel Hex file.
EpromFileAtmel	Atmel Generic file.

Constructor & Destructor Documentation

QEpromFileBase()

QEpromFileBase ( QObject *  parent = nullptr )

explicit

Constructor.

Parameters

parent

Pointer to parent object (default = nullptr).

Member Function Documentation

isReadable()

bool isReadable ( const QString &  filename )

static

Returns if file is readable in this format.

Parameters

filename

Filename (with path).

Returns

True if success, false otherwise.

read()

virtual QByteArray read ( const QString &  filename, qint32  size  )

pure virtual

Reads data from a file.

Parameters

filename	Filename (with path).
size	Size of data to be read (in bytes). If file is smaller than this parameter, data is filled with 0xFF.

Returns

Byte array with data, or empty if an error occurs.

Implemented in QSrecFile, QHexFile, QEpromFile, QBinFile, and QAtmelFile.

write()

virtual bool write ( QEpromFileType  type, const QString &  filename, const QByteArray &  data  )

pure virtual

Writes data to a file.

Parameters

type	Type of the file to write.
filename	Filename (with path).
data	Data to write.

Returns

True if success, false otherwise.

Implemented in QSrecFile, QHexFile, QEpromFile, QBinFile, and QAtmelFile.

getFilename()

QString getFilename ( void  ) const

virtual

Gets the filename used to read or write the file.

Returns

The filename, or empty if file wasn't saved/opened yet.

getType()

QEpromFileBase::QEpromFileType getType ( void  ) const

virtual

Gets the type of the file opened/saved.

Returns

Type of the file.

---

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

• qepromfilebase.hpp
• qepromfilebase.cpp