CustusX  2020.11.07-dev+develop.4ce4a
An IGT application
cx::Profile Class Reference

#include <cxProfile.h>

Inheritance diagram for cx::Profile:

Public Member Functions

 Profile (QString path, SettingsPtr settings)
 
 ~Profile ()
 
void activate ()
 
XmlOptionFile getXmlSettings ()
 internal use More...
 
SettingsgetSettings () const
 
QString getName () const
 
QString getUid () const
 
QString getPath () const
 
QStringList getApplicationToolConfigPaths ()
 
QString getToolConfigFilePath ()
 
void setToolConfigFilePath (QString path)
 
QString getSettingsPath ()
 
QStringList getAllRootConfigPaths ()
 
QString getSessionRootFolder () const
 
void setSessionRootFolder (QString path)
 
QString getPatientTemplatePath ()
 

Detailed Description

Access to profile-specific data.

A profile is a collection of configuration data that is selectable by the user. Several profiles can exist, but only one can be active at a time.

Definition at line 41 of file cxProfile.h.

Constructor & Destructor Documentation

cx::Profile::Profile ( QString  path,
SettingsPtr  settings 
)

Definition at line 35 of file cxProfile.cpp.

cx::Profile::~Profile ( )

Definition at line 41 of file cxProfile.cpp.

Member Function Documentation

void cx::Profile::activate ( )

Definition at line 46 of file cxProfile.cpp.

QStringList cx::Profile::getAllRootConfigPaths ( )

Return root path of all locations where readable config can be found, including general (profile-unspecific) locations. This includes the value of getPath(), which also is writable.

Definition at line 119 of file cxProfile.cpp.

QStringList cx::Profile::getApplicationToolConfigPaths ( )

Return all paths where tool config files can be found. TODO: must know where to save files, one loc.

Definition at line 84 of file cxProfile.cpp.

QString cx::Profile::getName ( ) const

Return the user-friendly name of profile.

Definition at line 69 of file cxProfile.cpp.

QString cx::Profile::getPath ( ) const

Return location of profile-specific data. Writable.

Definition at line 79 of file cxProfile.cpp.

QString cx::Profile::getPatientTemplatePath ( )

Definition at line 114 of file cxProfile.cpp.

QString cx::Profile::getSessionRootFolder ( ) const

Return root folder where sessions are to be stored

Definition at line 134 of file cxProfile.cpp.

Settings * cx::Profile::getSettings ( ) const

Return settings ini file.

Definition at line 58 of file cxProfile.cpp.

QString cx::Profile::getSettingsPath ( )

Return location of profile-specific settings.

Definition at line 109 of file cxProfile.cpp.

QString cx::Profile::getToolConfigFilePath ( )

Return the full path to the current tool config file.

Definition at line 100 of file cxProfile.cpp.

QString cx::Profile::getUid ( ) const

Return the unique uid of profile.

Definition at line 74 of file cxProfile.cpp.

XmlOptionFile cx::Profile::getXmlSettings ( )

internal use

Return settings xml file.

Definition at line 52 of file cxProfile.cpp.

void cx::Profile::setSessionRootFolder ( QString  path)

Definition at line 151 of file cxProfile.cpp.

void cx::Profile::setToolConfigFilePath ( QString  path)

Definition at line 89 of file cxProfile.cpp.


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