MLABPackageManager Class Reference

Inherits QObject.

Public Slots
Package Manager Script Access
QStringList	getBinPaths ()
QStringList	getLibPaths ()
QStringList	getAdditionalPythonPaths (PythonPathType pathType=PythonPathType::LocalAndInstalled) const
QObjectList	packages ()
QObjectList	packagesByGroup (const QString &group)
MLABPackage *	packageByIdentifier (const QString &packageName)
QStringList	findSharedLibrary (const QString &name)
QStringList	findExecutable (const QString &name)
QString	getMeVisPythonExecutable (bool preferReleaseMode=true)
QString	getPathInPackage (const QString &packageIdentifier, const QString &pathToAppend)
MLABPackage *	findPackageContainingPath (const QString &absPath, QString *relativePath=nullptr)
QStringList	findPackageIdentifierAndRelativePath (const QString &absPath)
QVariantList	checkForMultipleCopiesOfSharedLibraries ()
bool	isPackagePathAlreadyPresent (const QString &path)
MLABPackage *	internalAddDummyPackage (const QString &group, const QString &name, const QString &path)
void	internalRemoveDummyPackage (MLABPackage *package)
QStringList	findProjectSubDirectoriesInPackage (MLABPackage *package, const QString &subDirectoryName, bool inZipFile=false) const

Detailed Description

Manages MeVisLab module packages.

Member Function Documentation

checkForMultipleCopiesOfSharedLibraries

QVariantList MLABPackageManager::checkForMultipleCopiesOfSharedLibraries ( )

slot

Returns whether there are multiple copies of shared libraries, which are returned as a QVariantList of QStringLists.

findExecutable

QStringList MLABPackageManager::findExecutable ( const QString &  name )

slot

Returns the path(s) to the executable if they exists, an empty list otherwise (where the name is just the name, without debug postfix and platform ending).

findPackageContainingPath

MLABPackage* MLABPackageManager::findPackageContainingPath ( const QString &  absPath, QString *  relativePath = nullptr  )

slot

Searches the packages and returns the package that contains the given path.

Parameters

absPath	The absolute path.
relativePath	Will be the path from the package to the contained path, or untouched if no package was found.

findPackageIdentifierAndRelativePath

QStringList MLABPackageManager::findPackageIdentifierAndRelativePath ( const QString &  absPath )

slot

Searches the packages and returns the package identifier and the relative path into the package (or an empty list).

findProjectSubDirectoriesInPackage

QStringList MLABPackageManager::findProjectSubDirectoriesInPackage ( MLABPackage *  package, const QString &  subDirectoryName, bool  inZipFile = false  ) const

slot

Searches for project subdirectories with the given name in the project directory.

The search is recursive and the found project subdirectories are returned.

findSharedLibrary

QStringList MLABPackageManager::findSharedLibrary ( const QString &  name )

slot

Returns the path(s) to the shared library(s) if they exists, an empty list otherwise (where the library name is just the name, without debug postfix and platform ending).

getAdditionalPythonPaths

QStringList MLABPackageManager::getAdditionalPythonPaths ( PythonPathType  pathType = PythonPathType::LocalAndInstalled ) const

slot

Returns the list of additional Python paths contributed by the packages.

These are .../Modules/Scripts/python and .../site-packages

getBinPaths

QStringList MLABPackageManager::getBinPaths ( )

slot

Returns the binary paths that need to be set.

getLibPaths

QStringList MLABPackageManager::getLibPaths ( )

slot

Returns the library paths that need to be set.

getMeVisPythonExecutable

QString MLABPackageManager::getMeVisPythonExecutable ( bool  preferReleaseMode = true )

slot

Returns the MeVisPython executable at the platform-specific location in MeVis/ThirdParty.

Parameters

preferReleaseMode

If this is not set, the executable mode will try to match that of the calling MeVisLab instance; otherwise, it will prefer the release mode executable and fall back to the debug version only if the release version does not exist.

getPathInPackage

QString MLABPackageManager::getPathInPackage ( const QString &  packageIdentifier, const QString &  pathToAppend  )

slot

Returns the given path inside of the given package.

internalAddDummyPackage

MLABPackage* MLABPackageManager::internalAddDummyPackage ( const QString &  group, const QString &  name, const QString &  path  )

slot

Internal method for adding a dummy package, only use this for testing purposes.

internalRemoveDummyPackage

void MLABPackageManager::internalRemoveDummyPackage ( MLABPackage *  package )

slot

Internal method for removing a dummy package, only use this for testing purposes.

isPackagePathAlreadyPresent

bool MLABPackageManager::isPackagePathAlreadyPresent ( const QString &  path )

slot

Returns whether the given path is already part of the scanned package paths or a subdirectory of one of the package paths.

packageByIdentifier

MLABPackage* MLABPackageManager::packageByIdentifier ( const QString &  packageName )

slot

Returns the specified package information.

packages

QObjectList MLABPackageManager::packages ( )

slot

Returns the list of packages as QObjectList, since QSA does not support QList<MLABPackage>.

packagesByGroup

QObjectList MLABPackageManager::packagesByGroup ( const QString &  group )

slot

Returns the list of packages in a group as QObjectList, since QSA does not support QList<MLABPackage>.