Main GUI interface. More...

#include <MainWindow.h>

Inheritance diagram for MainWindow:

Collaboration diagram for MainWindow:

[legend]

Public Slots
void	setUnsavedStatus (bool unsavedStatus_h)

Signals
void	currentModelFilenameChanged (QString)

void	selectedScenarioName (const QString &scenarioName_h)

void	resized ()

Public Member Functions
	MainWindow ()
	Constructor. More...

void	setCurrentLogFileName (const QString &fileName)

void	setCurrentModelFileName (const QString &fileName)

bool	saveLogFile (const QString &logFileName)

QString	strippedName (const QString &fullFileName)

QString	getModelFileName ()

void	setModelFileName (const QString curModelFileName_h)

void	setOutputDirName (string outputDirName_h)

void	addLayer (QString layerName_h, QString layerLabel_h)

void	switchToLayer (QString layerName_h)

void	updatePixel (QString layerName_h, int x_h, int y_h, QColor color_h)

void	updateImage (QString layerName_h, const QImage &image_h)

void	switchToLayerFromLayerSelector (int layerIndex_h)

void	treeViewerItemChangeValue (string itemID, string newValue)
	Change value to an existing item in the Status Viewer. More...

void	treeViewerItemRemove (string itemID)

void	treeViewerAddItem (string text, string itemID, string parentID)
	e.g. manager_farmer_manager agents or agent_12345_ownedHa More...

void	processLogArea (const QString &message_h)

void	resetGUIForNewSimulation ()
	Reset the graphical elements for a new simulation // Send the request of getting the pixel info to the main thread. More...

void	receiveScenarioOptions (const QVector< QString > &scenarios_h)

Protected Member Functions
void	closeEvent (QCloseEvent *event)
	Manage the event of closing the application. More...

void	resizeEvent (QResizeEvent *event)
	Manage the event of resizing the application. More...

Private Types
enum	{ MaxRecentFiles = 5 }

Private Slots
void	open ()

bool	save ()

bool	saveAs ()

void	startModelMainThread ()

void	stopModelMainThread ()

void	pauseOrResumeModelMainThread ()

void	openRecentFile ()

void	hideDebugMsgs (bool hide)

void	about ()

void	showDocumentation ()

void	openResults ()

Private Member Functions
void	createStatusBar ()

bool	okToContinue ()

void	readSettings ()

void	writeSettings ()

void	updateRecentFileActions ()

Private Attributes
ThreadManager	modelMainThread

QLabel *	yearSBLabel
	Status bar current year label. More...

QLabel *	mainSBLabel
	Status bar main label. More...

bool	unsavedStatus

QString	outputDirName

QString	curLogFileName

QString	curModelFileName

QString	curBaseDirectory

QStringList	recentFiles

QAction *	recentFileActions [MaxRecentFiles]

QAction *	separatorAction

bool	debugMsgsEnable
	Allow debug messages to be show in the logArea. More...

ScenarioSelectionWidget *	scenarioWidget

map< string, QTreeWidgetItem * >	svIndex
	Map containing the ID and the pointers to the status viewer. More...

Detailed Description

Main GUI interface.

MainWindow derive from both the generic Qt QMainWindow and from Ui::MainWindow (the latter being the autmatically generated C++ code from QtDesigner).
It implements code and functionality that can not be done in the QtDesigner.

Definition at line 50 of file MainWindow.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
MaxRecentFiles

Definition at line 116 of file MainWindow.h.

116 { MaxRecentFiles = 5 };

MainWindow::MaxRecentFiles

Definition: MainWindow.h:116

Constructor & Destructor Documentation

MainWindow ( )

Constructor.

It setup the Gui from the QTDesiger autogenerated code and connect various GUI signal/slots

