The ApplicationSettings class is a singleton which saves all settings for iVS3D. These are: Paths to the reconstruction softwares, the standard input path, the plugin path, layout style and if dark style is active. More...

#include <applicationsettings.h>

Public Types
enum	CUDA_ERR_CODE { }
	The CUDA_ERR_CODE enum has an error code if CUDA is not available. More...

Public Member Functions
void	addReconstructPath (QString name, QString path)
	Saves an reconstruction software.

bool	removeReconstructPath (QString name)
	Removes the given reconstruction software.

void	setStandardInputPath (const QString &standardInput)
	Saves the standard input path.

void	setDisableChecks (bool disableChecks)
	Disable sanity checks for ots product configuration.

void	setColorTheme (ColorTheme theme)
	Sets the darkstyle.

void	setUseCuda (bool useCuda)
	setUseCuda Sets use cuda boolean

void	setCreateLogs (bool createLogs)
	setCreateLogs Sets createLogs

void	setInterpolateMetaData (bool interpolateMetaData)
	setInterpolateMetaData Sets interpolateMetaData

QMap< QString, QString >	getReconstructPath ()
	Returns all saved reconstruction softwares.

QString	getStandardInputPath ()
	Returns the standard input path.

bool	getDisableChecks ()
	Returns wether sanity checks in ots product configuration are disabled.

ColorTheme	getColorTheme ()
	Returns which darkstyle is saved in the settings file.

bool	getUseCuda ()
	Returns if use CUDA is enabled.

bool	getCudaAvailable (CUDA_ERR_CODE *err_code=nullptr) const
	Returns if the opencv backend supports CUDA.

bool	getCreateLogs ()
	Returns if create Logs is enabled.

bool	getInterpolateMetaData ()
	Returns if interpolate meta data is enabled.

const QList< QLocale >	getAvailableLocales ()
	Returns a list of available locales for translating the application.

QLocale	getLocale ()
	Returns the currently selected locale.

bool	setLocale (QLocale locale)
	setLocale selects a locale for translation. The local has to be supported by the application. Available locales can be accessed by using getAvailableLocales(). If the selected locale is not supported, then the current locale is not changed.

Static Public Member Functions
static ApplicationSettings &	instance ()
	Returns the singleton instance of this class.

Detailed Description

The ApplicationSettings class is a singleton which saves all settings for iVS3D. These are: Paths to the reconstruction softwares, the standard input path, the plugin path, layout style and if dark style is active.

Author: Daniel Brommer

Date: 2021/01/30

Member Enumeration Documentation

◆ CUDA_ERR_CODE

enum ApplicationSettings::CUDA_ERR_CODE

The CUDA_ERR_CODE enum has an error code if CUDA is not available.

Enumerator
NO_GPU_FOUND	indicates that cuda is available
CC_MISSMATCH	no GPU was detected
BUILT_WITHOUT_CUDA	Compute Capability of the GPU is not supported by the build.
UNKNOWN_ERR	iVS3D was compiled without CUDA

Member Function Documentation

◆ addReconstructPath()

void ApplicationSettings::addReconstructPath	(	QString	name,
		QString	path
	)

Saves an reconstruction software.

Parameters

name	Name of the reconstruction software
path	Path of the reconstruction software

◆ getAvailableLocales()

const QList< QLocale > ApplicationSettings::getAvailableLocales ( )

Returns a list of available locales for translating the application.

Returns: The list of QLocale

◆ getColorTheme()

ColorTheme ApplicationSettings::getColorTheme ( )

Returns which darkstyle is saved in the settings file.

Returns: true if darkstyle is saved

◆ getCreateLogs()

bool ApplicationSettings::getCreateLogs ( )

Returns if create Logs is enabled.

Returns: true if logging is enabled and log files will be created

◆ getCudaAvailable()

bool ApplicationSettings::getCudaAvailable ( CUDA_ERR_CODE * err_code = nullptr ) const

Returns if the opencv backend supports CUDA.

