OmgClimateDataProcessorController Class Reference
[Library]

#include <omgclimatedataprocessorcontroller.h>

Inheritance diagram for OmgClimateDataProcessorController:

[legend]Collaboration diagram for OmgClimateDataProcessorController:

[legend]List of all members.

---

Detailed Description

The OmgClimateDataProcessorController calculates specific climate variables using *DataProcessor functions.

Author:

Tim Sutton

Definition at line 50 of file omgclimatedataprocessorcontroller.h.

Signals
void	numberOfVariablesToCalc (int theNumber)
void	numberOfCellsToCalc (int theNumber)
void	variableStart (QString theName)
void	variableDone (QString theFileName)
void	cellDone (float theResult)
Public Member Functions
	OmgClimateDataProcessorController ()
	~OmgClimateDataProcessorController ()
void	setMeanTempFileName (QString theFileName)
const QString	getMeanTempFileName ()
void	setMinTempFileName (QString theFileName)
const QString	getMinTempFileName ()
void	setMaxTempFileName (QString theFileName)
const QString	getMaxTempFileName ()
void	setDiurnalTempFileName (QString theFileName)
const QString	getDiurnalTempFileName ()
void	setMeanPrecipFileName (QString theFileName)
const QString	getMeanPrecipFileName ()
void	setFrostDaysFileName (QString theFileName)
const QString	getFrostDaysFileName ()
void	setTotalSolarRadFileName (QString theFileName)
const QString	getTotalSolarRadFileName ()
void	setWindSpeedFileName (QString theFileName)
const QString	getWindSpeedFileName ()
void	setOutputFilePathString (QString theFilePathString)
const QString	getOutputFilePathString ()
void	setFileStartYear (const int theYear)
const int	getFileStartYear ()
void	setJobStartYear (const int theYear)
const int	getJobStartYear ()
void	setJobEndYear (const int theYear)
const int	getJobEndYear ()
void	setInputFileType (const OmgClimateFileReader::FileType theInputFileType)
void	setInputFileType (const QString theInputFileTypeString)
const OmgClimateFileReader::FileType	getInputFileType ()
void	setOutputFileType (const OmgFileWriter::FileType theOutputFileType)
void	setOutputFileType (const QString theOutputFileTypeString)
const OmgFileWriter::FileType	getOutputFileType ()
bool	makeFileGroups ()
bool	makeAvailableCalculationsMap ()
QMap< QString, bool >	getAvailableCalculationsMap ()
bool	addUserCalculation (QString theCalculationName)
bool	run ()
QString	getDescription ()
void	setFilesInSeriesFlag (const bool theFlag)
const bool	getFilesInSeriesFlag ()
void	setOutputHeader (const QString &theOutputHeader)
const QString	getOutputHeader ()
Private Member Functions
void	printVectorAndResult (QVector< float > theVector, float theResult)
OmgClimateFileGroup *	initialiseFileGroup (QString theFileName, int theStartYear)
bool	makeInputFileTypeMap ()
bool	makeOutputFileTypeMap ()
QString	intToString (int theInt)
Private Attributes
QString	outputFilePath
OmgClimateFileReader::FileType	inputFileType
OmgFileWriter::FileType	outputFileType
QMap< QString, OmgClimateFileReader::FileType >	inputFileTypeMap
QMap< QString, OmgFileWriter::FileType >	outputFileTypeMap
QMap< QString, bool >	availableCalculationsMap
OmgClimateFileGroup *	meanTempFileGroup
QString	meanTempFileName
OmgClimateFileGroup *	minTempFileGroup
QString	minTempFileName
OmgClimateFileGroup *	maxTempFileGroup
QString	maxTempFileName
OmgClimateFileGroup *	diurnalTempFileGroup
QString	diurnalTempFileName
OmgClimateFileGroup *	meanPrecipFileGroup
QString	meanPrecipFileName
OmgClimateFileGroup *	frostDaysFileGroup
QString	frostDaysFileName
OmgClimateFileGroup *	totalSolarRadFileGroup
QString	totalSolarRadFileName
OmgClimateFileGroup *	windSpeedFileGroup
QString	windSpeedFileName
bool	filesInSeriesFlag
QString	outputHeader