Definition at line 39 of file MainWindow.cpp.

                        {
   yearSBLabel=NULL;
   mainSBLabel=NULL;
   for (uint i=0;i<MaxRecentFiles;i++) recentFileActions[i] = NULL;
   separatorAction=NULL;
 
   setupUi(this);
   unsavedStatus=false;
   curModelFileName="data/ffsmInput.ods";
   curBaseDirectory = QApplication::applicationDirPath();
   curBaseDirectory.append("/data/");
   //curBaseDirectory = "data/";
   outputDirName="output/";
   setCurrentLogFileName("");
   createStatusBar();
   curLogFileName ="";
   debugMsgsEnable = true;
 
   for (int i = 0; i < MaxRecentFiles; ++i) {
     recentFileActions[i] = new QAction(this);
     recentFileActions[i]->setVisible(false);
     connect(recentFileActions[i], SIGNAL(triggered()), this, SLOT(openRecentFile()));
   }
 
   separatorAction = menuFile->addSeparator();
   for (int i = 0; i < MaxRecentFiles; ++i)
     menuFile->addAction(recentFileActions[i]);
   menuFile->addSeparator();
   menuFile->addAction(actionExit);
 
   readSettings();
   modelMainThread.setInputFileName(curModelFileName);
   //modelMainThread.setBaseDirectory(curBaseDirectory);
 
   // Status viewer....
   statusView->setColumnCount(2);
   statusView->setHeaderLabels(QStringList()<< tr ("Label") << tr ("Value"));
   statusView->clear();
   statusView->sortByColumn(0);
   statusView->setFocus(); //????
 
 
 
 
   /*
   DONE: statusView should be implemented like this:
 
   Model
     -> year
     -> total plots
     -> rented plots
     -> abandoned plots
   Managers
     -> Manager_farmer
       -> number of agents
   Agents
     Agent_0
       -> Type
       -> ID
       -> mould
       -> owned plots
       ...
     Agent_1
       -> Type
       -> ID
       -> mould
       -> owned plots
       ...
     ...
   */
 
   qRegisterMetaType<string>("string"); // allows string objects to be thread-safely queued within signal-slots comunications
   qRegisterMetaType<QString>("QString");
   qRegisterMetaType< QVector<QString> >("QVector<QString>");
 
 
   connect(actionRun, SIGNAL(triggered()), this, SLOT(startModelMainThread()));
   connect(actionPause, SIGNAL(triggered()), this, SLOT(pauseOrResumeModelMainThread()));
   connect(actionStop, SIGNAL(triggered()), this, SLOT(stopModelMainThread()));
   connect(actionExit, SIGNAL(triggered()), this, SLOT(close()));
   connect(actionSaveLog, SIGNAL(triggered()), this, SLOT(save()));
   connect(actionSaveLogAs, SIGNAL(triggered()), this, SLOT(saveAs()));
   connect(actionLoadConfiguration, SIGNAL(triggered()), this, SLOT(open()));
   connect(actionHideDebugMsgs, SIGNAL(triggered(bool)), this, SLOT(hideDebugMsgs(bool)));
   connect(actionAboutRegMAS, SIGNAL(triggered()), this, SLOT(about()));
   connect(actionRegMASDocumentation, SIGNAL(triggered()), this, SLOT(showDocumentation()));
   connect(actionFitMap, SIGNAL(triggered()), mapBox, SLOT(fitInWindow()));
   connect(this, SIGNAL(resized()),mapBox, SLOT(fitInWindow()));
   connect(viewResultsButton, SIGNAL(clicked()),this, SLOT(openResults()));
 
   connect(&modelMainThread, SIGNAL(upgradeLogArea(const QString&)), this, SLOT(processLogArea(const QString&)));
   connect(&modelMainThread, SIGNAL(addLayerToGui(QString, QString)), this, SLOT( addLayer(QString, QString)));  
   connect(layerSelector, SIGNAL(activated(int)), this, SLOT(switchToLayerFromLayerSelector(int)));
   connect(&modelMainThread, SIGNAL(updatePixelToGui(QString, int, int, QColor)), this, SLOT (updatePixel(QString, int, int, QColor)));
   connect(&modelMainThread, SIGNAL(updateImageToGui(QString, QImage)), this, SLOT (updateImage(QString, QImage)));
   connect(&modelMainThread, SIGNAL(setOutputDirNameToGui(string)), this, SLOT(setOutputDirName(string)));
   connect(&modelMainThread, SIGNAL(setGUIUnsavedStatus(bool)), this, SLOT(setUnsavedStatus(bool)));
   connect(&modelMainThread, SIGNAL(sendScenarioOptionsToGUI(const QVector<QString> &)), this, SLOT( receiveScenarioOptions(const QVector<QString> &)   ));
 
   // Scenario selection widget...
   scenarioWidget = new ScenarioSelectionWidget(this);
   connect(scenarioWidget->scenarioSelector, SIGNAL( activated(const QString&)), scenarioWidget, SLOT( close()));
   connect(scenarioWidget->scenarioSelector, SIGNAL( activated(const QString&)), &modelMainThread, SLOT( retrieveScenarioNameFromGUI(const QString &)));
   //connect(scenarioWidget, SIGNAL( selectedScenarioName(const QString&)), scenarioWidget, SLOT( close()));
   //connect(scenarioWidget, SIGNAL( selectedScenarioName(const QString&)), &modelMainThread, SLOT( retrieveScenarioNameFromGUI(const QString &)));
 
   // Model tree viewer...
   connect(&modelMainThread, SIGNAL( treeViewerItemChangeValueToGui(string, string)  ), this, SLOT( treeViewerItemChangeValue(string, string) ));
   connect(&modelMainThread, SIGNAL( treeViewerItemRemoveToGui(string)  ), this, SLOT( treeViewerItemRemove(string) ));
   connect(&modelMainThread, SIGNAL( treeViewerAddItemToGui(string, string, string)  ), this, SLOT( treeViewerAddItem(string, string, string) ));
   connect(&modelMainThread, SIGNAL( fitInWindowToGui()), mapBox, SLOT(fitInWindow()));
 
   connect(mapBox, SIGNAL(  queryRequestOnPx(int, int, bool) ), &modelMainThread, SLOT ( checkQuery(int, int, bool) ) );
   connect(&modelMainThread,SIGNAL(publishQueryResults(const QString&)), pxInfoArea, SLOT (setHtml(const QString&)));
   connect(&modelMainThread,SIGNAL(activateTab(int)), tabWidget, SLOT (setCurrentIndex(int)));
 
   connect(&modelMainThread, SIGNAL( resetGUIForNewSimulation()  ), this, SLOT( resetGUIForNewSimulation() ));
 
 }

