Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::IFileMapper Class Referenceabstract

class for file mapping More...

#include <IFileMapper.h>

Inheritance diagram for sf::IFileMapper:

Public Member Functions

 IFileMapper ()=default
 Default constructor.
 
virtual ~IFileMapper ()=default
 Virtual destructor.
 
virtual void initialize ()=0
 Initialize and prepare the underlying system when needed.
 
virtual void createView (size_t sz)=0
 Allocates disk space the file map.
 
virtual bool mapView ()=0
 Locks a pointer in memory which can be unlocked using unmapView().
 
virtual bool unmapView ()=0
 Unlocks the pointer locked with mapView().
 
virtual void * getPtr ()=0
 Gets the pointer locked using method mapView().
 

Static Public Member Functions

static IFileMapperinstantiate (bool native)
 Gets an instance of this interface using a native or non-native (Qt) implementation.
 

Detailed Description

class for file mapping

Constructor & Destructor Documentation

◆ IFileMapper()

sf::IFileMapper::IFileMapper ( )
default

Default constructor.

◆ ~IFileMapper()

virtual sf::IFileMapper::~IFileMapper ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ createView()

virtual void sf::IFileMapper::createView ( size_t  sz)
pure virtual

Allocates disk space the file map.

Parameters
szSize of the view.

Implemented in sf::lnx::FileMapper, sf::qt::FileMapper, and sf::win::FileMapper.

◆ getPtr()

virtual void * sf::IFileMapper::getPtr ( )
pure virtual

Gets the pointer locked using method mapView().

Returns
True on success.

Implemented in sf::lnx::FileMapper, sf::qt::FileMapper, and sf::win::FileMapper.

◆ initialize()

virtual void sf::IFileMapper::initialize ( )
pure virtual

Initialize and prepare the underlying system when needed.

Implemented in sf::lnx::FileMapper, sf::qt::FileMapper, and sf::win::FileMapper.

◆ instantiate()

static IFileMapper * sf::IFileMapper::instantiate ( bool  native)
static

Gets an instance of this interface using a native or non-native (Qt) implementation.

Qt non-native is only available when compiled and linked with Qt.

Parameters
nativeFalse for creating Qt implementation.
Returns

◆ mapView()

virtual bool sf::IFileMapper::mapView ( )
pure virtual

Locks a pointer in memory which can be unlocked using unmapView().

Returns
True on success.

Implemented in sf::lnx::FileMapper, sf::qt::FileMapper, and sf::win::FileMapper.

◆ unmapView()

virtual bool sf::IFileMapper::unmapView ( )
pure virtual

Unlocks the pointer locked with mapView().

Returns
True on success.

Implemented in sf::lnx::FileMapper, sf::qt::FileMapper, and sf::win::FileMapper.


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