MLABPackage Class Reference

#include <mlabPackageManager.h>

Public Slots
Package information script access.
QString	packageName () const
QString	packageGroup () const
QString	packageIdentifier () const
QString	packageEnvVariableName () const
QString	description () const
QString	owner () const
QString	scriptsPath ()
QString	basePath () const
QString	binariesPath () const
QString	path ()
QString	defaultModuleGroup () const
QString	libPath () const
QStringList	libPaths () const
QString	binPath () const
QString	modulesPath () const
QString	moduleReferencePath () const
QString	documentationPath () const
QString	documentationIndexPath () const
QString	packageConfigurationPriFile () const
QString	projectsPath () const
bool	containsModulesOrProjects () const
bool	isInstalledWithMeVisLab () const
bool	showHelpOnIndexPage () const
SaveAllowType	allowSaveOfInternalNetworks () const
void	print ()
QString	typeString ()
QString	findSharedLibrary (const QString &name)
QString	findExecutable (const QString &name, bool preferReleaseMode=true)
bool	isUnderVersionControl ()
bool	isEditableByUser ()
bool	shouldNotDependOnPackage (const QString &packageIdentifier, bool extended=false) const
int	projectsSearchDepth () const
QStringList	findInstallerLibraryFiles ()

Friends
class	MLABPackageManager

Detailed Description

Stores information about a MeVisLab package.

Member Function Documentation

allowSaveOfInternalNetworks

SaveAllowType MLABPackage::allowSaveOfInternalNetworks ( ) const

inlineslot

Returns whether the saving of internal networks should be allowed, allowed with warning, or refused.

basePath

QString MLABPackage::basePath ( ) const

inlineslot

Returns the base path of the package (sources).

binariesPath

QString MLABPackage::binariesPath ( ) const

inlineslot

Returns the base path of the package (binaries/build results - this might be the same as basePath()).

binPath

QString MLABPackage::binPath ( ) const

slot

Returns the bin path.

containsModulesOrProjects

bool MLABPackage::containsModulesOrProjects ( ) const

slot

Returns true if at least modulesPath() or projectsPath() exists.

defaultModuleGroup

QString MLABPackage::defaultModuleGroup ( ) const

inlineslot

Returns the default module group for all modules in this package. This is meant to set default visibility of modules.

description

QString MLABPackage::description ( ) const

inlineslot

Returns a short description of the package.

documentationIndexPath

QString MLABPackage::documentationIndexPath ( ) const

slot

Returns the path to the module documentation index.

documentationPath

QString MLABPackage::documentationPath ( ) const

slot

Returns the path to the module documentation.

findExecutable

QString MLABPackage::findExecutable ( const QString & name, bool preferReleaseMode = true )

slot

Returns the path to the executable if it exists and an empty string otherwise. The executable name is just the name, without debug postfix and platform ending.

References path().

findInstallerLibraryFiles

QStringList MLABPackage::findInstallerLibraryFiles ( )

slot

Finds all installer library files located in Configuration/Installers/Libraries/. The filenames are returned as absolute paths.

findSharedLibrary

QString MLABPackage::findSharedLibrary ( const QString & name )

slot

Returns the path to the shared library if it exists and an empty string otherwise. The library name is just the name, without debug postfix and platform ending.

isEditableByUser

bool MLABPackage::isEditableByUser ( )

slot

Returns whether the package is editable by the user. that means it is either not installed with MeVisLab or under version control (for core developers).

isInstalledWithMeVisLab

bool MLABPackage::isInstalledWithMeVisLab ( ) const

inlineslot

Returns whether the package is installed with MeVisLab.

isUnderVersionControl

bool MLABPackage::isUnderVersionControl ( )

slot

Returns whether the package is under version control. This means that it or one of the parent directories contains an .svn or .git directory.

libPath

QString MLABPackage::libPath ( ) const

slot

Returns the lib path.

libPaths

QStringList MLABPackage::libPaths ( ) const

slot

Returns the libPath and possible further lib/debug or lib/release paths if they exist and the MeVisLab version is in debug or release mode.

moduleReferencePath

QString MLABPackage::moduleReferencePath ( ) const

slot

Returns the path to the module reference.

modulesPath

QString MLABPackage::modulesPath ( ) const

slot

Returns the path to the modules of the package.

owner

QString MLABPackage::owner ( ) const

inlineslot

Returns the owner of the package.

packageConfigurationPriFile

QString MLABPackage::packageConfigurationPriFile ( ) const

slot

Returns the path to the configuration .pri file.

packageEnvVariableName

QString MLABPackage::packageEnvVariableName ( ) const

slot

Returns the package's environment variable name (which is "MLAB_"+packageGroup() + "_" + packageName() ).

packageGroup

QString MLABPackage::packageGroup ( ) const

inlineslot

Returns the package group.

packageIdentifier

QString MLABPackage::packageIdentifier ( ) const

inlineslot

Returns the package identifier (which is packageGroup() + "/" + packageName() ).

Referenced by shouldNotDependOnPackage().

packageName

QString MLABPackage::packageName ( ) const

inlineslot

Returns the package name.

path

QString MLABPackage::path ( )

slot

Returns the base path of the package (deprecated, use either basePath() or binariesPath).

Referenced by findExecutable().

print

void MLABPackage::print ( )

slot

Prints package information.

projectsPath

QString MLABPackage::projectsPath ( ) const

slot

Returns the projects path.

projectsSearchDepth

int MLABPackage::projectsSearchDepth ( ) const

inlineslot

Returns the search depths for modules below the Projects subdirectory.

scriptsPath

QString MLABPackage::scriptsPath ( )

slot

Returns the base path of the package (sources). This is deprecated! Use basePath() instead.

shouldNotDependOnPackage

bool MLABPackage::shouldNotDependOnPackage ( const QString & packageIdentifier, bool extended = false ) const

slot

Returns true if this package should not depend on content from the given package. If the argument extended is set, extended package dependencies are applied (for tests and example networks).

References packageIdentifier().

showHelpOnIndexPage

bool MLABPackage::showHelpOnIndexPage ( ) const

inlineslot

Returns whether the package documentation (module reference) is visible on the documentation index page.

typeString

QString MLABPackage::typeString ( )

slot

Returns a package type string. Use it for output only, not for checking the type!