Member Function Documentation

void about ( )

privateslot

Definition at line 570 of file MainWindow.cpp.

                  {
   QMessageBox::about(this, tr("About FFSM"),
     tr("<h2>FFSM</h2>"
        "<p>Copyright &copy; 2012 Laboratoire d'Economie Forestière - LEF"
        "<br/>"
        "<p>FFSM is a flexible, spatially explicit, coupled resource and economic simulator of the Forest Sector, "
        "designed for long-term simulations of effects of government policies "
        "over different forest systems."
        "<br>It is released under the GNU GPL licence."
        "<p>For documentation and credits please refer to the project site:"
        "<br><a href=\"http://www.ffsm-project.org\">http://www.ffsm-project.org</a>"
     ));
 }

void addLayer	(	QString	layerName_h,
		QString	layerLabel_h
	)

Perform all the operation needed when adding a new layer:

add a layer to mapBox;
add the layer to layerSelector;
(NOTNEEDED: add the layer to layerLegend); Not needed any longer, as legend was dropped in name of the Model Status Viewer

Definition at line 440 of file MainWindow.cpp.

                                                               {
   static int counter =0;
   mapBox->addLayer(layerName_h);
   layerSelector->addItem(layerLabel_h,layerName_h);
   // first layer added only. it is not needed as MapBox::addLayer() and QComboBox automatically switch to the new value if it is the first one :-))
   //if (counter == 0) switchToLayer(layerName_h); 
   update();
   counter ++;
 }

void closeEvent ( QCloseEvent * event )

protected

Manage the event of closing the application.

Definition at line 181 of file MainWindow.cpp.

                                          {
   if (okToContinue()) {
     writeSettings();
     modelMainThread.stop();
     modelMainThread.wait();
     event->accept();
   } else {
     event->ignore();
     }
 } 

void createStatusBar ( )

private