---

Constructor & Destructor Documentation

OmgClimateDataProcessorController::OmgClimateDataProcessorController (   )

Default constructor Definition at line 33 of file omgclimatedataprocessorcontroller.cpp. References diurnalTempFileName, frostDaysFileName, inputFileType, maxTempFileName, meanPrecipFileName, meanTempFileName, minTempFileName, outputFilePath, totalSolarRadFileName, and windSpeedFileName.

OmgClimateDataProcessorController::~OmgClimateDataProcessorController (   )

Destructor Definition at line 54 of file omgclimatedataprocessorcontroller.cpp.

---

Member Function Documentation

bool OmgClimateDataProcessorController::addUserCalculation (  QString  theCalculationName  )

Add a calculation to the list of those requested to be carried out by the user. The available availableCalculationsMap will be searched for a string match, and if a match is found that map entry will be tagged as true - 'please calculate' if it is currently false. Parameters: theCalculationName  - the name of the calculation to be enabled. Returns: bool - Returns false if no matching calculation name is found. Definition at line 882 of file omgclimatedataprocessorcontroller.cpp. References availableCalculationsMap.

void OmgClimateDataProcessorController::cellDone (  float  theResult  )  [signal]

A signal emitted to notify listeners that we have completed calculating a given cell. * Parameters: theResult  - The calculated value for a cell * Returns: void - No return

QMap< QString, bool > OmgClimateDataProcessorController::getAvailableCalculationsMap (   )

Accessor for the list of available calculations. Returns: QMap<QString, bool> - wherethe string is the name of the calculation and bool indicates true if the user has asked for the calculation to be carried out, false if he hasnt. Definition at line 875 of file omgclimatedataprocessorcontroller.cpp. References availableCalculationsMap.

QString OmgClimateDataProcessorController::getDescription (   )

This is a helper method that will return a Description of the OmgClimateDataProcessorController vars. This will indicate things like whether the files are in series or not, what calculations are available in the available calculations map, and whether they are tagged true for execution or not. Returns: QString - containing the summary description for this climatedataprocessor. Definition at line 2508 of file omgclimatedataprocessorcontroller.cpp. References availableCalculationsMap, filesInSeriesFlag, getDiurnalTempFileName(), getFrostDaysFileName(), getInputFileType(), getMaxTempFileName(), getMeanPrecipFileName(), getMeanTempFileName(), getMinTempFileName(), getOutputFileType(), getTotalSolarRadFileName(), and getWindSpeedFileName().

Here is the call graph for this function:

const QString OmgClimateDataProcessorController::getDiurnalTempFileName (   )

Accessor for filename of the diurnalTemp calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 260 of file omgclimatedataprocessorcontroller.cpp. References diurnalTempFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const bool OmgClimateDataProcessorController::getFilesInSeriesFlag (   )

Accessor for bool filesInSeriesFlag. See also: setFilesInSeriesFlag Returns: bool - true if files are in series. Definition at line 904 of file omgclimatedataprocessorcontroller.cpp. References filesInSeriesFlag.

const int OmgClimateDataProcessorController::getFileStartYear (   )

Accessor for int fileStartYear.

const QString OmgClimateDataProcessorController::getFrostDaysFileName (   )

Accessor for filename of the frost days calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 282 of file omgclimatedataprocessorcontroller.cpp. References frostDaysFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const OmgClimateFileReader::FileType OmgClimateDataProcessorController::getInputFileType (   )

