ESN Class Reference

#include <esn.h>

Inheritance diagram for ESN:

Public Member Functions
	ESN (MainWindow *pMainWindow, QString binaryName, QString moduleTitle, QString serverName, int instanceID, int tabID=-1)
	Constructor.
	~ESN ()
	Destructor.
	ESN (Interface *pInterface)
	Constructor.
void	printGPUProperties (int deviceID)
	Prints properties of a given GPU devices.
void	printOptions ()
	Prints a list of possible arguments that can be set.
void	printConfiguration ()
	Prints general configuration.
void	setGPUMode (bool gpuMode)
	Sets GPU mode.
void	setDevice (int deviceID)
	Sets current GPU device.
void	setDevices (int deviceID[MAX_GPU_DEVICES])
	Sets mulitple GPU devices, enables P2P mode where possible.
void	setDebuggingLevel (int level)
	Sets the level of debugging.
void	setInputSource (int source)
	Sets the input source.
void	getActivityAsBottle (Bottle *bottle)
	Gets the activities as bottle.
int	getDevice ()
	Gets currently set GPU device.
int	getNumDevices ()
	Gets the number of detected GPU devices.
int	getDebuggingLevel ()
	Gets current debug level.
vector< string >	queryGPU ()
	Returns detected GPU devices as a list of their names.
Public Member Functions inherited from GUI
	GUI (MainWindow *pMainWindow, QString binaryName, QString moduleTitle, QString serverName, int instanceID, int tabID=-1)
	Constructor.
	~GUI ()
	Destructor.

Public Attributes
int	esnSize
bool	terminalMode
Public Attributes inherited from GUI
QString	binary
QString	title
QString	server
int	instance

Protected Slots
void	about ()
	Displays dialog showing basic information about module.
void	updateGUI ()
	Updates graphical user interface.
Protected Slots inherited from GUI
virtual void	about ()
	Shows message box with the information about module.
virtual void	show ()
	Shows menu.
virtual void	checkFocus (int tabID)
	Checks if the module tab is currently selected.
virtual void	statusChanged (int newStatus)
	Updates module based on the new status.
virtual void	createMenu ()
	Creates menu.
virtual void	createFileMenu ()
	Creates file menu.
virtual void	createEditMenu ()
	Creates edit menu.
virtual void	createHelpMenu ()
	Creates help menu.
virtual void	createModuleMenu ()
	Creates module menu.
virtual void	createDeviceSubmenu ()
	Creates device sub-menu.
virtual void	updateGUI ()
	Updates graphical user interface.
virtual void	updateProgressBarClients ()
	Updates progress bar clients.
virtual void	updateProgressBar (int currentProgress)
	Updates progress bar with the new value.

Additional Inherited Members
Public Slots inherited from GUI
void	setGpu (int deviceID)
	Sets GPU based on user selection.
void	setGpuList (QStringList gpuList)
	Sets GPU list and subsequently calls a function that constructs device sub-menu.
Signals inherited from GUI
void	tabSelected ()
void	tabDeselected ()
void	stateReceived (int newState)
void	abortRequested ()
Protected Member Functions inherited from GUI
void	createStartAction (QMenu *menu, QString actionName, QString statusTip, QString shortcut)
void	createStopAction (QMenu *menu, QString actionName, QString statusTip, QString shortcut)
Protected Attributes inherited from GUI
MainWindow *	mainWindow
Settings *	settingsBase
Interface *	interfaceBase
QSignalMapper *	deviceSignalMapper
QMenu *	fileMenu
QMenu *	editMenu
QMenu *	helpMenu
QMenu *	deviceSubMenu
QMenu *	moduleMenu
QAction *	startAction
QAction *	stopAction
QAction *	settingsAct
QAction *	deviceAct [MAX_GPU_DEVICES]
QAction *	abortAct
QAction *	quitAct
QAction *	aboutAct [2]
QString	tag
int	progress
int	status
bool	selected
bool	running
bool	remoteMode
bool	useModuleMenu
bool	moduleConnected

Detailed Description

ESN graphical user interface

Constructor & Destructor Documentation

ESN::ESN	(	MainWindow *	pMainWindow,
		QString	binaryName,
		QString	moduleTitle,
		QString	server,
		int	instanceID,
		int	tabID = -1
	)

Constructor.

Parameters

[in]	pMainWindow	- pointer to MainWindow
[in]	binaryName	- name of module executable
[in]	moduleTitle	- title of this module
[in]	server	- server where the module runs
[in]	instanceID	- module identification number
[in]	tabID	- module tab index

ESN::~ESN

(

)

Destructor.

ESN::ESN

(

Interface *

pInterface

)

Constructor.

Parameters

[in]

pInterface

- pointer to Interface object

Note

This constructor saves a pointer to the Interface object,

looks for GPU devices and sets default execution mode.

Member Function Documentation

void ESN::about ( )

protectedslot

Displays dialog showing basic information about module.

void ESN::getActivityAsBottle

(

Bottle *

bottle

)

Gets the activities as bottle.

Parameters

[out]

bottle

- activities

int ESN::getDebuggingLevel

(

)

Gets current debug level.

Returns

debug - debugging level

int ESN::getDevice

(

)

Gets currently set GPU device.

Returns

id - device id

int ESN::getNumDevices

(

)

Gets the number of detected GPU devices.

Returns

availableGPUs - number of available devices

void ESN::printConfiguration

(

)

Prints general configuration.

void ESN::printGPUProperties

(

int

deviceID

)

Prints properties of a given GPU devices.

Parameters

[in]

deviceID

- id of a device whose properties are to be printed

void ESN::printOptions

(

)

Prints a list of possible arguments that can be set.

vector< string > ESN::queryGPU

(

)

Returns detected GPU devices as a list of their names.

Returns

devices - names of GPU devices found on the system

void ESN::setDebuggingLevel

(

int

level

)

Sets the level of debugging.

Note

When level 0 = no messages, level 1 = critical messages, level 2 = all messages.

Parameters

[in]

level

- debugging level

void ESN::setDevice

(

int

deviceID

)

Sets current GPU device.

Parameters

[in]

deviceID

- device id

void ESN::setDevices

(

int

deviceID[MAX_GPU_DEVICES]

)

Sets mulitple GPU devices, enables P2P mode where possible.

Parameters

[in]

deviceID[]

- list of IDs of GPU devices to be added

void ESN::setGPUMode

(

bool

gpuMode

)

Sets GPU mode.

Parameters

[in]

gpuMode

- if true run in GPU mode else run in CPU mode

void ESN::setInputSource

(

int

source

)

Sets the input source.

Parameters

[in]

source

- input source

void ESN::updateGUI ( )

protectedslot

Updates graphical user interface.

Note

This is an overridden virtual function.

Member Data Documentation

int ESN::esnSize

bool ESN::terminalMode

---

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

• C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/include/esn.h
• C:/Users/mpeniak/Dropbox/Aquila/trunk/modules/esn/include/esn.h
• C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/src/esn.cpp
• C:/Users/mpeniak/Dropbox/Aquila/trunk/modules/esn/src/esn.cpp