Definition at line 160 of file MainWindow.cpp.

                             {
   yearSBLabel = new QLabel(" 2000 ");
   yearSBLabel->setAlignment(Qt::AlignHCenter);
   yearSBLabel->setMinimumSize(yearSBLabel->sizeHint());
 
   mainSBLabel = new QLabel;
   mainSBLabel->setIndent(3);
 
   statusBar()->addWidget(yearSBLabel);
   statusBar()->addWidget(mainSBLabel, 1);
 
   yearSBLabel->setText("0");
   mainSBLabel->setText("Welcome to FFSM!");
 
   connect(&modelMainThread, SIGNAL(upgradeYearSBLabelToGui(const QString&)), yearSBLabel, SLOT(setText(const QString&)));
   connect(&modelMainThread, SIGNAL(upgradeMainSBLabelToGui(const QString&)), mainSBLabel, SLOT(setText(const QString&)));
 
 }

void currentModelFilenameChanged ( QString )

signal

QString getModelFileName ( )

inline

Definition at line 61 of file MainWindow.h.

61 {return curModelFileName;};

MainWindow::curModelFileName

QString curModelFileName

Definition: MainWindow.h:113

void hideDebugMsgs ( bool hide )

privateslot

Definition at line 564 of file MainWindow.cpp.

                                   {
   if(hide) debugMsgsEnable = false;
   else debugMsgsEnable = true;
 }

bool okToContinue ( )

private

Definition at line 251 of file MainWindow.cpp.

                          {
   if (modelMainThread.isRunning()) {
     int t = QMessageBox::warning(
       this,                                       // parent
       tr("FFSM"),                               // title
       tr("The model is still running.\n"    // message
         "Do you want to stop it?"),
       QMessageBox::Yes | QMessageBox::Default,    // 1st button
       QMessageBox::Cancel | QMessageBox::Escape   // 3rd button
     );
     if (t == QMessageBox::Yes) {
       modelMainThread.stop();
       modelMainThread.wait();
     } else if (t == QMessageBox::Cancel) {
       return false;
     }
   }
 
   if (unsavedStatus) {
     int r = QMessageBox::warning(
       this,                                       // parent
       tr("FFSM"),                               // title
       tr("The model log has not been saved.\n"    // message
         "Do you want to save it?"),
       QMessageBox::Yes ,                          // 1st button
       QMessageBox::No | QMessageBox::Default,     // 2nd button
       QMessageBox::Cancel | QMessageBox::Escape   // 3rd button
     );
     if (r == QMessageBox::Yes) {
       return save();
     } else if (r == QMessageBox::Cancel) {
       return false;
     }
   }
   return true;
 }

void open ( )

privateslot

Definition at line 289 of file MainWindow.cpp.

                  {
   if (okToContinue()) {
     QString fileName = QFileDialog::getOpenFileName(
       this,
       tr("Load model file.."),
       "data/",
       tr("OpenDocument Spreadsheet (*.ods)\n" "All files (*.*)")
     );
     if (!fileName.isEmpty()){
       statusBar()->showMessage(tr("Loaded new FFSM model file"), 2000);
       setCurrentModelFileName(fileName);
       // getting the baseData path information...
       QFileInfo info(fileName);
       QString path;
       path = info.absolutePath();
       path = path+"/";
       curBaseDirectory = path;
       //modelMainThread.setBaseDirectory(curBaseDirectory);
     }
     }
 }

void openRecentFile ( )

privateslot

Definition at line 319 of file MainWindow.cpp.

                            {
   if (okToContinue()) {
     QAction *action = qobject_cast<QAction *>(sender());
     if (action){
       curModelFileName=action->data().toString();
       setCurrentModelFileName(curModelFileName);
       // getting the baseData path information...
       QFileInfo info(curModelFileName);
       QString path;
       path = info.absolutePath();
       path = path+"/";
       curBaseDirectory = path;
       //modelMainThread.setBaseDirectory(curBaseDirectory);
     }
   }
 }

void openResults ( )

privateslot

Definition at line 680 of file MainWindow.cpp.

                         {
   //QLabel *label = new QLabel("Hello World!");
   //label->show();
   //string aaa = curBaseDirectory.toStdString();
   //cout << "curBaseDirectory " << aaa << endl;
   //cout << "outputDirName: " << outputDirName.toStdString() << endl;
   QUrl resultsUrl(curBaseDirectory+outputDirName+"results/results.ods", QUrl::TolerantMode);
   QDesktopServices::openUrl(resultsUrl);
 
 }

void pauseOrResumeModelMainThread ( )

privateslot