Accessor forOmgClimateFileReader::FileType inputFileType. Returns: aOmgClimateFileReader::FileType indicating the current input file type. Definition at line 518 of file omgclimatedataprocessorcontroller.cpp. References inputFileType. Referenced by getDescription().

const int OmgClimateDataProcessorController::getJobEndYear (   )

Accessor for int jobEndYear. Returns: int - the current value of the last year in the input files to be read.

const int OmgClimateDataProcessorController::getJobStartYear (   )

Accessor for int jobStartYear. Returns: int - the current value of the first year in the input files to be read.

const QString OmgClimateDataProcessorController::getMaxTempFileName (   )

Accessor for filename of the maxTemp calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 249 of file omgclimatedataprocessorcontroller.cpp. References maxTempFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const QString OmgClimateDataProcessorController::getMeanPrecipFileName (   )

Accessor for filename of the mean precipitation calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 271 of file omgclimatedataprocessorcontroller.cpp. References meanPrecipFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const QString OmgClimateDataProcessorController::getMeanTempFileName (   )

Accessor for filename of the meanTemp calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 227 of file omgclimatedataprocessorcontroller.cpp. References meanTempFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const QString OmgClimateDataProcessorController::getMinTempFileName (   )

Accessor for filename of the minTemp calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 238 of file omgclimatedataprocessorcontroller.cpp. References minTempFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const QString OmgClimateDataProcessorController::getOutputFilePathString (   )

Accessor for the file output path. Returns: a QString containing the directory name. Definition at line 318 of file omgclimatedataprocessorcontroller.cpp. References outputFilePath.

const OmgFileWriter::FileType OmgClimateDataProcessorController::getOutputFileType (   )

Accessor for OmgFileWriter::FileType outputFileType. Returns: OmgFileWriter::FileType - the current output file type Definition at line 548 of file omgclimatedataprocessorcontroller.cpp. References outputFileType. Referenced by getDescription().

const QString OmgClimateDataProcessorController::getOutputHeader (   )

Accessor for QString outputHeader. Returns: QString - the currently set file header. Definition at line 58 of file omgclimatedataprocessorcontroller.cpp. References outputHeader.

const QString OmgClimateDataProcessorController::getTotalSolarRadFileName (   )

Accessor for filename of the solar radiation calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 295 of file omgclimatedataprocessorcontroller.cpp. References totalSolarRadFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

const QString OmgClimateDataProcessorController::getWindSpeedFileName (   )

Accessor for filename of the wind speed calculation inputs. Returns: a QString containing the filename (which will be the first file in the series if the files are in series). Definition at line 307 of file omgclimatedataprocessorcontroller.cpp. References windSpeedFileName. Referenced by getDescription(), and makeAvailableCalculationsMap().

OmgClimateFileGroup * OmgClimateDataProcessorController::initialiseFileGroup (  QString  theFileName, int  theStartYear )  [private]

Set up an individual file group (called by makefileGroups for each filegroup that needs to be initialised) Definition at line 435 of file omgclimatedataprocessorcontroller.cpp. References OmgClimateFileGroup::add(), filesInSeriesFlag, OmgClimateFileReader::initialise(), inputFileType, and OmgClimateFileReader::setActiveBlock(). Referenced by makeFileGroups().

Here is the call graph for this function:

QString OmgClimateDataProcessorController::intToString (  int  theInt  )  [private]

Little utility method to convert from int to string

bool OmgClimateDataProcessorController::makeAvailableCalculationsMap (   )

Build a list of which calculations can be performed given the input files that have been registered. The boolean field indicates whether the user actually want to perform this calculation See also: addUserCalculation Definition at line 581 of file omgclimatedataprocessorcontroller.cpp. References availableCalculationsMap, diurnalTempFileName, frostDaysFileName, getDiurnalTempFileName(), getFrostDaysFileName(), getMaxTempFileName(), getMeanPrecipFileName(), getMeanTempFileName(), getMinTempFileName(), getTotalSolarRadFileName(), getWindSpeedFileName(), maxTempFileGroup, maxTempFileName, meanPrecipFileName, meanTempFileName, minTempFileName, totalSolarRadFileName, and windSpeedFileName.

