hdps::Application Class Reference

#include <Application.h>

Inheritance diagram for hdps::Application:

Signals
void	coreSet (CoreInterface *core)

Public Member Functions
	Application (int &argc, char **argv)
CoreInterface *	getCore ()
void	setCore (CoreInterface *core)
util::Version	getVersion () const
QString	getStartupProjectFilePath () const
void	setStartupProjectFilePath (const QString &startupProjectFilePath)
bool	shouldOpenProjectAtStartup () const
QVariant	getSetting (const QString &path, const QVariant &defaultValue=QVariant()) const
void	setSetting (const QString &path, const QVariant &value)

Static Public Member Functions
static Application *	current ()
static CoreInterface *	core ()
static QString	getName ()
static const IconFont &	getIconFont (const QString &name, const std::int32_t &majorVersion=-1, const std::int32_t &minorVersion=-1)
static util::Logger &	getLogger ()
static QString	getSerializationTemporaryDirectory ()
static void	setSerializationTemporaryDirectory (const QString &serializationTemporaryDirectory)
static bool	isSerializationAborted ()
static void	setSerializationAborted (bool serializationAborted)

Protected Attributes
CoreInterface *	_core
const util::Version	_version
IconFonts	_iconFonts
QSettings	_settings
QString	_serializationTemporaryDirectory
bool	_serializationAborted
util::Logger	_logger
hdps::gui::TriggerAction *	_exitAction
QString	_startupProjectFilePath

Detailed Description

HDPS application class

Author

Thomas Kroes

Constructor & Destructor Documentation

Application()

hdps::Application::Application	(	int &	argc,
		char **	argv
	)

Constructor

Parameters

argc	Number of command line arguments
argv	Command line arguments

Member Function Documentation

core()

hdps::CoreInterface * hdps::Application::core ( )

static

Get pointer to the core

coreSet

void hdps::Application::coreSet ( CoreInterface *  core )

signal

Signals that the core has been become available

current()

hdps::Application * hdps::Application::current ( )

static

Returns a pointer to the current HDPS application (if the current application derives from hdps::Application)

getCore()

hdps::CoreInterface * hdps::Application::getCore

(

)

Get pointer to the core

getIconFont()

const IconFont & hdps::Application::getIconFont ( const QString &  name, const std::int32_t &  majorVersion = -1, const std::int32_t &  minorVersion = -1  )

static

Returns an icon font by name majorVersion and minorVersion

Parameters

name	Name of the icon font (currently FontAwesome is supported)
majorVersion	Major version number
minorVersion	Minor version number

getLogger()

Logger & hdps::Application::getLogger ( )

static

Get application-wide logger instance

Returns

Reference to logger instance

getName()

QString hdps::Application::getName ( )

static

Get the application name

Returns

The application name

getSerializationTemporaryDirectory()

QString hdps::Application::getSerializationTemporaryDirectory ( )

static

Get serialization temporary directory

Returns

Serialization temporary directory

getSetting()

QVariant hdps::Application::getSetting	(	const QString &	path,
		const QVariant &	defaultValue = QVariant()
	)		const

Load setting

Parameters

path	Path of the setting (e.g. General/Computation/NumberOfIterations)
defaultValue	Value to return if the setting with path was not found

Returns

Plugin setting in variant form

getStartupProjectFilePath()

QString hdps::Application::getStartupProjectFilePath

(

)

const

Get file path of the project to automatically open upon startup (if set)

Returns

Startup project file path

getVersion()

util::Version hdps::Application::getVersion

(

)

const

Get application version (major and minor version number)

Returns

Pair of integers representing major and minor version number respectively

isSerializationAborted()

bool hdps::Application::isSerializationAborted ( )

static

Get whether serialization was aborted

Returns

Boolean indicating whether serialization was aborted

setCore()

void hdps::Application::setCore

(

CoreInterface *

core

)

Set pointer to the core

Parameters

core	Pointer to the core

setSerializationAborted()

void hdps::Application::setSerializationAborted ( bool  serializationAborted )

static

Set whether serialization was aborted

Parameters

serializationAborted

Boolean indicating whether serialization was aborted

setSerializationTemporaryDirectory()

void hdps::Application::setSerializationTemporaryDirectory ( const QString &  serializationTemporaryDirectory )

static

Set serialization temporary directory to serializationTemporaryDirectory

Parameters

serializationTemporaryDirectory

Serialization temporary directory

setSetting()

void hdps::Application::setSetting	(	const QString &	path,
		const QVariant &	value
	)

Save setting

Parameters

path	Path of the setting (e.g. General/Computation/NumberOfIterations)
value	Value in variant form

setStartupProjectFilePath()

void hdps::Application::setStartupProjectFilePath

(

const QString &

startupProjectFilePath

)

Set file path of the project to automatically open upon startup (if set)

Parameters

startupProjectFilePath

Startup project file path

shouldOpenProjectAtStartup()

bool hdps::Application::shouldOpenProjectAtStartup

(

)

const

Get whether a project should be opened after the application starts

Returns

Boolean determining whether a project should be opened after the application starts

Member Data Documentation

_core

CoreInterface* hdps::Application::_core

protected

_exitAction

hdps::gui::TriggerAction* hdps::Application::_exitAction

protected

Logger instance

_iconFonts

IconFonts hdps::Application::_iconFonts

protected

Application version

_logger

util::Logger hdps::Application::_logger

protected

Whether serialization was aborted

_serializationAborted

bool hdps::Application::_serializationAborted

protected

Temporary directory for serialization

_serializationTemporaryDirectory

QString hdps::Application::_serializationTemporaryDirectory

protected

Settings

_settings

QSettings hdps::Application::_settings

protected

Icon fonts resource

_startupProjectFilePath

QString hdps::Application::_startupProjectFilePath

protected

Action for exiting the application

_version

const util::Version hdps::Application::_version

protected

Pointer to HDPS core

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/Application.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/Application.cpp