Parameters

err_code (optional) pointer, if not null, the error code is stored there if cuda is not available

Returns: true if cuda is supported

◆ getDisableChecks()

bool ApplicationSettings::getDisableChecks ( )

Returns wether sanity checks in ots product configuration are disabled.

Returns: true, if checks are disabled

◆ getInterpolateMetaData()

bool ApplicationSettings::getInterpolateMetaData ( )

Returns if interpolate meta data is enabled.

Returns: true if interpolation is enabled

◆ getLocale()

QLocale ApplicationSettings::getLocale ( )

Returns the currently selected locale.

Returns: The locale for translation.

◆ getReconstructPath()

QMap< QString, QString > ApplicationSettings::getReconstructPath ( )

Returns all saved reconstruction softwares.

Returns: QMap with the name of the reconstruction software as key and it's path as value

◆ getStandardInputPath()

QString ApplicationSettings::getStandardInputPath ( )

Returns the standard input path.

Returns: QString with the current input path

◆ getUseCuda()

bool ApplicationSettings::getUseCuda ( )

Returns if use CUDA is enabled.

Returns: true if cuda is enabled

◆ instance()

ApplicationSettings & ApplicationSettings::instance ( )

static

Returns the singleton instance of this class.

Returns: Instance of this class

◆ removeReconstructPath()

bool ApplicationSettings::removeReconstructPath ( QString name )

Removes the given reconstruction software.

Parameters

name	Name of the reconstruction software to be removed

◆ setColorTheme()

void ApplicationSettings::setColorTheme ( ColorTheme theme )

Sets the darkstyle.

Parameters

dark	true will toggle darkstyle

◆ setCreateLogs()

void ApplicationSettings::setCreateLogs ( bool createLogs )

setCreateLogs Sets createLogs

Parameters

createLogs true if log files should be created, false if no log files should be created

◆ setDisableChecks()

void ApplicationSettings::setDisableChecks ( bool disableChecks )

Disable sanity checks for ots product configuration.

Parameters

disableChecks true will disbale checks and allow for (potentially) faulty configurations. Only use if you know what you are doing!

◆ setInterpolateMetaData()

void ApplicationSettings::setInterpolateMetaData ( bool interpolateMetaData )

setInterpolateMetaData Sets interpolateMetaData

Parameters

interpolateMetaData true if missing meta data should be interpolated, false if not

◆ setLocale()

bool ApplicationSettings::setLocale ( QLocale locale )

setLocale selects a locale for translation. The local has to be supported by the application. Available locales can be accessed by using getAvailableLocales(). If the selected locale is not supported, then the current locale is not changed.

IMPORTANT: The locale is only applied when the applications starts next time!

Parameters

locale The locale to use for translation

Returns: Returns true if the locale is supported and false otherwise.

◆ setStandardInputPath()

void ApplicationSettings::setStandardInputPath ( const QString & standardInput )

Saves the standard input path.

Parameters

standardInput Path of the standard input

◆ setUseCuda()

void ApplicationSettings::setUseCuda ( bool useCuda )

setUseCuda Sets use cuda boolean

Parameters

useCuda true if cuda is used, false otherwise

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

iVS3D/src/iVS3D-core/applicationsettings.h
iVS3D/src/iVS3D-core/applicationsettings.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ CUDA_ERR_CODE

Member Function Documentation

◆ addReconstructPath()

◆ getAvailableLocales()

◆ getColorTheme()

◆ getCreateLogs()

◆ getCudaAvailable()

◆ getDisableChecks()

◆ getInterpolateMetaData()

◆ getLocale()

◆ getReconstructPath()

◆ getStandardInputPath()

◆ getUseCuda()

◆ instance()

◆ removeReconstructPath()

◆ setColorTheme()

◆ setCreateLogs()

◆ setDisableChecks()

◆ setInterpolateMetaData()

◆ setLocale()

◆ setStandardInputPath()

◆ setUseCuda()