Here is the call graph for this function:

bool OmgClimateDataProcessorController::makeFileGroups (   )

Set up the filegroups for each filename that has been registered Returns: bool - A boolean indicating success or failure of the operation Definition at line 329 of file omgclimatedataprocessorcontroller.cpp. References diurnalTempFileGroup, diurnalTempFileName, frostDaysFileGroup, frostDaysFileName, initialiseFileGroup(), maxTempFileGroup, maxTempFileName, meanPrecipFileGroup, meanPrecipFileName, meanTempFileGroup, meanTempFileName, minTempFileGroup, minTempFileName, totalSolarRadFileGroup, totalSolarRadFileName, windSpeedFileGroup, and windSpeedFileName.

Here is the call graph for this function:

bool OmgClimateDataProcessorController::makeInputFileTypeMap (   )  [private]

This is a private method. It is a simple method to populate the inputFileTypeMap attribute - this will usually be called by the constructor(s). All keys (file type strings) will be stored in upper case. Definition at line 68 of file omgclimatedataprocessorcontroller.cpp. References inputFileTypeMap. Referenced by setInputFileType().

bool OmgClimateDataProcessorController::makeOutputFileTypeMap (   )  [private]

This is a private method. It is a simple method to populate the outputFileTypeMap attribute - this will usually be called by the constructor(s). All keys (file type strings) will be stored in upper case. Definition at line 181 of file omgclimatedataprocessorcontroller.cpp. References outputFileTypeMap. Referenced by setOutputFileType().

void OmgClimateDataProcessorController::numberOfCellsToCalc (  int  theNumber  )  [signal]

A signal emitted to notify listeners how many cells will be passed through in each block. * Parameters: theNumber  - The total number of cells in any block * Returns: void - No return Referenced by run().

void OmgClimateDataProcessorController::numberOfVariablesToCalc (  int  theNumber  )  [signal]

A signal emitted to notify listeners how many variables are going to be calculated for each years data. * Parameters: theNumber  - The total number of variables * Returns: void - No return Referenced by run().

void OmgClimateDataProcessorController::printVectorAndResult (  QVector< float >  theVector, float  theResult )  [private]

This method is intended for debugging purposes only Definition at line 2495 of file omgclimatedataprocessorcontroller.cpp. Referenced by run().

bool OmgClimateDataProcessorController::run (   )

Start the data analysis process. When everything else is set up, this is the method to call! Todo: If there ever was a good place to optimise performance, this is it!For starters this method can be refactored so that the vector from each active filegroup is retrieved first, and then passed to any calculation that needs it, looping through all the filegroups simultaneously. This will prevent multiple reads of the same file for different calculations. RTFS for more info. Returns: bool - A boolean indicating success or failure of the operation. Definition at line 916 of file omgclimatedataprocessorcontroller.cpp. References availableCalculationsMap, diurnalTempFileGroup, diurnalTempFileName, OmgClimateFileGroup::elementCount(), OmgFileWriter::fileName(), OmgFileWriterStruct::fileWriter, OmgClimateDataProcessor::firstMonthOfHighestQ(), OmgClimateDataProcessor::firstMonthOfLowestQ(), frostDaysFileGroup, frostDaysFileName, OmgFileWriterStruct::fullFileName, OmgClimateFileGroup::getElementVector(), OmgClimateDataProcessor::greatestTotalRange(), OmgClimateDataProcessor::highestValue(), OmgClimateFileGroup::isAtMatrixEnd(), OmgClimateDataProcessor::lowestValue(), maxTempFileGroup, maxTempFileName, OmgClimateDataProcessor::mean(), OmgClimateDataProcessor::meanOverHighestQ(), OmgClimateDataProcessor::meanOverLowestQ(), OmgClimateDataProcessor::meanOverQuarter(), meanPrecipFileGroup, meanPrecipFileName, meanTempFileGroup, meanTempFileName, OmgClimateDataProcessor::meanValueOverFrostFreeMonths(), minTempFileGroup, minTempFileName, OmgClimateDataProcessor::monthWithHighestValue(), OmgClimateDataProcessor::monthWithLowestValue(), NO_DATA, numberOfCellsToCalc(), OmgClimateDataProcessor::numberOfMonthsAboveZero(), numberOfVariablesToCalc(), outputFilePath, outputFileType, outputHeader, printVectorAndResult(), OmgClimateFileGroup::rewind(), OmgClimateDataProcessor::stddevOverYear(), totalSolarRadFileGroup, totalSolarRadFileName, OmgClimateDataProcessor::valueGivenMonth(), variableDone(), variableStart(), windSpeedFileGroup, windSpeedFileName, OmgFileWriter::writeElement(), OmgFileWriter::writeString(), OmgClimateFileGroup::xDim(), and OmgClimateFileGroup::yDim().

