.Simulation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Slots | Signals | Public Member Functions | Protected Attributes | Friends | List of all members
DataVisualizerGUI::FileProgressDialog Class Reference

This class is a wrapper of QProgressDialog with specialized methods for updating the displayed values. More...

#include <FileProgressDialog.h>

Inheritance diagram for DataVisualizerGUI::FileProgressDialog:

Public Slots

void Increment ()
 Increment the current value of the progress bar up by one.
 
void Complete ()
 Sets the progress bar to full/complete.
 

Signals

void Incremented (int value)
 Indicates that the current value has been incremented up.
 
void Incremented (const QString &message)
 Indicates the message produced when the current value is incremented up.
 

Public Member Functions

 FileProgressDialog (int numberOfFiles, QWidget *parent=NULL)
 Constructor. More...
 
 ~FileProgressDialog ()
 Destructor.
 

Protected Attributes

QProgressDialog * ProgressDialog_
 Instance of a dialog box with a progress bar.
 
int CurrentProgress_
 Current progress value. NOTE: Maintaining a counter here avoids race conditions that will occur when attempting to increment QProgressDialog::value() from different threads at different times during runtime.
 

Friends

class FileProgressDialogTest
 Allow the class unit test to have access to the progress dialog.
 

Detailed Description

This class is a wrapper of QProgressDialog with specialized methods for updating the displayed values.

Constructor & Destructor Documentation

FileProgressDialog::FileProgressDialog ( int  numberOfFiles,
QWidget *  parent = NULL 
)

Constructor.

Parameters
numberOfFilesindicates how many files need to be read. It serves to set the maximum value the progress bar can have.
parentis the parent widget that claims ownership of the dialog.

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