BALL::VIEW::DockingController Class Reference
[Modular Widgets]

#include <BALL/VIEW/WIDGETS/dockingController.h>

Inheritance diagram for BALL::VIEW::DockingController:


Public Types
Enumerations
enum	Algorithm { GEOMETRIC_FIT = 1 }
enum	ScoringFunction { DEFAULT = 0, AMBER_FF, MMFF94_FF, SELECTED_FF, RANDOM }
Public Slots
void	startDocking ()
Public Member Functions
virtual void	runDocking (bool is_redock)
DockDialog &	getDockDialog ()
	Get docking dialog.
virtual EnergeticEvaluation *	createEvaluationMethod (Index method)
Constructors, Destructors, and Assignment
	DockingController (QWidget parent=0, const char name=0)
	Default Constructor.
virtual	~DockingController ()
	Destructor.
const DockingController &	operator= (const DockingController &dock_controller)
	Assignment operator.
ModularWidget methods
virtual void	initializeWidget (MainControl &main_control)
virtual void	fetchPreferences (INIFile &file)
virtual void	writePreferences (INIFile &file)
virtual void	checkMenu (MainControl &main_control)
virtual void	onNotify (Message *message)
Protected Member Functions
bool	runScoring_ (ConformationSet *conformation_set)
Private Member Functions
	DockingController (const DockingController &dock_controller)
Private Attributes
DockDialog	dock_dialog_
DockResultDialog *	dock_result_dialog_
DockProgressDialog *	progress_dialog_
DockingAlgorithm *	dock_alg_
	Pointer to docking algorithm.
QAction *	action_
	Menu entry.
DockingThread *	thread_

Detailed Description

Class for docking two systems. It is responsible to show the docking dialog and start a docking caluclation with the options of the dialog. If BALLView was compiled with multithreading support it simultaneously shows the progress dialog. Finally it shows the result dialog.

Member Enumeration Documentation

enum BALL::VIEW::DockingController::Algorithm

Enumeration which contains the docking algorithms. The numbering corresponds to the order in the combobox of dock_dialog_ . If you want to add a new docking algorithm extend enumeration (0 corresponds to <select> item in ComboBox)

Enumerator:

GEOMETRIC_FIT

enum BALL::VIEW::DockingController::ScoringFunction

Enumeration which contains the scoring functions. The numbering corresponds to the order in the combobox of dock_dialog_ . If you want to add a new scoring function extend enumeration

Enumerator:

DEFAULT
AMBER_FF
MMFF94_FF
SELECTED_FF
RANDOM

Constructor & Destructor Documentation

BALL::VIEW::DockingController::DockingController	(	QWidget *	parent = `0`,
		const char *	name = `0`
	)

Default Constructor.

virtual BALL::VIEW::DockingController::~DockingController ( ) [virtual]

Destructor.

BALL::VIEW::DockingController::DockingController ( const DockingController & dock_controller ) [private]

Copy constructor Remark: Copy contructor is private because it is not completed. The copy constuctor of the QT widgets is private and cannot be called.

Member Function Documentation

virtual void BALL::VIEW::DockingController::checkMenu ( MainControl & main_control ) [virtual]

Updates the state of menu entry Docking in the popup menu Molecular Mechanics . Enables the menu entry if more than two composites are loaded. Disables the menu entry if less composites are loaded or if a simulation / calculation is running.

Reimplemented from BALL::VIEW::ModularWidget.

virtual EnergeticEvaluation* BALL::VIEW::DockingController::createEvaluationMethod ( Index method ) [virtual]

virtual void BALL::VIEW::DockingController::fetchPreferences ( INIFile & file ) [virtual]

Fetches the preferences from the INIFile. Calls DockDialog::fetchPreferences . This method will be called inside the method MainControl::show .

See also:: writePreferences

Reimplemented from BALL::VIEW::ModularWidget.

DockDialog& BALL::VIEW::DockingController::getDockDialog ( )

Get docking dialog.

virtual void BALL::VIEW::DockingController::initializeWidget ( MainControl & main_control ) [virtual]

Initializes the popup menu Molecular Mechanics with its checkable submenu Docking . Calls DockDialog::initializeWidget . It is called automatically immediately before the main application is started.

Parameters:

main_control

the MainControl object to be initialized

See also:

openDialog

finalizeWidget

insertMenuEntry

Reimplemented from BALL::VIEW::ModularWidget.

virtual void BALL::VIEW::DockingController::onNotify ( Message * message ) [virtual]

Message handling method. Catches DockingFinishedMessage and ShowDockResultMessage .

Parameters:

message

the pointer to the message that should be processed

Reimplemented from BALL::VIEW::ConnectionObject.

const DockingController& BALL::VIEW::DockingController::operator= ( const DockingController & dock_controller )

Assignment operator.

virtual void BALL::VIEW::DockingController::runDocking ( bool is_redock ) [virtual]

Shows docking dialog, checks which algorithm is chosen and creates new DockingAlgorithm object. Starts new Thread and fills/shows progress_dialog_ .

Parameters:

is_redock

flag that indicates if a docking or redocking should be run

bool BALL::VIEW::DockingController::runScoring_ ( ConformationSet * conformation_set ) [protected]

Applies scoring function which user has chosen. Then, creates new DockResult and adds new scoring to it. At the end, adds the docked system to BALLView structures and sends a NewDockResultMessage to insert the DockResult in DatasetControl. Is called in onNotify .

Parameters:

conformation_set

conformation set that contains the result of the docking algorithm

Returns:

true if scoring function was succesfully applied

false if scoring function was not succesfully applied

void BALL::VIEW::DockingController::startDocking ( ) [slot]

Is called when docking is started by clicking on menu entry Docking . Calls runDocking(false) .

virtual void BALL::VIEW::DockingController::writePreferences ( INIFile & file ) [virtual]

Writes the preferences to the INIFile. Calls DockDialog::writePreferences . This method will be called inside the method MainControl::aboutToExit .