Here is the call graph for this function:

void OmgClimateDataProcessorController::setDiurnalTempFileName (  QString  theFileName  )

Mutator for filename of the diurnalTemp calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 265 of file omgclimatedataprocessorcontroller.cpp. References diurnalTempFileName.

void OmgClimateDataProcessorController::setFilesInSeriesFlag (  const bool  theFlag  )

Mutator for bool filesInSeriesFlag. When files are in series, it means that the file format only contains one months data block per file and that there should be 12 such files to provide monthly data for an entire year. The files should be suffixed with the month numer they represent e.g. meanTemp01.asc meanTemp02.asc meanTemp03.asc meanTemp04.asc meanTemp05.asc meanTemp06.asc meanTemp07.asc meanTemp08.asc meanTemp09.asc meanTemp10.asc meanTemp11.asc meanTemp12.asc Parameters: theFlag  - a flag indicating true if files are in series, otherwise false. Returns: void - No return. Definition at line 909 of file omgclimatedataprocessorcontroller.cpp. References filesInSeriesFlag.

void OmgClimateDataProcessorController::setFileStartYear (  const int  theYear  )

Mutator for int fileStartYear. Parameters: theYear  - The year of the first 12 blocks of data in the file (or the 12 files if the files are in series). Returns: void - No return. Note: If the files are in series, jobStartYear should be the same as fileStartYear and jobEndYear!

void OmgClimateDataProcessorController::setFrostDaysFileName (  QString  theFileName  )

Mutator for filename of the frost days calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 289 of file omgclimatedataprocessorcontroller.cpp. References frostDaysFileName.

void OmgClimateDataProcessorController::setInputFileType (  const QString  theInputFileTypeString  )

Mutator forOmgClimateFileReader::FileType inputFileType. This is an overloaded version of above that takes a string and looks up the enum. Parameters: theInputFileTypeString  - The input filetype as a string. Valid options being: CRES African climate data ESRI & ASCII raster Hadley Centre HadCM3 SRES Scenario Hadley Centre HadCM3 IS92a Scenario IPCC Observed Climatology University of Reading Palaeoclimate data Max Planck Institute fur Meteorologie (MPIfM) ECHAM4 data CSIRO-Mk2 Model data National Center for Atmospheric Research (NCAR) NCAR-CSM and NCAR-PCM data Geophysical Fluid Dynamics Laboratory (GFDL) R30 Model data Canadian Center for Climate Modelling and Analysis (CCCma) CGCM2 Model data CCSR/NIES AGCM model data and CCSR OGCM model data Returns: void - No return Definition at line 529 of file omgclimatedataprocessorcontroller.cpp. References inputFileTypeMap, makeInputFileTypeMap(), and setInputFileType().

Here is the call graph for this function:

