MLABPackage Class Reference

Stores information about a MeVisLab Package. More...

List of all members.

Public Slots

Package Information Script Access
QString binPath () const
QString buildInfoDate ()
QString buildInfoRevision ()
QString buildInfoSystem ()
QString description () const
QString documentationIndexPath () const
QString documentationPath () const
QString findExecutable (const QString &name, bool preferReleaseMode=true)
QString findExecutableBundleById (const QString &id)
QString findSharedLibrary (const QString &name)
bool isEditableByUser ()
bool isInstalledWithMeVisLab () const
bool isUnderVersionControl ()
QString libPath () const
QStringList libPaths () const
QString moduleReferencePath () const
QString modulesPath () const
QString owner () const
QString packageConfigurationPriFile () const
QString packageEnvVariableName () const
QString packageGroup () const
QString packageIdentifier () const
QString packageName () const
QString path () const
void print ()
QString typeString ()


Detailed Description

Stores information about a MeVisLab Package.

Member Function Documentation

QString MLABPackage::binPath (  )  const [slot]

get the bin path

QString MLABPackage::buildInfoDate (  )  [slot]

returns the build date of the package when it was built, or an empty string if the mdl build information file does not exist.

QString MLABPackage::buildInfoRevision (  )  [slot]

returns the revision of the package when it was built, or an empty string if the mdl build information file does not exist.

QString MLABPackage::buildInfoSystem (  )  [slot]

returns the system of the package where it was built, or an empty string if the mdl build information file does not exist.

QString MLABPackage::description (  )  const [inline, slot]

get a short description of the package

QString MLABPackage::documentationIndexPath (  )  const [slot]

returns the path to the module documentation index

QString MLABPackage::documentationPath (  )  const [slot]

returns the path to the module documentation

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

returns the path to the executable, if it exists empty string otherwise (where the executable name is just the name, without debug postfix and platform ending)

On Mac OS X it also looks for application bundles and if found returns the main executable of the bundle

QString MLABPackage::findExecutableBundleById ( const QString &  id  )  [slot]

returns path to bundle if found in package (Mac OS X only)

QString MLABPackage::findSharedLibrary ( const QString &  name  )  [slot]

returns the path to the shared library, if it exists empty string otherwise (where the library name is just the name, without debug postfix and platform ending)

bool MLABPackage::isEditableByUser (  )  [slot]

returns if the package is editable by the user (which means it is either not installed with mevislab or under version control (core developers))

bool MLABPackage::isInstalledWithMeVisLab (  )  const [inline, slot]

returns if the package is installed with MeVisLab

bool MLABPackage::isUnderVersionControl (  )  [slot]

returns if the package is under version control (which means that it contains a .svn or CVS directory)

QString MLABPackage::libPath (  )  const [slot]

get the lib path

QStringList MLABPackage::libPaths (  )  const [slot]

get the libPath and possible further lib/debug or lib/release paths if they exists and the MeVisLab version is in debug or release mode

QString MLABPackage::moduleReferencePath (  )  const [slot]

returns the path to the module reference

QString MLABPackage::modulesPath (  )  const [slot]

get the path to the modules of the package

QString MLABPackage::owner (  )  const [inline, slot]

get the owner of the package

QString MLABPackage::packageConfigurationPriFile (  )  const [slot]

get the path to the configuration pri file

QString MLABPackage::packageEnvVariableName (  )  const [slot]

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

QString MLABPackage::packageGroup (  )  const [inline, slot]

get the package group

QString MLABPackage::packageIdentifier (  )  const [inline, slot]

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

QString MLABPackage::packageName (  )  const [inline, slot]

get the package name

QString MLABPackage::path (  )  const [inline, slot]

get the base path of the package

QString MLABPackage::typeString (  )  [slot]

returns a package type string (for output only, not for checking the type!)


Generated on Sat Sep 3 18:38:03 2011 for MeVisLab Scripting Reference by  doxygen 1.5.8