CropPrecipitation Class Reference

Auxiliary class. More...

#include <CropActualPrecipitation.h>

Collaboration diagram for CropPrecipitation:

[legend]List of all members.

Public Member Functions
Data query functions
virtual double	getActualPrecipitationByYear (int year_, int month_, int catchment_, int sector_)
virtual double	getActualPrecipitationByIndex (int year_, int month_, int catchment_, int sector_)
virtual int	getIndexForAbsoluteYear (int year)
virtual void	printValue (int year_, int month_, int catchment_, int sector_)
virtual void	printValueByIndex (int yearIndex, int month_, int catchment_, int sector_)
virtual double	getAveragePrecipitationInMonth (int month_, int catchment_, int sector_)
Print, write and read functions
virtual void	printToScreen ()
virtual void	writeToFile (string fn, int catchID)
virtual void	writeToFile (char *filename, int catchID)
virtual void	readHeader (FILE *strm)
virtual void	readPrecipitationDataIntoMatrix (FILE *strm, MatrixDouble &matrixPassedByRef, int numYR_, int secID, enumPrecipType precipType)
virtual void	readFromFile (char *filename, int catchID)
Constructors and destructor
	CropPrecipitation ()
	CropPrecipitation (int numCatchments_, int numSectors_, int numberOfYears_, int numTimeSteps_)
	CropPrecipitation (CropPrecipitation &orig)
virtual CropPrecipitation &	operator= (CropPrecipitation &)
virtual	~CropPrecipitation ()
Protected Member Functions
virtual int	getNumberOfYears ()
virtual int	getNumTimeStepsPerYear ()
virtual int	getNumCatchments ()
virtual int	getNumSectors ()
virtual int	getRealYear (int yInd)
virtual typeInputDataActualPrecipitation	getInputType ()
virtual bool	getIsDataPerSector ()
virtual void	allocate ()
virtual void	allocate (int numCatchments_, int numSectors_, int numberOfYears_, int numTimeSteps_)
virtual void	allocate (CropPrecipitation &orig)
virtual void	deallocate ()
virtual void	copy (CropPrecipitation &orig)
Protected Attributes
int	numberOfYears
int	numTimeSteps
int	numCatchments
int	numSectors
typeInputDataActualPrecipitation	inputType
bool	isDataPerSector
MatrixDouble	translationMatrix_YearToIndex
	Water demands per crop-water activity (without effective rainfall).
MatrixDouble **	actualPrecipitation
	Pointer to actual precipitation (data structure at regional level).
MatrixDouble **	averagePrecipitation
	Pointer to average precipitation (data structure at regional level).

---

Detailed Description

Auxiliary class.

---

Constructor & Destructor Documentation

CropPrecipitation::CropPrecipitation (   )  [inline]

CropPrecipitation::CropPrecipitation (  int  numCatchments_, int  numSectors_, int  numberOfYears_, int  numTimeSteps_ )  [inline]

CropPrecipitation::CropPrecipitation (  CropPrecipitation &  orig  )  [inline]

virtual CropPrecipitation::~CropPrecipitation (   )  [virtual]

---

Member Function Documentation

virtual void CropPrecipitation::allocate (  CropPrecipitation &  orig  )  [protected, virtual]

virtual void CropPrecipitation::allocate (  int  numCatchments_, int  numSectors_, int  numberOfYears_, int  numTimeSteps_ )  [protected, virtual]

virtual void CropPrecipitation::allocate (   )  [protected, virtual]

virtual void CropPrecipitation::copy (  CropPrecipitation &  orig  )  [protected, virtual]

virtual void CropPrecipitation::deallocate (   )  [protected, virtual]

virtual double CropPrecipitation::getActualPrecipitationByIndex (  int  year_, int  month_, int  catchment_, int  sector_ )  [virtual]

virtual double CropPrecipitation::getActualPrecipitationByYear (  int  year_, int  month_, int  catchment_, int  sector_ )  [virtual]

virtual double CropPrecipitation::getAveragePrecipitationInMonth (  int  month_, int  catchment_, int  sector_ )  [virtual]

virtual int CropPrecipitation::getIndexForAbsoluteYear (  int  year  )  [virtual]

virtual typeInputDataActualPrecipitation CropPrecipitation::getInputType (   )  [inline, protected, virtual]

virtual bool CropPrecipitation::getIsDataPerSector (   )  [inline, protected, virtual]

virtual int CropPrecipitation::getNumberOfYears (   )  [inline, protected, virtual]

virtual int CropPrecipitation::getNumCatchments (   )  [inline, protected, virtual]

virtual int CropPrecipitation::getNumSectors (   )  [inline, protected, virtual]

virtual int CropPrecipitation::getNumTimeStepsPerYear (   )  [inline, protected, virtual]

virtual int CropPrecipitation::getRealYear (  int  yInd  )  [inline, protected, virtual]

virtual CropPrecipitation& CropPrecipitation::operator= (  CropPrecipitation &   )  [virtual]

virtual void CropPrecipitation::printToScreen (   )  [virtual]

virtual void CropPrecipitation::printValue (  int  year_, int  month_, int  catchment_, int  sector_ )  [virtual]

virtual void CropPrecipitation::printValueByIndex (  int  yearIndex, int  month_, int  catchment_, int  sector_ )  [virtual]

virtual void CropPrecipitation::readFromFile (  char *  filename, int  catchID )  [virtual]

virtual void CropPrecipitation::readHeader (  FILE *  strm  )  [virtual]

virtual void CropPrecipitation::readPrecipitationDataIntoMatrix (  FILE *  strm, MatrixDouble &  matrixPassedByRef, int  numYR_, int  secID, enumPrecipType  precipType )  [virtual]

virtual void CropPrecipitation::writeToFile (  char *  filename, int  catchID )  [virtual]

virtual void CropPrecipitation::writeToFile (  string  fn, int  catchID )  [virtual]

---

Member Data Documentation

MatrixDouble** CropPrecipitation::actualPrecipitation [protected]

Pointer to actual precipitation (data structure at regional level).

MatrixDouble** CropPrecipitation::averagePrecipitation [protected]

Pointer to average precipitation (data structure at regional level).

typeInputDataActualPrecipitation CropPrecipitation::inputType [protected]

bool CropPrecipitation::isDataPerSector [protected]

int CropPrecipitation::numberOfYears [protected]

int CropPrecipitation::numCatchments [protected]

int CropPrecipitation::numSectors [protected]

int CropPrecipitation::numTimeSteps [protected]

MatrixDouble CropPrecipitation::translationMatrix_YearToIndex [protected]

Water demands per crop-water activity (without effective rainfall).

---

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

• CropActualPrecipitation.h

---