void OmgClimateDataProcessorController::setInputFileType (  const OmgClimateFileReader::FileType  theInputFileType  )

Mutator forOmgClimateFileReader::FileType inputFileType. Parameters: theInputFileType  - The input filetype as specified inOmgClimateFileReader::FileType Returns: void - No return Definition at line 523 of file omgclimatedataprocessorcontroller.cpp. References inputFileType. Referenced by setInputFileType().

void OmgClimateDataProcessorController::setJobEndYear (  const int  theYear  )

Mutator for int jobEndYear. Parameters: theYear  - The last year in the input file(s) to be read. Returns: void - No return Note: If the files are in series, jobStartYear should be the same as fileStartYear and jobEndYear!

void OmgClimateDataProcessorController::setJobStartYear (  const int  theYear  )

Mutator for int setJobStartYear. Parameters: theYear  - The first year in the input file(s) to be read. Returns: void - No return. Note: If the files are in series, jobStartYear should be the same as fileStartYear and jobEndYear!

void OmgClimateDataProcessorController::setMaxTempFileName (  QString  theFileName  )

Mutator for filename of the maxTemp calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 254 of file omgclimatedataprocessorcontroller.cpp. References maxTempFileName.

void OmgClimateDataProcessorController::setMeanPrecipFileName (  QString  theFileName  )

Mutator for filename of the mean precipitation calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 276 of file omgclimatedataprocessorcontroller.cpp. References meanPrecipFileName.

void OmgClimateDataProcessorController::setMeanTempFileName (  QString  theFileName  )

Mutator for filename of the meanTemp calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 232 of file omgclimatedataprocessorcontroller.cpp. References meanTempFileName.

void OmgClimateDataProcessorController::setMinTempFileName (  QString  theFileName  )

Mutator for filename of the minTemp calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 243 of file omgclimatedataprocessorcontroller.cpp. References minTempFileName.

void OmgClimateDataProcessorController::setOutputFilePathString (  QString  theFilePathString  )

Mutator for directory name for the calculation output files. Parameters: theFilePathString  - The name of an existing directory where the output files will be stored. Returns: void - No return. Definition at line 323 of file omgclimatedataprocessorcontroller.cpp. References outputFilePath.

void OmgClimateDataProcessorController::setOutputFileType (  const QString  theOutputFileTypeString  )

Mutator for OmgFileWriter::FileType outputFileType. Overloaded version of above that takes a string and looks up the enum. Parameters: theOutputFileTypeString  - a QString containing the desired output file type. Valid options include: CSM for Matlab CSM for Octave Desktop GARP ESRI ASCII Grid Plain matrix with no header Returns: void - No return Definition at line 559 of file omgclimatedataprocessorcontroller.cpp. References makeOutputFileTypeMap(), outputFileTypeMap, and setOutputFileType().

Here is the call graph for this function:

void OmgClimateDataProcessorController::setOutputFileType (  const OmgFileWriter::FileType  theOutputFileType  )

Mutator for OmgFileWriter::FileType outputFileType. This will determine how outputs from calculations will be written to disk. Parameters: theOutputFileType  - a OmgFileWriter::FileType value Returns: void - No return Definition at line 553 of file omgclimatedataprocessorcontroller.cpp. References outputFileType. Referenced by setOutputFileType().

void OmgClimateDataProcessorController::setOutputHeader (  const QString &  theOutputHeader  )