Definition at line 416 of file MainWindow.cpp.

                                          {
   modelMainThread.pauseOrResume();
 }

void processLogArea ( const QString & message_h )

Definition at line 552 of file MainWindow.cpp.

                                                   {
   if(debugMsgsEnable){
     logArea->append(message_h);
   }
   else {
     if( ! message_h.startsWith("*DEBUG")){
       logArea->append(message_h);
     }
   }
 }

void readSettings ( )

private

Definition at line 312 of file MainWindow.cpp.

                          {
   QSettings settings("LEF", "FFSM");
   recentFiles = settings.value("recentFiles").toStringList();
   updateRecentFileActions();
 }

void receiveScenarioOptions ( const QVector< QString > & scenarios_h )

Definition at line 664 of file MainWindow.cpp.

                                                                      {
 
   //for(uint i=0;i<scenarios_h.size();i++){
   //  cout << scenarios_h.at(i).toStdString() << endl;
   //} // stange.. it works like expected !!!!
 
   scenarioWidget->receiveScenarioOptions(scenarios_h);
   scenarioWidget->show();
   scenarioWidget->scenarioSelector->setFocus();
   //scenarioWidget->scenarioSelector->grabMouse();
   //scenarioWidget->scenarioSelector->grabKeyboard();
 
 
 }

void resetGUIForNewSimulation ( )

Reset the graphical elements for a new simulation // Send the request of getting the pixel info to the main thread.

Definition at line 607 of file MainWindow.cpp.

                                     {
 
   static int simulationCounter = 0;
   //reset map <string, QTreeWidgetItem*>       svIndex and clean the tree widget
   statusView->clear();
   map<string, QTreeWidgetItem*>::iterator p;
   //for(p=svIndex.begin(); p= svIndex.end(); p++){
     //delete p->second; // no need because they are destroyed already from statusView->clear();
   //}
   svIndex.clear();
 
   QTreeWidgetItem* svGeneralNode = new QTreeWidgetItem(statusView);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general", svGeneralNode));
   svGeneralNode -> setText(0, "General");
   QTreeWidgetItem* svYearItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_year", svYearItem));
   svYearItem->setText(0, "year");
   svYearItem->setText(1, "0");
   QTreeWidgetItem* svTotalPlotsItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_total plots", svTotalPlotsItem));
   svTotalPlotsItem->setText(0, "total plots");
   svTotalPlotsItem->setText(1, "0");
   QTreeWidgetItem* svTotalLandItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_total land", svTotalLandItem));
   svTotalLandItem->setText(0, "total land");
   QTreeWidgetItem* svTotalAgrLandItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_total agr land", svTotalAgrLandItem));
   svTotalAgrLandItem->setText(0, "total agr land");
   QTreeWidgetItem* svOwnedAgrLandItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_owned agr land", svOwnedAgrLandItem));
   svOwnedAgrLandItem->setText(0, "owned agr land");
   QTreeWidgetItem* svRentedAgrLandItem = new QTreeWidgetItem(svGeneralNode);
   svIndex.insert(pair<string, QTreeWidgetItem*>("general_rented agr land", svRentedAgrLandItem));
   svRentedAgrLandItem->setText(0, "rented agr land");
 
   QTreeWidgetItem* svManagersNode = new QTreeWidgetItem(statusView);
   svIndex.insert(pair<string, QTreeWidgetItem*>("managers", svManagersNode));
   svManagersNode->setText(0,"Managers");
 
   QTreeWidgetItem* svAgentsNode = new QTreeWidgetItem(statusView);
   svIndex.insert(pair<string, QTreeWidgetItem*>("agents", svAgentsNode));
   svAgentsNode->setText(0,"Agents");
 
   // reset layer selector
   layerSelector->clear();
   // reset pixel info area
   pxInfoArea->setHtml("<i>Tip: Right click over a plot to retrieve its values across layers.</i>");
   // reset log area
   logArea->clear();
   // reset map
 
   if (simulationCounter) logArea->append("***WARNING: You are running more simulations from the GUI without closing/reopening it. It should works, but there are no guarantees. The best way is to run only one simulation from the GUI, eventually closing and opening FFSM again for further simulations.");
   simulationCounter++;
   
 }

void resized ( )

