NorMIT-nav  2023.01.05-dev+develop.0da12
An IGT application
Static Public Member Functions | List of all members
cx::DataLocations Class Reference
Core » Settings

#include <cxDataLocations.h>

Static Public Member Functions

static QString getBundlePath ()
 return the folder where the bundle or executable are located. More...
 
static QString getRootConfigPath ()
 return path to root config folder. May be replaced with getExistingConfigPath() More...
 
static QStringList getRootConfigPaths ()
 
static QString getTestDataPath ()
 return path to test data folder More...
 
static QString getLargeTestDataPath ()
 return path to test data folder containing large data sets More...
 
static QString getExistingTestData (QString pathRelativeToTestDataRoot, QString filename="")
 Return full path to test data, both normal and large repositories are searched. More...
 
static QString getDocPath ()
 return path to folder containing documentation files More...
 
static QString getPersistentWritablePath ()
 Path to location usable for persistent and temporary storage of config. Do not use directly, prefer to create methods displaying subpaths. More...
 
static void deletePersistentWritablePath ()
 Deletes the folder called *_settings. More...
 
static QString getCachePath ()
 return path to a folder that is used during execution, will be cleared at start and stop. More...
 
static QStringList getDefaultPluginsPath ()
 return the folder where plugins should be located, by default. More...
 
static void setTestMode ()
 set a testing mode that changes location of settings files to a temp folder. More...
 
static QString findExecutableInStandardLocations (QString filename)
 look for an exe in the same folder as the executable or bundle. More...
 
static QStringList appendStringToAllElements (QStringList root, QString suffix)
 
static QString findConfigFolder (QString pathRelativeToConfigRoot, QString alternativeAbsolutePath="")
 
static QString findConfigFilePath (QString fileName, QString pathRelativeToConfigRoot, QString alternativeAbsolutePath="")
 
static QString findConfigPath (QString fileName, QString pathRelativeToConfigRoot, QString alternativeAbsolutePath="")
 
static void setWebsiteURL (QString websiteUrl)
 
static QString getWebsiteURL ()
 
static QString getUploadsUrl ()
 
static QString getWebsiteUserDocumentationURL ()
 
static bool isRunFromBuildFolder ()
 
static bool isTestMode ()
 

Detailed Description

Helper functions for accessing file paths and similar stuff.

Date
Jun 22, 2010
Author
christiana

Definition at line 31 of file cxDataLocations.h.

Member Function Documentation

◆ appendStringToAllElements()

QStringList cx::DataLocations::appendStringToAllElements ( QStringList  root,
QString  suffix 
)
static

Definition at line 229 of file cxDataLocations.cpp.

◆ deletePersistentWritablePath()

void cx::DataLocations::deletePersistentWritablePath ( )
static

Deletes the folder called *_settings.

Definition at line 106 of file cxDataLocations.cpp.

◆ findConfigFilePath()

QString cx::DataLocations::findConfigFilePath ( QString  fileName,
QString  pathRelativeToConfigRoot,
QString  alternativeAbsolutePath = "" 
)
static

Definition at line 264 of file cxDataLocations.cpp.

◆ findConfigFolder()

QString cx::DataLocations::findConfigFolder ( QString  pathRelativeToConfigRoot,
QString  alternativeAbsolutePath = "" 
)
static

Definition at line 253 of file cxDataLocations.cpp.

◆ findConfigPath()

QString cx::DataLocations::findConfigPath ( QString  fileName,
QString  pathRelativeToConfigRoot,
QString  alternativeAbsolutePath = "" 
)
static

Definition at line 258 of file cxDataLocations.cpp.

◆ findExecutableInStandardLocations()

QString cx::DataLocations::findExecutableInStandardLocations ( QString  filename)
static

look for an exe in the same folder as the executable or bundle.

Definition at line 293 of file cxDataLocations.cpp.

◆ getBundlePath()

QString cx::DataLocations::getBundlePath ( )
static

return the folder where the bundle or executable are located.

Definition at line 115 of file cxDataLocations.cpp.

◆ getCachePath()

QString cx::DataLocations::getCachePath ( )
static

return path to a folder that is used during execution, will be cleared at start and stop.

Definition at line 247 of file cxDataLocations.cpp.

◆ getDefaultPluginsPath()

QStringList cx::DataLocations::getDefaultPluginsPath ( )
static

return the folder where plugins should be located, by default.

Definition at line 136 of file cxDataLocations.cpp.

◆ getDocPath()

QString cx::DataLocations::getDocPath ( )
static

return path to folder containing documentation files

Definition at line 205 of file cxDataLocations.cpp.

◆ getExistingTestData()

QString cx::DataLocations::getExistingTestData ( QString  pathRelativeToTestDataRoot,
QString  filename = "" 
)
static

Return full path to test data, both normal and large repositories are searched.

Definition at line 73 of file cxDataLocations.cpp.

◆ getLargeTestDataPath()

QString cx::DataLocations::getLargeTestDataPath ( )
static

return path to test data folder containing large data sets

Definition at line 59 of file cxDataLocations.cpp.

◆ getPersistentWritablePath()

QString cx::DataLocations::getPersistentWritablePath ( )
static

Path to location usable for persistent and temporary storage of config. Do not use directly, prefer to create methods displaying subpaths.

Definition at line 96 of file cxDataLocations.cpp.

◆ getRootConfigPath()

QString cx::DataLocations::getRootConfigPath ( )
static

return path to root config folder. May be replaced with getExistingConfigPath()

Definition at line 169 of file cxDataLocations.cpp.

◆ getRootConfigPaths()

QStringList cx::DataLocations::getRootConfigPaths ( )
static

Definition at line 179 of file cxDataLocations.cpp.

◆ getTestDataPath()

QString cx::DataLocations::getTestDataPath ( )
static

return path to test data folder

Definition at line 45 of file cxDataLocations.cpp.

◆ getUploadsUrl()

QString cx::DataLocations::getUploadsUrl ( )
static

Definition at line 320 of file cxDataLocations.cpp.

◆ getWebsiteURL()

QString cx::DataLocations::getWebsiteURL ( )
static

Definition at line 315 of file cxDataLocations.cpp.

◆ getWebsiteUserDocumentationURL()

QString cx::DataLocations::getWebsiteUserDocumentationURL ( )
static

Definition at line 325 of file cxDataLocations.cpp.

◆ isRunFromBuildFolder()

bool cx::DataLocations::isRunFromBuildFolder ( )
static

Definition at line 336 of file cxDataLocations.cpp.

◆ isTestMode()

bool cx::DataLocations::isTestMode ( )
static

Definition at line 40 of file cxDataLocations.cpp.

◆ setTestMode()

void cx::DataLocations::setTestMode ( )
static

set a testing mode that changes location of settings files to a temp folder.

Definition at line 33 of file cxDataLocations.cpp.

◆ setWebsiteURL()

void cx::DataLocations::setWebsiteURL ( QString  websiteUrl)
static

Definition at line 310 of file cxDataLocations.cpp.

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