If the output format requires a header (e.g. Arc/Info ASCII grid, you can define one using this method. Parameters: theOutputHeader  - a QString containing the new header. Returns: void - No return. Definition at line 63 of file omgclimatedataprocessorcontroller.cpp. References outputHeader.

void OmgClimateDataProcessorController::setTotalSolarRadFileName (  QString  theFileName  )

Mutator for filename of the solar radiation calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 300 of file omgclimatedataprocessorcontroller.cpp. References totalSolarRadFileName.

void OmgClimateDataProcessorController::setWindSpeedFileName (  QString  theFileName  )

Mutator for filename of the wind speed calculation inputs. If the files are in series, the name should be of the first file in the series. Parameters: theFileName  - The new filename for the calculation inputs. Returns: void - No return. Definition at line 312 of file omgclimatedataprocessorcontroller.cpp. References windSpeedFileName.

void OmgClimateDataProcessorController::variableDone (  QString  theFileName  )  [signal]

A signal emitted to notify listeners that we completed calculating the given variable. * Parameters: theFileName  - the filename that the variable was outputted to * Returns: void - No return Referenced by run().

void OmgClimateDataProcessorController::variableStart (  QString  theName  )  [signal]

A signal emitted to notify listeners that we are about to start calculating a variable for one years data. * Parameters: theName  - A String containing the variable name e.g. 'Precipitation over coolest month' * Returns: void - No return Referenced by run().

---

Member Data Documentation

QMap<QString, bool > OmgClimateDataProcessorController::availableCalculationsMap [private]

This is a map (associative array) that stores which calculations can be performed given the input files that have been registered with this climatedataprocessor. The boolean flag will be used to indicate whether the user actually wants to perform the calculation on the input dataset(s). See also: makeAvailableCalculationsMap addUserCalculation Definition at line 469 of file omgclimatedataprocessorcontroller.h. Referenced by addUserCalculation(), getAvailableCalculationsMap(), getDescription(), makeAvailableCalculationsMap(), and run().

OmgClimateFileGroup* OmgClimateDataProcessorController::diurnalTempFileGroup [private]

A filegroup containing files with diurnal temperature data. Definition at line 494 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::diurnalTempFileName [private]

The file name that contains diurnal temp data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 498 of file omgclimatedataprocessorcontroller.h. Referenced by getDiurnalTempFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setDiurnalTempFileName().

bool OmgClimateDataProcessorController::filesInSeriesFlag [private]

For certain input types (notably cres, arcinfo and Reading paleoclimate), each months data is stored in a discrete file. Files should be numbered e.g. meantemp01.asc, meantemp2.asc...meantemp12.asc for each month. This flag lets us know whether data is in a series of seperate files for each month or can all be found in the same file. Definition at line 533 of file omgclimatedataprocessorcontroller.h. Referenced by getDescription(), getFilesInSeriesFlag(), initialiseFileGroup(), and setFilesInSeriesFlag().

OmgClimateFileGroup* OmgClimateDataProcessorController::frostDaysFileGroup [private]

A filegroup containing files with number of frost days data. Definition at line 508 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::frostDaysFileName [private]

The file name that contains mean frost data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 512 of file omgclimatedataprocessorcontroller.h. Referenced by getFrostDaysFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setFrostDaysFileName().

OmgClimateFileReader::FileType OmgClimateDataProcessorController::inputFileType [private]

The type of input files to be processed by the climate date processor. Definition at line 437 of file omgclimatedataprocessorcontroller.h. Referenced by getInputFileType(), initialiseFileGroup(), OmgClimateDataProcessorController(), and setInputFileType().

QMap<QString,OmgClimateFileReader::FileType > OmgClimateDataProcessorController::inputFileTypeMap [private]

This is a map (associative array) that stores the key/value pairs for the INPUT filetype. The key is the verbose name for the file type (as will typically appear in the user interface, and the value is theOmgClimateFileReader::FileType equivalent. See also: makeInputFileTypeMap() makeOutputFileTypeMap() Definition at line 449 of file omgclimatedataprocessorcontroller.h. Referenced by makeInputFileTypeMap(), and setInputFileType().

OmgClimateFileGroup* OmgClimateDataProcessorController::maxTempFileGroup [private]

A filegroup containing files with maximum temperature data. Definition at line 487 of file omgclimatedataprocessorcontroller.h. Referenced by makeAvailableCalculationsMap(), makeFileGroups(), and run().

QString OmgClimateDataProcessorController::maxTempFileName [private]

The file name that contains max temp data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 491 of file omgclimatedataprocessorcontroller.h. Referenced by getMaxTempFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setMaxTempFileName().

OmgClimateFileGroup* OmgClimateDataProcessorController::meanPrecipFileGroup [private]

A filegroup containing files with mean precipitation data. Definition at line 501 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::meanPrecipFileName [private]

The file name that contains mean precipitation data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 505 of file omgclimatedataprocessorcontroller.h. Referenced by getMeanPrecipFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setMeanPrecipFileName().

OmgClimateFileGroup* OmgClimateDataProcessorController::meanTempFileGroup [private]

A filegroup containing files with mean temperature data. Definition at line 473 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::meanTempFileName [private]

The file name that contains mean temp data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 477 of file omgclimatedataprocessorcontroller.h. Referenced by getMeanTempFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setMeanTempFileName().

OmgClimateFileGroup* OmgClimateDataProcessorController::minTempFileGroup [private]

A filegroup containing files with minimum temperature data. Definition at line 480 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::minTempFileName [private]

The file name that contains min temp data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 484 of file omgclimatedataprocessorcontroller.h. Referenced by getMinTempFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setMinTempFileName().

QString OmgClimateDataProcessorController::outputFilePath [private]

The directory where the processed results will be stored. Definition at line 435 of file omgclimatedataprocessorcontroller.h. Referenced by getOutputFilePathString(), OmgClimateDataProcessorController(), run(), and setOutputFilePathString().

OmgFileWriter::FileType OmgClimateDataProcessorController::outputFileType [private]

The type of output files to be produced by the climate date processor. Definition at line 440 of file omgclimatedataprocessorcontroller.h. Referenced by getOutputFileType(), run(), and setOutputFileType().

QMap<QString, OmgFileWriter::FileType > OmgClimateDataProcessorController::outputFileTypeMap [private]

This is a map (associative array) that stores the key/value pairs for the OUTPUT filetype. The key is the verbose name for the file type (as will typically appear in the user interface, and the value is the OmgFileWriter::FileType equivalent. See also: makeInputFileTypeMap() makeOutputFileTypeMap() Definition at line 459 of file omgclimatedataprocessorcontroller.h. Referenced by makeOutputFileTypeMap(), and setOutputFileType().

QString OmgClimateDataProcessorController::outputHeader [private]

This is a standard header (e.g. arc/info header) that will be appended to any output grids. Definition at line 536 of file omgclimatedataprocessorcontroller.h. Referenced by getOutputHeader(), run(), and setOutputHeader().

OmgClimateFileGroup* OmgClimateDataProcessorController::totalSolarRadFileGroup [private]

A filegroup containing files with solar radiation data. Definition at line 515 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::totalSolarRadFileName [private]

The file name that contains mean solar radiation data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 519 of file omgclimatedataprocessorcontroller.h. Referenced by getTotalSolarRadFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setTotalSolarRadFileName().

OmgClimateFileGroup* OmgClimateDataProcessorController::windSpeedFileGroup [private]

A filegroup containing files with wind speed data. Definition at line 522 of file omgclimatedataprocessorcontroller.h. Referenced by makeFileGroups(), and run().

QString OmgClimateDataProcessorController::windSpeedFileName [private]

The file name that contains wind speed data. If the file type is one where the data is stored in series (a single file per month), this member will store the name of the first file in the series. Definition at line 526 of file omgclimatedataprocessorcontroller.h. Referenced by getWindSpeedFileName(), makeAvailableCalculationsMap(), makeFileGroups(), OmgClimateDataProcessorController(), run(), and setWindSpeedFileName().

---

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

• lib/omgclimatedataprocessorcontroller.h
• lib/omgclimatedataprocessorcontroller.cpp

---