LibrePCB Developers Documentation
OutputDirectoryWriter Class Referencefinal

The OutputDirectoryWriter class. More...

#include <outputdirectorywriter.h>

Inherits QObject.

+ Collaboration diagram for OutputDirectoryWriter:

Signals

void aboutToWriteFile (const FilePath &fp)
 
void aboutToRemoveFile (const FilePath &fp)
 

Public Member Functions

 OutputDirectoryWriter ()=delete
 
 OutputDirectoryWriter (const OutputDirectoryWriter &other)=delete
 
 OutputDirectoryWriter (const FilePath &dirPath) noexcept
 
 ~OutputDirectoryWriter () noexcept
 
const FilePathgetDirectoryPath () const noexcept
 
const QMultiHash< Uuid, FilePath > & getWrittenFiles () const noexcept
 
bool loadIndex ()
 
void storeIndex ()
 
FilePath beginWritingFile (const Uuid &job, const QString &relPath)
 
void removeObsoleteFiles (const Uuid &job)
 
QList< FilePathfindUnknownFiles (const QSet< Uuid > &knownJobs) const
 
void removeUnknownFiles (const QList< FilePath > &files)
 
OutputDirectoryWriteroperator= (const OutputDirectoryWriter &rhs)=delete
 

Private Attributes

const FilePath mDirPath
 
const FilePath mIndexFilePath
 
QMap< FilePath, UuidmIndex
 
bool mIndexLoaded
 
bool mIndexModified
 
QMultiHash< Uuid, FilePathmWrittenFiles
 

Detailed Description

Constructor & Destructor Documentation

◆ OutputDirectoryWriter() [1/3]

◆ OutputDirectoryWriter() [2/3]

OutputDirectoryWriter ( const OutputDirectoryWriter other)
delete

◆ OutputDirectoryWriter() [3/3]

OutputDirectoryWriter ( const FilePath dirPath)
explicitnoexcept

◆ ~OutputDirectoryWriter()

~OutputDirectoryWriter ( )
noexcept
+ Here is the call graph for this function:

Member Function Documentation

◆ getDirectoryPath()

const FilePath & getDirectoryPath ( ) const
inlinenoexcept

◆ getWrittenFiles()

const QMultiHash< Uuid, FilePath > & getWrittenFiles ( ) const
inlinenoexcept

◆ loadIndex()

bool loadIndex ( )
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ storeIndex()

void storeIndex ( )
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ beginWritingFile()

FilePath beginWritingFile ( const Uuid job,
const QString &  relPath 
)
+ Here is the call graph for this function:

◆ removeObsoleteFiles()

void removeObsoleteFiles ( const Uuid job)
+ Here is the call graph for this function:

◆ findUnknownFiles()

QList< FilePath > findUnknownFiles ( const QSet< Uuid > &  knownJobs) const
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeUnknownFiles()

void removeUnknownFiles ( const QList< FilePath > &  files)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

OutputDirectoryWriter & operator= ( const OutputDirectoryWriter rhs)
delete

◆ aboutToWriteFile

void aboutToWriteFile ( const FilePath fp)
signal
+ Here is the caller graph for this function:

◆ aboutToRemoveFile

void aboutToRemoveFile ( const FilePath fp)
signal
+ Here is the caller graph for this function:

Member Data Documentation

◆ mDirPath

const FilePath mDirPath
private

◆ mIndexFilePath

const FilePath mIndexFilePath
private

◆ mIndex

QMap<FilePath, Uuid> mIndex
private

◆ mIndexLoaded

bool mIndexLoaded
private

◆ mIndexModified

bool mIndexModified
private

◆ mWrittenFiles

QMultiHash<Uuid, FilePath> mWrittenFiles
private

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