OmgExperimentDesigner Class Reference
[Gui]

#include <omgexperimentdesigner.h>

Inheritance diagram for OmgExperimentDesigner:

[legend]Collaboration diagram for OmgExperimentDesigner:

[legend]List of all members.

---

Detailed Description

a dialog that allows a user to set up a new experiment run.

Author:

Tim Sutton

Definition at line 55 of file omgexperimentdesigner.h.

Signals
void	experimentCreated (OmgExperiment *)
void	logMessage (QString)
void	experimentProgress (int theProgress)
void	experimentMaximum (int theSize)
Public Member Functions
	OmgExperimentDesigner (QWidget *parent=0, Qt::WFlags fl=0)
	~OmgExperimentDesigner ()
Protected Slots
void	on_pbnCancel_clicked ()
void	on_pbnOk_clicked ()
void	on_toolFormatLayer_clicked ()
void	setStatus (QString theMessage)
OmgExperiment *	getExperiment ()
void	on_cboModelLayerSet_currentIndexChanged (int theIndex)
void	on_cboProjectionLayerSet_currentIndexChanged (int theIndex)
void	refreshMapFormatCombo ()
void	toolConfigureLocalitiesClicked ()
void	toolSelectLocalitiesFileClicked ()
Private Member Functions
bool	checkLayersMatch ()
bool	setComboToDefault (QComboBox *theCombo, QString theDefault, bool theAddItemFlag)
void	setSpeciesList (QString theFileNameQString)
QStringList	getSpeciesList (QString theFileName)
void	readSettings ()
void	writeSettings ()
QStringList	getListWidgetEntries (const QListWidget *theListWidget)
Private Attributes
OmgAlgorithmSet	mAlgorithmSet
OmgSpatialReferenceSystem::WktMap	mWktMap
OmgModellerPluginInterface *	mpModellerPlugin
QString	mSpeciesFileName
bool	mFirstNonIdRecord

---

Constructor & Destructor Documentation

OmgExperimentDesigner::OmgExperimentDesigner (  QWidget *  parent = 0, Qt::WFlags  fl = 0 )

populate other form controls Definition at line 40 of file omgexperimentdesigner.cpp. References OmgAlgorithmSet::count(), Omgui::getAvailableLayerSets(), OmgAlgorithmSet::getFromActivePlugin(), OmgSpatialReferenceSystem::getWktMap(), OmgGuid::guid(), OmgAlgorithmSet::loadAlgorithms(), mAlgorithmSet, mFirstNonIdRecord, mWktMap, OmgLayerSet::name(), OmgAlgorithm::name(), OmgAlgorithm::origin(), readSettings(), toolConfigureLocalitiesClicked(), and toolSelectLocalitiesFileClicked().

Here is the call graph for this function:

OmgExperimentDesigner::~OmgExperimentDesigner (   )

Definition at line 152 of file omgexperimentdesigner.cpp.

---

Member Function Documentation

bool OmgExperimentDesigner::checkLayersMatch (   )  [private]

Checks to see if the input and output layers match. Returns: bool True if layers are semantically equivalent. Definition at line 502 of file omgexperimentdesigner.cpp.

void OmgExperimentDesigner::experimentCreated (  OmgExperiment *   )  [signal]

Referenced by on_pbnOk_clicked().

void OmgExperimentDesigner::experimentMaximum (  int  theSize  )  [signal]

A signal used to tell the progress monitor how many models this experiment will contain. Referenced by getExperiment().

void OmgExperimentDesigner::experimentProgress (  int  theProgress  )  [signal]

A signal used to keep track of the experiment creation progress (before the experiment is actually run). Referenced by getExperiment().

OmgExperiment * OmgExperimentDesigner::getExperiment (   )  [protected, slot]

Definition at line 216 of file omgexperimentdesigner.cpp. References OmgExperiment::addModel(), experimentMaximum(), experimentProgress(), OmgAlgorithmSet::getAlgorithm(), Omgui::getAvailableLayerSets(), getSpeciesList(), OmgModellerPluginRegistry::instance(), OmgModel::loadLocalities(), logMessage(), mAlgorithmSet, mpModellerPlugin, mSpeciesFileName, mWktMap, OmgModel::setAlgorithm(), OmgModel::setCoordinateSystem(), OmgModel::setCoordinateSystemName(), OmgModel::setCreationLayerSet(), OmgExperiment::setDescription(), OmgGuid::setGuid(), OmgModel::setLocalitiesFilterType(), OmgExperiment::setModellerPlugin(), OmgModel::setModelRasterFormat(), OmgExperiment::setName(), OmgModel::setOutputFormatLayerName(), OmgModel::setProjectionLayerSet(), OmgModel::setSpeciesFile(), and OmgModel::setTaxonName(). Referenced by on_pbnOk_clicked().

QStringList OmgExperimentDesigner::getListWidgetEntries (  const QListWidget *  theListWidget  )  [private]

Definition at line 616 of file omgexperimentdesigner.cpp.

QStringList OmgExperimentDesigner::getSpeciesList (  QString  theFileName  )  [private]

Look inside a text file and get a list of all unique taxon names in it. move this into omgui.cpp Parameters: QString  the file name of the file to be parsed Returns: QStringList - a list of all the names found. Definition at line 456 of file omgexperimentdesigner.cpp. Referenced by getExperiment(), and setSpeciesList().

