Entropy Piano Tuner  1.1.3 (documentation not yet complete)
An open-source experimental software for piano tuning by entropy minimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FileManagerForQt Class Reference

Implementation of the FileManager for Qt. More...

#include <filemanagerforqt.h>

+ Inheritance diagram for FileManagerForQt:
+ Collaboration diagram for FileManagerForQt:

Public Member Functions

 FileManagerForQt ()
 Constructor, creating directories. More...
 
 ~FileManagerForQt ()
 Empty destructor. More...
 
virtual std::string getLogFilePath (const std::string &logname) const overridefinal
 Returns the path of the log file with the given logname. More...
 
virtual std::string getAlgorithmInformationFileContent (const std::string &algorithmId) const overridefinal
 Read the content of the XML file of an algorithm with the given ID. More...
 
- Public Member Functions inherited from FileManager
 FileManager ()
 Constructor, setting the singleton pointer to its own instance. More...
 
virtual ~FileManager ()
 Virtual destructor. More...
 
virtual bool open (std::ifstream &stream, const std::string &absolute, std::ios_base::openmode mode=std::ios_base::in)
 Open an input stream. More...
 
virtual bool open (std::ofstream &stream, const std::string &absolute, std::ios_base::openmode mode=std::ios_base::out)
 Open an output file stream. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FileManager
static FileManagergetSingleton ()
 FileManager::getSingleton: Get a reference to the singleton. More...
 

Detailed Description

Implementation of the FileManager for Qt.

Definition at line 33 of file filemanagerforqt.h.

Constructor & Destructor Documentation

FileManagerForQt::FileManagerForQt ( )

Constructor, creating directories.

This constructor checks wether the Qt standard locations for cache, generic cache and documentation are writable. If the directories do not yet exist they are created. In case of problems there will be corresponding warnings.

Definition at line 45 of file filemanagerforqt.cpp.

FileManagerForQt::~FileManagerForQt ( )
inline

Empty destructor.

Definition at line 37 of file filemanagerforqt.h.

Member Function Documentation

std::string FileManagerForQt::getAlgorithmInformationFileContent ( const std::string &  algorithmId) const
finaloverridevirtual

Read the content of the XML file of an algorithm with the given ID.

Parameters
algorithmId: String identifying the algorithm
Returns
The whole content of the corresponding XML file in a single string.

Implements FileManager.

Definition at line 87 of file filemanagerforqt.cpp.

std::string FileManagerForQt::getLogFilePath ( const std::string &  logname) const
finaloverridevirtual

Returns the path of the log file with the given logname.

Returns the full path of the log file. The function does not check whether the log file actually exists

Parameters
logname: Name of the log
Returns
: String containing the path to the log file

Implements FileManager.

Definition at line 70 of file filemanagerforqt.cpp.


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