Core class specifies the basic static information for the CamiTK API. More...

#include <Core.h>

Static Public Member Functions
runtime directory information
static const QStringList	getComponentDirectories ()
	get all the component directories. More...

static const QStringList	getActionDirectories ()
	get all the action directories. More...

static const QString	getTestDataDir ()
	Get a valid camitk test data directory name. More...

static const QStringList	getInstallDirectories (QString suffix)
	get all installation directories, suffixed by the given word. More...

static const QString	getConfig ()
	get more information about installation, etc... More...

static const QString	getPaths ()
	get all important paths More...

static const QString	getGlobalInstallDir ()
	get the CAMITK_DIR (where camitk-config is installed) More...

static const QString	getUserInstallDir ()
	get the user config directory (this is the local installation directory) More...

static const QString	getCurrentWorkingDir ()
	get the current working directory (during dev, this should be the build directory, which is an installation directory) More...

static const QString	getBugReport ()
	get a well formed bug report with all necessary information More...

runtime build information
get the type of build we are running, Debug or Release Returns true if running in Debug, elsewhere false for Release build.
static const bool	isDebugBuild ()

Static Public Attributes
miscallaneous utility method or variables
complete version string
static const char *	version

static const char *	shortVersion
	short version string (all in lower case, without the patch number) More...

static const char *	soVersion
	version used for so name More...

static const char *	debugPostfix
	debug postfix used on MSVC to distinguished between release and debug version More...

Detailed Description

Core class specifies the basic static information for the CamiTK API.

Extensions can only be in three different places:

CAMITK_DIR (where the libcamitkcore is)
user config directory
current wording directory

Member Function Documentation

◆ getActionDirectories()

const QStringList camitk::Core::getActionDirectories ( )

static

get all the action directories.

It gets all the valid directories where components are installed, and insert them in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

References getInstallDirectories(), and shortVersion.

Referenced by camitk::ExtensionManager::autoload(), getPaths(), and camitk::SettingsDialog::on_addActionExtensionButton_released().

◆ getBugReport()

const QString camitk::Core::getBugReport ( )

static

get a well formed bug report with all necessary information

References getConfig().

Referenced by main(), and GenerateBugReportProcess::run().

◆ getComponentDirectories()

const QStringList camitk::Core::getComponentDirectories ( )

static

get all the component directories.

It gets all the valid directories where components are installed, and insert them in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

References getInstallDirectories(), and shortVersion.

Referenced by camitk::ExtensionManager::autoload(), getPaths(), camitk::SettingsDialog::on_addComponentExtensionButton_released(), camitk::Application::open(), camitk::Application::openDirectory(), and camitk::Application::save().

◆ getConfig()

const QString camitk::Core::getConfig ( )

static

get more information about installation, etc...

References camitk::ExtensionManager::getActionExtensionsList(), camitk::ActionExtension::getActions(), camitk::ExtensionManager::getComponentExtensionsList(), getCurrentWorkingDir(), camitk::ExtensionManager::getDataDirectoryComponentsList(), camitk::ComponentExtension::getFileExtensions(), getGlobalInstallDir(), camitk::ExtensionManager::getInstallationString(), camitk::ActionExtension::getLocation(), camitk::ComponentExtension::getLocation(), camitk::ActionExtension::getName(), camitk::ComponentExtension::getName(), getPaths(), and getUserInstallDir().

Referenced by getBugReport(), and main().

◆ getCurrentWorkingDir()

const QString camitk::Core::getCurrentWorkingDir ( )

static

get the current working directory (during dev, this should be the build directory, which is an installation directory)

Referenced by getConfig(), getInstallDirectories(), getPaths(), camitk::ExtensionManager::initPrivateLibDirs(), and camitk::Application::saveHistoryAsSXML().

◆ getGlobalInstallDir()

const QString camitk::Core::getGlobalInstallDir ( )

static

get the CAMITK_DIR (where camitk-config is installed)

References camitk::Application::getName(), and getUserInstallDir().

Referenced by getConfig(), getInstallDirectories(), getPaths(), camitk::ExtensionManager::initPrivateLibDirs(), camitk::ExtensionManager::loadExtension(), and main().

◆ getInstallDirectories()

const QStringList camitk::Core::getInstallDirectories ( QString suffix )

static

get all installation directories, suffixed by the given word.

All the returned Strings are unique valid directories, sorted in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

References getCurrentWorkingDir(), getGlobalInstallDir(), and getUserInstallDir().

Referenced by getActionDirectories(), getComponentDirectories(), and getTestDataDir().

◆ getPaths()

const QString camitk::Core::getPaths ( )

static

get all important paths

References getActionDirectories(), getComponentDirectories(), getCurrentWorkingDir(), getGlobalInstallDir(), getTestDataDir(), getUserInstallDir(), isDebugBuild(), shortVersion, soVersion, and version.

Referenced by getConfig(), and main().

◆ getTestDataDir()

const QString camitk::Core::getTestDataDir ( )

static

Get a valid camitk test data directory name.

It returns the first valid test data directory that is found. Checking is done in this particular order:

current working directory (build install tree)
user config directory (user install tree)
CamiTK SDK installation directory (global install tree)

If none of this three directories is valid, return user's home directory.

A test data directory is valid if it exists and contains a least one file.

Returns: a null QString, checkable with isNull(), if no test data directory found

References getInstallDirectories(), and shortVersion.

Referenced by camitk::Application::Application(), and getPaths().

◆ getUserInstallDir()

const QString camitk::Core::getUserInstallDir ( )

static

get the user config directory (this is the local installation directory)

References camitk::Application::getSettings().

Referenced by getConfig(), getGlobalInstallDir(), getInstallDirectories(), getPaths(), and camitk::ExtensionManager::initPrivateLibDirs().

◆ isDebugBuild()

const bool camitk::Core::isDebugBuild ( )

static

Referenced by camitk::ExtensionManager::getExtensionFilter(), getPaths(), and camitk::ExtensionManager::getPluginFileNames().

Member Data Documentation

◆ debugPostfix

const char* camitk::Core::debugPostfix

static

debug postfix used on MSVC to distinguished between release and debug version

Referenced by camitk::ExtensionManager::getExtensionFilter(), and camitk::ExtensionManager::getPluginFileNames().

◆ shortVersion

const char* camitk::Core::shortVersion

static

short version string (all in lower case, without the patch number)

Referenced by getActionDirectories(), getComponentDirectories(), getPaths(), getTestDataDir(), camitk::ExtensionManager::initPrivateLibDirs(), camitk::ExtensionManager::loadExtension(), and main().

◆ soVersion

const char* camitk::Core::soVersion

static

version used for so name

Referenced by camitk::ExtensionManager::getExtensionFilter(), and getPaths().

◆ version

const char* camitk::Core::version

static

Referenced by getPaths(), initIcons(), main(), camitk::MainWindow::redirectToConsole(), and usage().

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

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getActionDirectories()

◆ getBugReport()

◆ getComponentDirectories()

◆ getConfig()

◆ getCurrentWorkingDir()

◆ getGlobalInstallDir()

◆ getInstallDirectories()

◆ getPaths()

◆ getTestDataDir()

◆ getUserInstallDir()

◆ isDebugBuild()

Member Data Documentation

◆ debugPostfix

◆ shortVersion

◆ soVersion

◆ version