signal

void resizeEvent ( QResizeEvent * event )

protected

Manage the event of resizing the application.

Definition at line 193 of file MainWindow.cpp.

                                             {
   emit resized();
 }

bool save ( )

privateslot

Definition at line 337 of file MainWindow.cpp.

                  {
   if (curLogFileName.isEmpty()) {
     return saveAs();
   } else {
     cerr <<(curLogFileName.toStdString())<<endl;
     cerr <<(outputDirName.toStdString())<<endl;
     return saveLogFile(curLogFileName);
   }
   unsavedStatus = false;
   return true;
 }

bool saveAs ( )

privateslot

Definition at line 350 of file MainWindow.cpp.

                    {
   QString logFileName = QFileDialog::getSaveFileName(
     this,
     tr("Save output log"),
     outputDirName,
     tr("Log files (*.log)\n" "All files (*.*)")
   );
   if (logFileName.isEmpty())
     return false;
   return saveLogFile(logFileName);
   unsavedStatus = false;
   return true;
 }

bool saveLogFile ( const QString & logFileName )

Definition at line 365 of file MainWindow.cpp.

                                                   {
   QFile file(logFileName);
   if (!file.open(QIODevice::WriteOnly)) {
   QMessageBox::warning(this, tr("FFSM"),
      tr("Cannot write log file file %1:\n%2.")
     .arg(file.fileName())
     .arg(file.errorString()));
     return false;
   }
   //QString logAreaContent = logArea->toHtml();
   QString logAreaContent = logArea->toPlainText(); // Also available "toHtml()"
   QTextStream stream( &file );
   stream << logAreaContent;
   file.close();
 
   setCurrentLogFileName(logFileName);
   statusBar()->showMessage(tr("Log file saved"), 2000);
   unsavedStatus = false;
   return true;
 }

void selectedScenarioName ( const QString & scenarioName_h )

signal

void setCurrentLogFileName ( const QString & fileName )

Definition at line 201 of file MainWindow.cpp.

                                                          {
   curLogFileName = fileName;
 }

void setCurrentModelFileName ( const QString & fileName )

Definition at line 206 of file MainWindow.cpp.

                                                            {
   curModelFileName = fileName;
   //setWindowModified(false);
   modelMainThread.setInputFileName(curModelFileName);
   
   QString shownName = "Untitled";
   if (!curModelFileName.isEmpty()) {
     shownName = strippedName(curModelFileName);
     recentFiles.removeAll(curModelFileName);
     recentFiles.prepend(curModelFileName);
     updateRecentFileActions();
   }
   setWindowTitle(tr("%2 - [%1]").arg(shownName).arg(tr("FFSM - Forest Sector Simulator")));
 }

void setModelFileName ( const QString curModelFileName_h )

inline

Definition at line 62 of file MainWindow.h.

62 {curModelFileName=curModelFileName_h;};

MainWindow::curModelFileName

QString curModelFileName

Definition: MainWindow.h:113

void setOutputDirName ( string outputDirName_h )

inline

Definition at line 66 of file MainWindow.h.

66 {outputDirName = outputDirName_h.c_str();};

MainWindow::outputDirName

QString outputDirName

Definition: MainWindow.h:111

Here is the call graph for this function:

void setUnsavedStatus ( bool unsavedStatus_h )

inlineslot

Definition at line 65 of file MainWindow.h.

65 {unsavedStatus = unsavedStatus_h;};

MainWindow::unsavedStatus

bool unsavedStatus

Definition: MainWindow.h:110

void showDocumentation ( )

privateslot