void OmgExperimentDesigner::logMessage (  QString   )  [signal]

For logging messages to the progress monitor dialog Referenced by getExperiment().

void OmgExperimentDesigner::on_cboModelLayerSet_currentIndexChanged (  int  theIndex  )  [protected, slot]

Definition at line 593 of file omgexperimentdesigner.cpp. References refreshMapFormatCombo().

void OmgExperimentDesigner::on_cboProjectionLayerSet_currentIndexChanged (  int  theIndex  )  [protected, slot]

Definition at line 599 of file omgexperimentdesigner.cpp. References refreshMapFormatCombo().

void OmgExperimentDesigner::on_pbnCancel_clicked (   )  [protected, slot]

Definition at line 156 of file omgexperimentdesigner.cpp.

void OmgExperimentDesigner::on_pbnOk_clicked (   )  [protected, slot]

Definition at line 162 of file omgexperimentdesigner.cpp. References experimentCreated(), getExperiment(), mWktMap, and writeSettings().

void OmgExperimentDesigner::on_toolFormatLayer_clicked (   )  [protected, slot]

Definition at line 514 of file omgexperimentdesigner.cpp. References OmgLayerSelector::getBaseDir(), OmgLayerSelector::getSelectedLayers(), OmgLayerSelector::setSelectionMode(), and Omgui::sortList().

void OmgExperimentDesigner::readSettings (   )  [private]

Definition at line 538 of file omgexperimentdesigner.cpp. References setComboToDefault(), and setSpeciesList(). Referenced by OmgExperimentDesigner().

Here is the call graph for this function:

void OmgExperimentDesigner::refreshMapFormatCombo (   )  [protected, slot]

Definition at line 604 of file omgexperimentdesigner.cpp. References Omgui::getAvailableLayerSets(), OmgLayerSet::nameList(), Omgui::sortList(), and Omgui::uniqueList(). Referenced by on_cboModelLayerSet_currentIndexChanged(), and on_cboProjectionLayerSet_currentIndexChanged().

bool OmgExperimentDesigner::setComboToDefault (  QComboBox *  theCombo, QString  theDefault, bool  theAddItemFlag )  [private]

A helper function to set a combo box to an appropriate default value. Parameters: theCombo  - a QComboBox pointer that will have its default changed. theDefault  - a QString with the desired default theAddItemFlag  - a boolean indicating if the item should be added to the list if it doesnt exist already. Returns: true if it succeeded, false otherwise. Definition at line 626 of file omgexperimentdesigner.cpp. Referenced by readSettings().

void OmgExperimentDesigner::setSpeciesList (  QString  theFileNameQString  )  [private]

Definition at line 390 of file omgexperimentdesigner.cpp. References getSpeciesList(), mFirstNonIdRecord, mSpeciesFileName, and Omgui::sortList(). Referenced by readSettings(), and toolSelectLocalitiesFileClicked().

Here is the call graph for this function:

void OmgExperimentDesigner::setStatus (  QString  theMessage  )  [protected, slot]

Definition at line 340 of file omgexperimentdesigner.cpp.

void OmgExperimentDesigner::toolConfigureLocalitiesClicked (   )  [protected, slot]

Allow the user to set some options for localities data Definition at line 345 of file omgexperimentdesigner.cpp. Referenced by OmgExperimentDesigner().

void OmgExperimentDesigner::toolSelectLocalitiesFileClicked (   )  [protected, slot]

Definition at line 352 of file omgexperimentdesigner.cpp. References setSpeciesList(). Referenced by OmgExperimentDesigner().

void OmgExperimentDesigner::writeSettings (   )  [private]

Definition at line 578 of file omgexperimentdesigner.cpp. References mSpeciesFileName. Referenced by on_pbnOk_clicked().

---

Member Data Documentation

OmgAlgorithmSet OmgExperimentDesigner::mAlgorithmSet [private]

This is the collection of available algs Definition at line 104 of file omgexperimentdesigner.h. Referenced by getExperiment(), and OmgExperimentDesigner().

bool OmgExperimentDesigner::mFirstNonIdRecord [private]

Definition at line 135 of file omgexperimentdesigner.h. Referenced by OmgExperimentDesigner(), and setSpeciesList().

OmgModellerPluginInterface* OmgExperimentDesigner::mpModellerPlugin [private]

This is the Abstract adapter type. Depending on the users options, it will be initiasised to either the OmgModellerLocalPlugin or OmgModellerWebServices adapter (or possibly other adapter types in the future Definition at line 111 of file omgexperimentdesigner.h. Referenced by getExperiment().

QString OmgExperimentDesigner::mSpeciesFileName [private]

Definition at line 134 of file omgexperimentdesigner.h. Referenced by getExperiment(), setSpeciesList(), and writeSettings().

OmgSpatialReferenceSystem::WktMap OmgExperimentDesigner::mWktMap [private]

Definition at line 106 of file omgexperimentdesigner.h. Referenced by getExperiment(), OmgExperimentDesigner(), and on_pbnOk_clicked().

---

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

• gui/omgexperimentdesigner.h
• gui/omgexperimentdesigner.cpp

---