qSlicerCoreCommandOptions Class Reference

#include <Base/QTCore/qSlicerCoreCommandOptions.h>

Inheritance diagram for qSlicerCoreCommandOptions:

Collaboration diagram for qSlicerCoreCommandOptions:

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
QString	extraPythonScriptProcessedArgumentsCount
bool	ignoreSlicerRC
QStringList	modulesToIgnore
QString	pythonCode
QString	pythonScript
bool	runPythonAndExit
bool	testingEnabled
bool	verboseModuleDiscovery

Public Member Functions
bool	displayHelpAndExit () const
	Return True if slicer should display help and exit.
QString	extraPythonScript () const
	Return extra python script.
bool	ignoreRest () const
	Return True if the ignore rest argument has been passed.
bool	ignoreSlicerRC () const
	Return True if the loading of SlicerRC should be skipped.
bool	parse (const QStringList &arguments)
	Convenient method allowing to parse arguments.
QString	pythonScript () const
	Return path of the python script to execute after slicer is loaded.
	qSlicerCoreCommandOptions ()
void	setExtraPythonScript (const QString &newExtraPythonScript)
	Set extra python script to be executed after slicer is loaded.
	~qSlicerCoreCommandOptions () override
QScopedPointer< qSlicerCoreCommandOptionsPrivate >	d_ptr
int	extraPythonScriptProcessedArgumentsCount () const
void	setExtraPythonScriptProcessedArgumentsCount (int argumentCount)
QString	pythonCode () const
bool	runPythonAndExit () const
	Return True if Slicer should execute python code or script and exit.
void	setRunPythonAndExit (bool value)
QStringList	additionalModulePaths () const
	Return list of additional module path that should be considered when searching for modules to load.
QStringList	modulesToIgnore () const
	Return list of modules that should not be loaded.
bool	disableModules () const
	Return True if the loading of any modules should be disabled.
bool	disableBuiltInModules () const
	Return True if the loading of all built-in modules should be disabled.
bool	disableCLIModules () const
	Return True if the loading of any Command Line Modules should be disabled.
bool	disableBuiltInCLIModules () const
	Return True if the loading of built-in Command Line Modules should be disabled.
bool	disableLoadableModules () const
	Return True if the loading of any Loadable Modules should be disabled.
bool	disableBuiltInLoadableModules () const
	Return True if the loading of built-in Loadable Modules should be disabled.
bool	disableScriptedLoadableModules () const
	Return True if the loading of any Scripted Loadable Modules should be disabled.
bool	disableBuiltInScriptedLoadableModules () const
	Return True if the loading of built-in Scripted Loadable Modules should be disabled.
bool	displayVersionAndExit () const
	Return True if slicer should display version and exit.
bool	displayProgramPathAndExit () const
	Return True if slicer should display program path and exit.
bool	displayHomePathAndExit () const
	Return True if slicer should display home path and exit.
bool	displaySettingsPathAndExit () const
	Return True if slicer should display settings path and exit.
bool	displayTemporaryPathAndExit () const
	Return True if slicer should display temporary path and exit.
virtual bool	displayMessageAndExit () const
bool	displayApplicationInformation () const
	Return True if slicer should display application information in the terminal.
bool	verboseModuleDiscovery () const
	Return True if slicer should display details regarding the module discovery process.
bool	verbose () const
	Return True if slicer should display information at startup.
bool	disableMessageHandlers () const
	Return True if slicer shouldn't catch messages printed to the terminal.
bool	disableTerminalOutputs () const
bool	settingsDisabled () const
bool	keepTemporarySettings () const
bool	isTestingEnabled () const
virtual void	addArguments ()
QHash< QString, QVariant >	parsedArgs () const

Detailed Description

Definition at line 33 of file qSlicerCoreCommandOptions.h.

Member Typedef Documentation

Superclass

typedef ctkCommandLineParser qSlicerCoreCommandOptions::Superclass

Definition at line 65 of file qSlicerCoreCommandOptions.h.

Property Documentation

additionalModulePaths

QStringList qSlicerCoreCommandOptions::additionalModulePaths

read

Definition at line 62 of file qSlicerCoreCommandOptions.h.

disableBuiltInCLIModules

bool qSlicerCoreCommandOptions::disableBuiltInCLIModules

read

Definition at line 46 of file qSlicerCoreCommandOptions.h.

disableBuiltInLoadableModules

bool qSlicerCoreCommandOptions::disableBuiltInLoadableModules

read

Definition at line 47 of file qSlicerCoreCommandOptions.h.

disableBuiltInScriptedLoadableModules

bool qSlicerCoreCommandOptions::disableBuiltInScriptedLoadableModules

read

Definition at line 48 of file qSlicerCoreCommandOptions.h.

disableCLIModules

bool qSlicerCoreCommandOptions::disableCLIModules

read

Definition at line 43 of file qSlicerCoreCommandOptions.h.

disableLoadableModules

bool qSlicerCoreCommandOptions::disableLoadableModules

read

Definition at line 44 of file qSlicerCoreCommandOptions.h.

disableMessageHandlers

bool qSlicerCoreCommandOptions::disableMessageHandlers

read

Definition at line 57 of file qSlicerCoreCommandOptions.h.

disableScriptedLoadableModules

bool qSlicerCoreCommandOptions::disableScriptedLoadableModules

read

Definition at line 45 of file qSlicerCoreCommandOptions.h.

displayApplicationInformation

bool qSlicerCoreCommandOptions::displayApplicationInformation

read

Definition at line 49 of file qSlicerCoreCommandOptions.h.

displayHelpAndExit

bool qSlicerCoreCommandOptions::displayHelpAndExit

read

Definition at line 36 of file qSlicerCoreCommandOptions.h.

displayHomePathAndExit

bool qSlicerCoreCommandOptions::displayHomePathAndExit

read

Definition at line 52 of file qSlicerCoreCommandOptions.h.

displayMessageAndExit

bool qSlicerCoreCommandOptions::displayMessageAndExit

read

Definition at line 55 of file qSlicerCoreCommandOptions.h.

displayProgramPathAndExit

bool qSlicerCoreCommandOptions::displayProgramPathAndExit

read

Definition at line 51 of file qSlicerCoreCommandOptions.h.

displaySettingsPathAndExit

bool qSlicerCoreCommandOptions::displaySettingsPathAndExit

read

Definition at line 53 of file qSlicerCoreCommandOptions.h.

displayTemporaryPathAndExit

bool qSlicerCoreCommandOptions::displayTemporaryPathAndExit

read

Definition at line 54 of file qSlicerCoreCommandOptions.h.

displayVersionAndExit

bool qSlicerCoreCommandOptions::displayVersionAndExit

read

Definition at line 50 of file qSlicerCoreCommandOptions.h.

extraPythonScript

QString qSlicerCoreCommandOptions::extraPythonScript

read

Definition at line 39 of file qSlicerCoreCommandOptions.h.

extraPythonScriptProcessedArgumentsCount

QString qSlicerCoreCommandOptions::extraPythonScriptProcessedArgumentsCount

read

Definition at line 40 of file qSlicerCoreCommandOptions.h.

ignoreSlicerRC

bool qSlicerCoreCommandOptions::ignoreSlicerRC

read

Definition at line 37 of file qSlicerCoreCommandOptions.h.

modulesToIgnore

QStringList qSlicerCoreCommandOptions::modulesToIgnore

read

Definition at line 63 of file qSlicerCoreCommandOptions.h.

pythonCode

QString qSlicerCoreCommandOptions::pythonCode

read

Definition at line 41 of file qSlicerCoreCommandOptions.h.

pythonScript

QString qSlicerCoreCommandOptions::pythonScript

read

Definition at line 38 of file qSlicerCoreCommandOptions.h.

runPythonAndExit

bool qSlicerCoreCommandOptions::runPythonAndExit

readwrite

Definition at line 42 of file qSlicerCoreCommandOptions.h.

testingEnabled

bool qSlicerCoreCommandOptions::testingEnabled

read

Definition at line 58 of file qSlicerCoreCommandOptions.h.

verboseModuleDiscovery

bool qSlicerCoreCommandOptions::verboseModuleDiscovery

read

Definition at line 56 of file qSlicerCoreCommandOptions.h.

Constructor & Destructor Documentation

qSlicerCoreCommandOptions()

qSlicerCoreCommandOptions::qSlicerCoreCommandOptions

(

)

~qSlicerCoreCommandOptions()

qSlicerCoreCommandOptions::~qSlicerCoreCommandOptions ( )

override

Member Function Documentation

addArguments()

virtual void qSlicerCoreCommandOptions::addArguments ( )

protectedvirtual

Add arguments - Called from parse() method

See also

parse(const QStringList&)

Reimplemented in qSlicerCommandOptions.

additionalModulePaths()

QStringList qSlicerCoreCommandOptions::additionalModulePaths

(

)

const

Return list of additional module path that should be considered when searching for modules to load.

disableBuiltInCLIModules()

bool qSlicerCoreCommandOptions::disableBuiltInCLIModules

(

)

const

Return True if the loading of built-in Command Line Modules should be disabled.

disableBuiltInLoadableModules()

bool qSlicerCoreCommandOptions::disableBuiltInLoadableModules

(

)

const

Return True if the loading of built-in Loadable Modules should be disabled.

disableBuiltInModules()

bool qSlicerCoreCommandOptions::disableBuiltInModules

(

)

const

Return True if the loading of all built-in modules should be disabled.

disableBuiltInScriptedLoadableModules()

bool qSlicerCoreCommandOptions::disableBuiltInScriptedLoadableModules

(

)

const

Return True if the loading of built-in Scripted Loadable Modules should be disabled.

disableCLIModules()

bool qSlicerCoreCommandOptions::disableCLIModules

(

)

const

Return True if the loading of any Command Line Modules should be disabled.

disableLoadableModules()

bool qSlicerCoreCommandOptions::disableLoadableModules

(

)

const

Return True if the loading of any Loadable Modules should be disabled.

disableMessageHandlers()

bool qSlicerCoreCommandOptions::disableMessageHandlers

(

)

const

Return True if slicer shouldn't catch messages printed to the terminal.

disableModules()

bool qSlicerCoreCommandOptions::disableModules

(

)

const

Return True if the loading of any modules should be disabled.

disableScriptedLoadableModules()

bool qSlicerCoreCommandOptions::disableScriptedLoadableModules

(

)

const

Return True if the loading of any Scripted Loadable Modules should be disabled.

disableTerminalOutputs()

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.

See also

qSlicerCoreApplication::errorLogModel()

ctkErrorLogModel::setTerminalOutputs()

displayApplicationInformation()

bool qSlicerCoreCommandOptions::displayApplicationInformation

(

)

const

Return True if slicer should display application information in the terminal.

displayHelpAndExit()

bool qSlicerCoreCommandOptions::displayHelpAndExit

(

)

const

Return True if slicer should display help and exit.

displayHomePathAndExit()

bool qSlicerCoreCommandOptions::displayHomePathAndExit

(

)

const

Return True if slicer should display home path and exit.

displayMessageAndExit()

virtual bool qSlicerCoreCommandOptions::displayMessageAndExit ( ) const

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.

See also

displayHelpAndExit()

displayVersionAndExit()

displayProgramPathAndExit()

displayHomePathAndExit()

displaySettingsPathAndExit()

displayTemporaryPathAndExit()

displayProgramPathAndExit()

bool qSlicerCoreCommandOptions::displayProgramPathAndExit

(

)

const

Return True if slicer should display program path and exit.

displaySettingsPathAndExit()

bool qSlicerCoreCommandOptions::displaySettingsPathAndExit

(

)

const

Return True if slicer should display settings path and exit.

displayTemporaryPathAndExit()

bool qSlicerCoreCommandOptions::displayTemporaryPathAndExit

(

)

const

Return True if slicer should display temporary path and exit.

displayVersionAndExit()

bool qSlicerCoreCommandOptions::displayVersionAndExit

(

)

const

Return True if slicer should display version and exit.

extraPythonScript()

QString qSlicerCoreCommandOptions::extraPythonScript

(

)

const

Return extra python script.

extraPythonScriptProcessedArgumentsCount()

int qSlicerCoreCommandOptions::extraPythonScriptProcessedArgumentsCount

(

)

const

Set/Get the number of arguments that are already processed and that will not be passed as additional arguments when executing extraPythonScript file.

ignoreRest()

bool qSlicerCoreCommandOptions::ignoreRest

(

)

const

Return True if the ignore rest argument has been passed.

ignoreSlicerRC()

bool qSlicerCoreCommandOptions::ignoreSlicerRC

(

)

const

Return True if the loading of SlicerRC should be skipped.

isTestingEnabled()

bool qSlicerCoreCommandOptions::isTestingEnabled

(

)

const

Return True if slicer is in testing mode. Typically set when running unit tests: ./Slicer –testing –launch ./bin/qSlicerXXXTests ...

Note

Using this option implies 'disable-settings' option.

See also

settingsDisabled()

keepTemporarySettings()

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.

modulesToIgnore()

QStringList qSlicerCoreCommandOptions::modulesToIgnore

(

)

const

Return list of modules that should not be loaded.

parse()

bool qSlicerCoreCommandOptions::parse

(

const QStringList &

arguments

)

Convenient method allowing to parse arguments.

parsedArgs()

QHash< QString, QVariant > qSlicerCoreCommandOptions::parsedArgs ( ) const

protected

Return the parsed arguments

See also

qSlicerCoreCommandOptions::parse(const QStringList&)

pythonCode()

QString qSlicerCoreCommandOptions::pythonCode

(

)

const

}@ Return python code snippet to execute after slicer is loaded

pythonScript()

QString qSlicerCoreCommandOptions::pythonScript

(

)

const

Return path of the python script to execute after slicer is loaded.

runPythonAndExit()

bool qSlicerCoreCommandOptions::runPythonAndExit

(

)

const

Return True if Slicer should execute python code or script and exit.

setExtraPythonScript()

void qSlicerCoreCommandOptions::setExtraPythonScript

(

const QString &

newExtraPythonScript

)

Set extra python script to be executed after slicer is loaded.

setExtraPythonScriptProcessedArgumentsCount()

void qSlicerCoreCommandOptions::setExtraPythonScriptProcessedArgumentsCount

(

int

argumentCount

)

setRunPythonAndExit()

void qSlicerCoreCommandOptions::setRunPythonAndExit

(

bool

value

)

See also

runPythonAndExit

settingsDisabled()

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.

verbose()

bool qSlicerCoreCommandOptions::verbose

(

)

const

Return True if slicer should display information at startup.

verboseModuleDiscovery()

bool qSlicerCoreCommandOptions::verboseModuleDiscovery

(

)

const

Return True if slicer should display details regarding the module discovery process.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerCoreCommandOptionsPrivate> qSlicerCoreCommandOptions::d_ptr

protected

Definition at line 219 of file qSlicerCoreCommandOptions.h.

---

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

• Base/QTCore/qSlicerCoreCommandOptions.h