Definition at line 585 of file MainWindow.cpp.

                              {
   QMessageBox::question(this, tr("FFSM Documentation"), // QMessageBox::information or QMessageBox::question
     tr("<h2>FFSM Documentation</h2>"
        "<p align=\"justify\">FFSM documentation is organised in three main categories: "
        "<p align=\"left\">(1) <b>official documentation</b> "
        "(comprising the <i>User Manual</i> and the <i>Reference Manual</i>); <br>(2) <b>contributed "
        "documentation</b> (<i>wiki</i>);<br>(3) <b>community project</b> (<i>forum</i> and <i>mailing list</i>). "
        "<p align=\"justify\">The documentation is located at "
        "<a href=\"http://www.ffsm-project.org/doc\">http://www.ffsm-project.org/doc</a>"
        "<p align=\"justify\">If you have chosen to instal a local copy of the documentation, "
        "you can access it also from the <i>Start menu</i>-><i>Programs</i>-><i>FFSM</i> "
        "(MS Windows) or directly from the following links (Linux):"
        "<br><a href=\"doc/userManual/regmasUserManual.pdf\">User Manual</a> "
        "&nbsp;-&nbsp;<a href=\"doc/referenceManual/html/index.html\">Reference Manual</a> "
        "<p>Tips:"
        "<br> - right click on a pixel to get its value across the layers;"
        "<br> - use the mouse and its wheel over the map to zoom/scroll it;"
        "</p>"
     ));
 }

void startModelMainThread ( )

privateslot

Definition at line 394 of file MainWindow.cpp.

                                  {
   if (modelMainThread.isRunning()) {
     return ;
     cout <<"It seems that the model is already running..."<<endl;
     } else {  
     logArea->clear();
     modelMainThread.start();
     unsavedStatus=true;
     }
 }

void stopModelMainThread ( )

privateslot

Definition at line 406 of file MainWindow.cpp.

                                 {
   if (! modelMainThread.isRunning()) {
     return ;
   } else {
     modelMainThread.stop();
     modelMainThread.wait();
   }
 }

QString strippedName ( const QString & fullFileName )

Definition at line 222 of file MainWindow.cpp.

                                                     {
   return QFileInfo(fullFileName).fileName();
 }

void switchToLayer ( QString layerName_h )

Perform all the operation needed when switching layer:

call mapBox to switch its current layer;
call layerLegend to switch its layer); I don't think it is used anywhere, but any how.. it is here...

Definition at line 457 of file MainWindow.cpp.

                                              {
   mapBox->switchToLayer(layerName_h);
   int index = mapBox->getLayerIndex(layerName_h);
   layerSelector->setCurrentIndex(index);
   update();
 }

void switchToLayerFromLayerSelector ( int layerIndex_h )

Definition at line 465 of file MainWindow.cpp.

                                                            {
   QString layerName= layerSelector->itemData(layerIndex_h, Qt::UserRole ).toString();
   mapBox->switchToLayer(layerName);
   update();
 } 

void treeViewerAddItem	(	string	text,
		string	itemID,
		string	parentID
	)

e.g. manager_farmer_manager agents or agent_12345_ownedHa

Definition at line 528 of file MainWindow.cpp.

                                                                         {
   // searching for the parent item...
   map<string, QTreeWidgetItem*>::iterator p;
   QTreeWidgetItem *parentItem;
 
   p=svIndex.find(parentID);
   if(p != svIndex.end()){
     parentItem = p->second;
     QTreeWidgetItem *node = new QTreeWidgetItem(parentItem);
     svIndex.insert(pair<string, QTreeWidgetItem*>(itemID, node));
     node->setText(0, text.c_str());
   }
   else {
     QString tempString;
     QString tempString2 = itemID.c_str();
     QString tempString3 = parentID.c_str();
     tempString = "**** ERROR, Coud not add sub item "+tempString2+" to the Model Status Viewer. Parent item ("+tempString3+") doesn't found.";
     logArea->append(tempString);
   }
 
 }

void treeViewerItemChangeValue	(	string	itemID,
		string	newValue
	)

Change value to an existing item in the Status Viewer.

Definition at line 485 of file MainWindow.cpp.

                                                                     {
 
   map<string, QTreeWidgetItem*>::iterator p;
   p=svIndex.find(itemID);
   if(p != svIndex.end())
     p->second->setText(1,newValue.c_str());
   else {
     QString tempString;
     QString tempString2 = itemID.c_str();
     tempString = "**** ERROR, Coud not change value for item "+tempString2+" in the Model Status Viewer. Item doesn't found.";
     logArea->append(tempString);
   }
   return;
   
 }

void treeViewerItemRemove ( string itemID )

