Slicer
5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Base/QTCore/qSlicerCoreCommandOptions.h>
Public Types | |
typedef ctkCommandLineParser | Superclass |
Properties | |
QStringList | additionalModulePaths |
bool | disableBuiltInCLIModules |
bool | disableBuiltInLoadableModules |
bool | disableBuiltInScriptedLoadableModules |
bool | disableCLIModules |
bool | disableLoadableModules |
bool | disableMessageHandlers |
bool | disableScriptedLoadableModules |
bool | displayApplicationInformation |
bool | displayHelpAndExit |
bool | displayHomePathAndExit |
bool | displayMessageAndExit |
bool | displayProgramPathAndExit |
bool | displaySettingsPathAndExit |
bool | displayTemporaryPathAndExit |
bool | displayVersionAndExit |
QString | extraPythonScript |
bool | ignoreSlicerRC |
QStringList | modulesToIgnore |
QString | pythonCode |
QString | pythonScript |
bool | runPythonAndExit |
bool | testingEnabled |
bool | verboseModuleDiscovery |
Public Member Functions | |
QStringList | additionalModulePaths () const |
Return list of additional module path that should be considered when searching for modules to load. More... | |
bool | disableBuiltInCLIModules () const |
Return True if the loading of built-in Command Line Modules should be disabled. More... | |
bool | disableBuiltInLoadableModules () const |
Return True if the loading of built-in Loadable Modules should be disabled. More... | |
bool | disableBuiltInModules () const |
Return True if the loading of all built-in modules should be disabled. More... | |
bool | disableBuiltInScriptedLoadableModules () const |
Return True if the loading of built-in Scripted Loadable Modules should be disabled. More... | |
bool | disableCLIModules () const |
Return True if the loading of any Command Line Modules should be disabled. More... | |
bool | disableLoadableModules () const |
Return True if the loading of any Loadable Modules should be disabled. More... | |
bool | disableMessageHandlers () const |
Return True if slicer shouldn't catch messages printed to the terminal. More... | |
bool | disableModules () const |
Return True if the loading of any modules should be disabled. More... | |
bool | disableScriptedLoadableModules () const |
Return True if the loading of any Scripted Loadable Modules should be disabled. More... | |
bool | disableTerminalOutputs () const |
bool | displayApplicationInformation () const |
Return True if slicer should display application information in the terminal. More... | |
bool | displayHelpAndExit () const |
Return True if slicer should display help and exit. More... | |
bool | displayHomePathAndExit () const |
Return True if slicer should display home path and exit. More... | |
virtual bool | displayMessageAndExit () const |
bool | displayProgramPathAndExit () const |
Return True if slicer should display program path and exit. More... | |
bool | displaySettingsPathAndExit () const |
Return True if slicer should display settings path and exit. More... | |
bool | displayTemporaryPathAndExit () const |
Return True if slicer should display temporary path and exit. More... | |
bool | displayVersionAndExit () const |
Return True if slicer should display version and exit. More... | |
QString | extraPythonScript () const |
Return extra python script. More... | |
bool | ignoreRest () const |
Return True if the ignore rest argument has been passed. More... | |
bool | ignoreSlicerRC () const |
Return True if the loading of SlicerRC should be skipped. More... | |
bool | isTestingEnabled () const |
bool | keepTemporarySettings () const |
QStringList | modulesToIgnore () const |
Return list of modules that should not be loaded. More... | |
bool | parse (const QStringList &arguments) |
Convenient method allowing to parse arguments. More... | |
QString | pythonCode () const |
Return python code snippet to execute after slicer is loaded. More... | |
QString | pythonScript () const |
Return path of the python script to execute after slicer is loaded. More... | |
qSlicerCoreCommandOptions () | |
bool | runPythonAndExit () const |
Return True if Slicer should execute python code or script and exit. More... | |
void | setExtraPythonScript (const QString &newExtraPythonScript) |
Set extra python script to be executed after slicer is loaded. More... | |
void | setRunPythonAndExit (bool value) |
bool | settingsDisabled () const |
bool | verbose () const |
Return True if slicer should display information at startup. More... | |
bool | verboseModuleDiscovery () const |
Return True if slicer should display details regarding the module discovery process. More... | |
~qSlicerCoreCommandOptions () override | |
Protected Member Functions | |
virtual void | addArguments () |
QHash< QString, QVariant > | parsedArgs () const |
Protected Attributes | |
QScopedPointer< qSlicerCoreCommandOptionsPrivate > | d_ptr |
Definition at line 33 of file qSlicerCoreCommandOptions.h.
typedef ctkCommandLineParser qSlicerCoreCommandOptions::Superclass |
Definition at line 64 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 61 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 45 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 46 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 47 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 42 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 43 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 56 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 44 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 48 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 36 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 51 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 54 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 50 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 52 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 53 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 49 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 39 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 37 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 62 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 40 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 38 of file qSlicerCoreCommandOptions.h.
|
readwrite |
Definition at line 41 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 57 of file qSlicerCoreCommandOptions.h.
|
read |
Definition at line 55 of file qSlicerCoreCommandOptions.h.
qSlicerCoreCommandOptions::qSlicerCoreCommandOptions | ( | ) |
|
override |
|
protectedvirtual |
Add arguments - Called from parse() method
Reimplemented in qSlicerCommandOptions.
QStringList qSlicerCoreCommandOptions::additionalModulePaths | ( | ) | const |
Return list of additional module path that should be considered when searching for modules to load.
bool qSlicerCoreCommandOptions::disableBuiltInCLIModules | ( | ) | const |
Return True if the loading of built-in Command Line Modules should be disabled.
bool qSlicerCoreCommandOptions::disableBuiltInLoadableModules | ( | ) | const |
Return True if the loading of built-in Loadable Modules should be disabled.
bool qSlicerCoreCommandOptions::disableBuiltInModules | ( | ) | const |
Return True if the loading of all built-in modules should be disabled.
bool qSlicerCoreCommandOptions::disableBuiltInScriptedLoadableModules | ( | ) | const |
Return True if the loading of built-in Scripted Loadable Modules should be disabled.
bool qSlicerCoreCommandOptions::disableCLIModules | ( | ) | const |
Return True if the loading of any Command Line Modules should be disabled.
bool qSlicerCoreCommandOptions::disableLoadableModules | ( | ) | const |
Return True if the loading of any Loadable Modules should be disabled.
bool qSlicerCoreCommandOptions::disableMessageHandlers | ( | ) | const |
Return True if slicer shouldn't catch messages printed to the terminal.
bool qSlicerCoreCommandOptions::disableModules | ( | ) | const |
Return True if the loading of any modules should be disabled.
bool qSlicerCoreCommandOptions::disableScriptedLoadableModules | ( | ) | const |
Return True if the loading of any Scripted Loadable Modules should be disabled.
bool qSlicerCoreCommandOptions::disableTerminalOutputs | ( | ) | const |
Return True if slicer shouldn't print messages on the terminal. Messages won't be displayed on either stdout or stderr and will only be captured in the error log model.
bool qSlicerCoreCommandOptions::displayApplicationInformation | ( | ) | const |
Return True if slicer should display application information in the terminal.
bool qSlicerCoreCommandOptions::displayHelpAndExit | ( | ) | const |
Return True if slicer should display help and exit.
bool qSlicerCoreCommandOptions::displayHomePathAndExit | ( | ) | const |
Return True if slicer should display home path and exit.
|
virtual |
Return True if slicer should display a message and exit. A message is displayed if any of the function named like display[Something]AndExit returns True.
bool qSlicerCoreCommandOptions::displayProgramPathAndExit | ( | ) | const |
Return True if slicer should display program path and exit.
bool qSlicerCoreCommandOptions::displaySettingsPathAndExit | ( | ) | const |
Return True if slicer should display settings path and exit.
bool qSlicerCoreCommandOptions::displayTemporaryPathAndExit | ( | ) | const |
Return True if slicer should display temporary path and exit.
bool qSlicerCoreCommandOptions::displayVersionAndExit | ( | ) | const |
Return True if slicer should display version and exit.
QString qSlicerCoreCommandOptions::extraPythonScript | ( | ) | const |
Return extra python script.
bool qSlicerCoreCommandOptions::ignoreRest | ( | ) | const |
Return True if the ignore rest argument has been passed.
bool qSlicerCoreCommandOptions::ignoreSlicerRC | ( | ) | const |
Return True if the loading of SlicerRC should be skipped.
bool qSlicerCoreCommandOptions::isTestingEnabled | ( | ) | const |
Return True if slicer is in testing mode. Typically set when running unit tests: ./Slicer –testing –launch ./bin/qSlicerXXXTests ...
bool qSlicerCoreCommandOptions::keepTemporarySettings | ( | ) | const |
Returns a value indicating whether temporary settings should be maintained.
Temporary settings are created when settingsDisabled() is true and are cleared by default.
QStringList qSlicerCoreCommandOptions::modulesToIgnore | ( | ) | const |
Return list of modules that should not be loaded.
bool qSlicerCoreCommandOptions::parse | ( | const QStringList & | arguments | ) |
Convenient method allowing to parse arguments.
|
protected |
Return the parsed arguments
QString qSlicerCoreCommandOptions::pythonCode | ( | ) | const |
Return python code snippet to execute after slicer is loaded.
QString qSlicerCoreCommandOptions::pythonScript | ( | ) | const |
Return path of the python script to execute after slicer is loaded.
bool qSlicerCoreCommandOptions::runPythonAndExit | ( | ) | const |
Return True if Slicer should execute python code or script and exit.
void qSlicerCoreCommandOptions::setExtraPythonScript | ( | const QString & | newExtraPythonScript | ) |
Set extra python script to be executed after slicer is loaded.
void qSlicerCoreCommandOptions::setRunPythonAndExit | ( | bool | value | ) |
bool qSlicerCoreCommandOptions::settingsDisabled | ( | ) | const |
Return a value indicating if slicer settings should be disabled.
When disabled, temporary settings file are created.
By default, temporary settings are cleared unless keepTemporarySettings() returns True.
bool qSlicerCoreCommandOptions::verbose | ( | ) | const |
Return True if slicer should display information at startup.
bool qSlicerCoreCommandOptions::verboseModuleDiscovery | ( | ) | const |
Return True if slicer should display details regarding the module discovery process.
|
protected |
Definition at line 212 of file qSlicerCoreCommandOptions.h.