SettingsController Class Reference

This controller manages the signals and model of the SettingsView. More...

#include <ArmarXGui/gui-plugins/ScenarioManager/controller/SettingsController.h>

Inheritance diagram for SettingsController:

Public Slots
void	addPackage (std::string name)
	Adds a new package to the settings.
void	clearPidCache ()
void	clearXmlCache ()
void	closeUnavailablePackages ()
void	removePackage (int row, int column, QModelIndex parent)
	Removes a package from the settings.
void	setExecutorStopStrategy (std::string killMethod, int delay, std::string stopMethod)
	Configures the Executor.
void	showPackageAdderView ()
	Shows a view that allows the user to add new packages.
void	showSettings ()
	Shows the settings dialog.
void	updateModel ()
	Updates the packages displayed in the settingsview by reloading all packages into the model.

Signals
void	packageAdded (std::string name)
	Emitted when a package gets added in the settings.
void	packageRemoved ()
	Emitted when a package gets removed.
void	setExecutorState (int killMethodIndex, int delay, int stopStrategyIndex)

Public Member Functions
void	init ()
	SettingsController (Data_Structure::PackageVectorPtr packages, Exec::ExecutorPtr executor, QObject *parent=0)
	Constructor that sets the data structure this controller operates on, the executor which gets configured by this controller and optionally the parent object.
	~SettingsController () override
	Destructor.

Detailed Description

This controller manages the signals and model of the SettingsView.

Any signals involving the settings need to be connected to the corresponding slots in this controller. This controller also manages settings that get saved between sessions, as well as the Executor configuration.

Constructor & Destructor Documentation

SettingsController()

SettingsController	(	Data_Structure::PackageVectorPtr	packages,
		Exec::ExecutorPtr	executor,
		QObject *	parent = 0 )

Constructor that sets the data structure this controller operates on, the executor which gets configured by this controller and optionally the parent object.

Parameters

packages	list of packages. Need to contain the Packages displayed in the SettingsView.
executor	executor which gets configured by the settings
parent	standard QT option to specify a parent

~SettingsController()

~SettingsController ( )

override

Destructor.

Member Function Documentation

addPackage

void addPackage ( std::string name )

slot

Adds a new package to the settings.

clearPidCache

void clearPidCache ( )

slot

clearXmlCache

void clearXmlCache ( )

slot

closeUnavailablePackages

void closeUnavailablePackages ( )

slot

init()

void init

(

)

packageAdded

void packageAdded ( std::string name )

signal

Emitted when a package gets added in the settings.

Allows other controllers to update their models with the new package.

Parameters

name	name of the new package

packageRemoved

void packageRemoved ( )

signal

Emitted when a package gets removed.

Other packages need to update their models.

removePackage

void removePackage ( int row, int column, QModelIndex parent )

slot

Removes a package from the settings.

Parameters

row	row of the package
column	column of the package
parent	index of the package to be removed

setExecutorState

void setExecutorState ( int killMethodIndex, int delay, int stopStrategyIndex )

signal

setExecutorStopStrategy

void setExecutorStopStrategy ( std::string killMethod, int delay, std::string stopMethod )

slot

Configures the Executor.

Parameters

killMethod	"StopAndKill" or "Stop"
delay	length of the delay in the StopAndKill stop-method
stopMethod	"By Name" or "By Pid"

showPackageAdderView

void showPackageAdderView ( )

slot

Shows a view that allows the user to add new packages.

showSettings

void showSettings ( )

slot

Shows the settings dialog.

updateModel

void updateModel ( )

slot

Updates the packages displayed in the settingsview by reloading all packages into the model.

---

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

• ArmarXGui/gui-plugins/ScenarioManager/controller/SettingsController.h
• ArmarXGui/gui-plugins/ScenarioManager/controller/SettingsController.cpp