Definition at line 502 of file MainWindow.cpp.

                                               {
   map<string, QTreeWidgetItem*>::iterator p;
   p=svIndex.find(itemID);
   if(p != svIndex.end()){
     QTreeWidgetItem *parent = p->second->parent();
     int index;
     if (parent) {
       index = parent->indexOfChild(p->second); //DONE: check if it works !!! While it should not ???? After 15 years of simulation agents should be deleted, but htey are still here in the tree.. mayme it is true it is NOT working!!! To be checken. 20071108: It works, it works.. agents are deleted when go out of the model
       delete parent->takeChild(index);
       svIndex.erase(p);
     } else {
       QString tempString = "**** ERROR, I will not delete a top level item in the Model Satus Viewer";
       logArea->append(tempString);
     }
 
   }
   else {
     QString tempString;
     QString tempString2 = itemID.c_str();
     tempString = "**** ERROR, Coud not delete for item "+tempString2+" in the Model Status Viewer. Item doesn't found.";
     //logArea->append(tempString); //20080111 lots of this errors when re-starting a simulation, so hidding them
   }
   return;
 }

void updateImage	(	QString	layerName_h,
		const QImage &	image_h
	)

Definition at line 478 of file MainWindow.cpp.

                                                                   {
   mapBox->updateImage(layerName_h, image_h);
   update();
 }

void updatePixel	(	QString	layerName_h,
		int	x_h,
		int	y_h,
		QColor	color_h
	)

Definition at line 472 of file MainWindow.cpp.

                                                                              {
   mapBox->updatePixel(layerName_h,x_h,y_h,color_h.rgb());
   update();
 }

void updateRecentFileActions ( )

private

Definition at line 227 of file MainWindow.cpp.

                                     {
   QMutableStringListIterator i(recentFiles);
   while (i.hasNext()) {
     if (!QFile::exists(i.next()))
       i.remove();
   }
 
   for (int j = 0; j < MaxRecentFiles; ++j) {
     if (j < recentFiles.count()) {
       QString text = tr("&%1 %2")
             .arg(j + 1)
             .arg(strippedName(recentFiles.at(j)));
       //cerr <<text.toStdString()<<endl;
       recentFileActions[j]->setText(text);
       recentFileActions[j]->setData(recentFiles.at(j));
       recentFileActions[j]->setVisible(true);
     } else {
       recentFileActions[j]->setVisible(false);
     }
   }
   separatorAction->setVisible(!recentFiles.isEmpty());
 }

Here is the call graph for this function:

void writeSettings ( )

private

Definition at line 386 of file MainWindow.cpp.

                                {
   QSettings settings("LEF", "FFSM");
     settings.setValue("recentFiles", recentFiles);
 }

Member Data Documentation

QString curBaseDirectory

private

Definition at line 114 of file MainWindow.h.

QString curLogFileName

private

Definition at line 112 of file MainWindow.h.

QString curModelFileName

private

Definition at line 113 of file MainWindow.h.

bool debugMsgsEnable

private

Allow debug messages to be show in the logArea.

Definition at line 119 of file MainWindow.h.

QLabel* mainSBLabel

private

Status bar main label.

Definition at line 109 of file MainWindow.h.

ThreadManager modelMainThread

private

Definition at line 107 of file MainWindow.h.

QString outputDirName

private

Definition at line 111 of file MainWindow.h.

QAction* recentFileActions[MaxRecentFiles]

private

Definition at line 117 of file MainWindow.h.

QStringList recentFiles

private

Definition at line 115 of file MainWindow.h.

ScenarioSelectionWidget* scenarioWidget

private

Definition at line 120 of file MainWindow.h.

QAction* separatorAction

private

Definition at line 118 of file MainWindow.h.

map<string, QTreeWidgetItem*> svIndex

private

Map containing the ID and the pointers to the status viewer.

Ids are based on the name of the item:

general
general_{name}
managers
manager_{managerID}
manager_{managerID}_{name}
agents
agent_{agentUniqueID}
agent_{agentUniqueID}_{name}

Definition at line 132 of file MainWindow.h.

bool unsavedStatus

private

Definition at line 110 of file MainWindow.h.

QLabel* yearSBLabel

private

Status bar current year label.

Definition at line 108 of file MainWindow.h.

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

/srv/datadisk03/home/ffsm/code/ffsm_pp/src/MainWindow.h
/srv/datadisk03/home/ffsm/code/ffsm_pp/src/MainWindow.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Types

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation