Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::qt::FileMapper Class Reference

Qt implementation of the interface class sf::IFileMapper. More...

#include <FileMapper.h>

Inheritance diagram for sf::qt::FileMapper:
Collaboration diagram for sf::qt::FileMapper:

Public Member Functions

 FileMapper ()
 Default constructor.
 
 FileMapper (const QString &filepath, qint64 ofs, qint64 sz)
 Initializing constructor.
 
void initialize () override
 Overridden from sf::IFileMapper.
 
void initialize (const QString &filepath, qint64 ofs, qint64 sz)
 Initialize using an existing file.
 
void setView (qint64 ofs, qint64 sz)
 Sets the part of the file to be mapped.
 
 ~FileMapper () override
 Overridden from sf::IFileMapper.
 
void createView (size_t sz) override
 Overridden from sf::IFileMapper.
 
void * getPtr () override
 Overridden from sf::IFileMapper.
 
bool mapView () override
 Overridden from sf::IFileMapper.
 
bool unmapView () override
 Overridden from sf::IFileMapper.
 
QFile & getFile ()
 Gets the underlying file class.
 
- Public Member Functions inherited from sf::IFileMapper
 IFileMapper ()=default
 Default constructor.
 
virtual ~IFileMapper ()=default
 Virtual destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from sf::IFileMapper
static IFileMapperinstantiate (bool native)
 Gets an instance of this interface using a native or non-native (Qt) implementation.
 

Detailed Description

Qt implementation of the interface class sf::IFileMapper.

Constructor & Destructor Documentation

◆ FileMapper() [1/2]

sf::qt::FileMapper::FileMapper ( )

Default constructor.

◆ FileMapper() [2/2]

sf::qt::FileMapper::FileMapper ( const QString &  filepath,
qint64  ofs,
qint64  sz 
)

Initializing constructor.

Parameters
filepathPath to the file.
ofsOffset into the file.
szSize of the chunk in the file.

◆ ~FileMapper()

sf::qt::FileMapper::~FileMapper ( )
override

Overridden from sf::IFileMapper.

Member Function Documentation

◆ createView()

void sf::qt::FileMapper::createView ( size_t  sz)
overridevirtual

Overridden from sf::IFileMapper.

Implements sf::IFileMapper.

◆ getFile()

QFile & sf::qt::FileMapper::getFile ( )

Gets the underlying file class.

◆ getPtr()

void * sf::qt::FileMapper::getPtr ( )
overridevirtual

Overridden from sf::IFileMapper.

Implements sf::IFileMapper.

◆ initialize() [1/2]

void sf::qt::FileMapper::initialize ( )
overridevirtual

Overridden from sf::IFileMapper.

Implements sf::IFileMapper.

◆ initialize() [2/2]

void sf::qt::FileMapper::initialize ( const QString &  filepath,
qint64  ofs,
qint64  sz 
)

Initialize using an existing file.

Parameters
filepathPath to the file.
ofsOffset into the file.
szSize of the chunk in the file.

◆ mapView()

bool sf::qt::FileMapper::mapView ( )
overridevirtual

Overridden from sf::IFileMapper.

Implements sf::IFileMapper.

◆ setView()

void sf::qt::FileMapper::setView ( qint64  ofs,
qint64  sz 
)

Sets the part of the file to be mapped.

Parameters
ofsOffset into the file.
szSize of the chunk in the file.

◆ unmapView()

bool sf::qt::FileMapper::unmapView ( )
overridevirtual

Overridden from sf::IFileMapper.

Implements sf::IFileMapper.


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